armnetwork

package module
v0.3.1 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2022 License: MIT Imports: 15 Imported by: 68

README

Azure Network Module for Go

PkgGoDev

The armnetwork module provides operations for working with Azure Network.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Network module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Network. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Network modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armnetwork.NewVirtualHubBgpConnectionsClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armnetwork.NewVirtualHubBgpConnectionsClient(<subscription ID>, cred, &options)

More sample code

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Network label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AADAuthenticationParameters 

type AADAuthenticationParameters struct {
	// AAD Vpn authentication parameter AAD audience.
	AADAudience *string `json:"aadAudience,omitempty"`

	// AAD Vpn authentication parameter AAD issuer.
	AADIssuer *string `json:"aadIssuer,omitempty"`

	// AAD Vpn authentication parameter AAD tenant.
	AADTenant *string `json:"aadTenant,omitempty"`
}

AADAuthenticationParameters - AAD Vpn authentication type related parameters.

type Access 

type Access string

Access - Access to be allowed or denied. 

const (
	AccessAllow Access = "Allow"
	AccessDeny  Access = "Deny"
)

func PossibleAccessValues 

func PossibleAccessValues() []Access

PossibleAccessValues returns the possible values for the Access const type.

func (Access) ToPtr 

func (c Access) ToPtr() *Access

ToPtr returns a *Access pointing to the current value.

type AddressSpace 

type AddressSpace struct {
	// A list of address blocks reserved for this virtual network in CIDR notation.
	AddressPrefixes []*string `json:"addressPrefixes,omitempty"`
}

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

func (AddressSpace) MarshalJSON 

func (a AddressSpace) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AddressSpace.

type ApplicationGateway 

type ApplicationGateway struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The identity of the application gateway, if configured.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the application gateway.
	Properties *ApplicationGatewayPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// A list of availability zones denoting where the resource needs to come from.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGateway - Application gateway resource.

func (ApplicationGateway) MarshalJSON 

func (a ApplicationGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGateway.

type ApplicationGatewayAuthenticationCertificate 

type ApplicationGatewayAuthenticationCertificate struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the authentication certificate that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway authentication certificate.
	Properties *ApplicationGatewayAuthenticationCertificatePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayAuthenticationCertificate - Authentication certificates of an application gateway.

type ApplicationGatewayAuthenticationCertificatePropertiesFormat 

type ApplicationGatewayAuthenticationCertificatePropertiesFormat struct {
	// Certificate public data.
	Data *string `json:"data,omitempty"`

	// READ-ONLY; The provisioning state of the authentication certificate resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayAuthenticationCertificatePropertiesFormat - Authentication certificates properties of an application gateway.

type ApplicationGatewayAutoscaleConfiguration 

type ApplicationGatewayAutoscaleConfiguration struct {
	// REQUIRED; Lower bound on number of Application Gateway capacity.
	MinCapacity *int32 `json:"minCapacity,omitempty"`

	// Upper bound on number of Application Gateway capacity.
	MaxCapacity *int32 `json:"maxCapacity,omitempty"`
}

ApplicationGatewayAutoscaleConfiguration - Application Gateway autoscale configuration.

type ApplicationGatewayAvailableSSLOptions 

type ApplicationGatewayAvailableSSLOptions struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the application gateway available SSL options.
	Properties *ApplicationGatewayAvailableSSLOptionsPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayAvailableSSLOptions - Response for ApplicationGatewayAvailableSslOptions API service call.

func (ApplicationGatewayAvailableSSLOptions) MarshalJSON 

func (a ApplicationGatewayAvailableSSLOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayAvailableSSLOptions.

type ApplicationGatewayAvailableSSLOptionsPropertiesFormat 

type ApplicationGatewayAvailableSSLOptionsPropertiesFormat struct {
	// List of available Ssl cipher suites.
	AvailableCipherSuites []*ApplicationGatewaySSLCipherSuite `json:"availableCipherSuites,omitempty"`

	// List of available Ssl protocols.
	AvailableProtocols []*ApplicationGatewaySSLProtocol `json:"availableProtocols,omitempty"`

	// Name of the Ssl predefined policy applied by default to application gateway.
	DefaultPolicy *ApplicationGatewaySSLPolicyName `json:"defaultPolicy,omitempty"`

	// List of available Ssl predefined policy.
	PredefinedPolicies []*SubResource `json:"predefinedPolicies,omitempty"`
}

ApplicationGatewayAvailableSSLOptionsPropertiesFormat - Properties of ApplicationGatewayAvailableSslOptions.

func (ApplicationGatewayAvailableSSLOptionsPropertiesFormat) MarshalJSON 

func (a ApplicationGatewayAvailableSSLOptionsPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayAvailableSSLOptionsPropertiesFormat.

type ApplicationGatewayAvailableSSLPredefinedPolicies 

type ApplicationGatewayAvailableSSLPredefinedPolicies struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of available Ssl predefined policy.
	Value []*ApplicationGatewaySSLPredefinedPolicy `json:"value,omitempty"`
}

ApplicationGatewayAvailableSSLPredefinedPolicies - Response for ApplicationGatewayAvailableSslOptions API service call.

func (ApplicationGatewayAvailableSSLPredefinedPolicies) MarshalJSON 

func (a ApplicationGatewayAvailableSSLPredefinedPolicies) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayAvailableSSLPredefinedPolicies.

type ApplicationGatewayAvailableWafRuleSetsResult 

type ApplicationGatewayAvailableWafRuleSetsResult struct {
	// The list of application gateway rule sets.
	Value []*ApplicationGatewayFirewallRuleSet `json:"value,omitempty"`
}

ApplicationGatewayAvailableWafRuleSetsResult - Response for ApplicationGatewayAvailableWafRuleSets API service call.

func (ApplicationGatewayAvailableWafRuleSetsResult) MarshalJSON 

func (a ApplicationGatewayAvailableWafRuleSetsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayAvailableWafRuleSetsResult.

type ApplicationGatewayBackendAddress 

type ApplicationGatewayBackendAddress struct {
	// Fully qualified domain name (FQDN).
	Fqdn *string `json:"fqdn,omitempty"`

	// IP address.
	IPAddress *string `json:"ipAddress,omitempty"`
}

ApplicationGatewayBackendAddress - Backend address of an application gateway.

type ApplicationGatewayBackendAddressPool 

type ApplicationGatewayBackendAddressPool struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the backend address pool that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway backend address pool.
	Properties *ApplicationGatewayBackendAddressPoolPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayBackendAddressPool - Backend Address Pool of an application gateway.

type ApplicationGatewayBackendAddressPoolPropertiesFormat 

type ApplicationGatewayBackendAddressPoolPropertiesFormat struct {
	// Backend addresses.
	BackendAddresses []*ApplicationGatewayBackendAddress `json:"backendAddresses,omitempty"`

	// READ-ONLY; Collection of references to IPs defined in network interfaces.
	BackendIPConfigurations []*InterfaceIPConfiguration `json:"backendIPConfigurations,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the backend address pool resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayBackendAddressPoolPropertiesFormat - Properties of Backend Address Pool of an application gateway.

func (ApplicationGatewayBackendAddressPoolPropertiesFormat) MarshalJSON 

func (a ApplicationGatewayBackendAddressPoolPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendAddressPoolPropertiesFormat.

type ApplicationGatewayBackendHTTPSettings 

type ApplicationGatewayBackendHTTPSettings struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the backend http settings that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway backend HTTP settings.
	Properties *ApplicationGatewayBackendHTTPSettingsPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayBackendHTTPSettings - Backend address pool settings of an application gateway.

type ApplicationGatewayBackendHTTPSettingsPropertiesFormat 

type ApplicationGatewayBackendHTTPSettingsPropertiesFormat struct {
	// Cookie name to use for the affinity cookie.
	AffinityCookieName *string `json:"affinityCookieName,omitempty"`

	// Array of references to application gateway authentication certificates.
	AuthenticationCertificates []*SubResource `json:"authenticationCertificates,omitempty"`

	// Connection draining of the backend http settings resource.
	ConnectionDraining *ApplicationGatewayConnectionDraining `json:"connectionDraining,omitempty"`

	// Cookie based affinity.
	CookieBasedAffinity *ApplicationGatewayCookieBasedAffinity `json:"cookieBasedAffinity,omitempty"`

	// Host header to be sent to the backend servers.
	HostName *string `json:"hostName,omitempty"`

	// Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.
	Path *string `json:"path,omitempty"`

	// Whether to pick host header should be picked from the host name of the backend server. Default value is false.
	PickHostNameFromBackendAddress *bool `json:"pickHostNameFromBackendAddress,omitempty"`

	// The destination port on the backend.
	Port *int32 `json:"port,omitempty"`

	// Probe resource of an application gateway.
	Probe *SubResource `json:"probe,omitempty"`

	// Whether the probe is enabled. Default value is false.
	ProbeEnabled *bool `json:"probeEnabled,omitempty"`

	// The protocol used to communicate with the backend.
	Protocol *ApplicationGatewayProtocol `json:"protocol,omitempty"`

	// 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"`

	// Array of references to application gateway trusted root certificates.
	TrustedRootCertificates []*SubResource `json:"trustedRootCertificates,omitempty"`

	// READ-ONLY; The provisioning state of the backend HTTP settings resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayBackendHTTPSettingsPropertiesFormat - Properties of Backend address pool settings of an application gateway.

func (ApplicationGatewayBackendHTTPSettingsPropertiesFormat) MarshalJSON 

func (a ApplicationGatewayBackendHTTPSettingsPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendHTTPSettingsPropertiesFormat.

type ApplicationGatewayBackendHealth 

type ApplicationGatewayBackendHealth struct {
	// A list of ApplicationGatewayBackendHealthPool resources.
	BackendAddressPools []*ApplicationGatewayBackendHealthPool `json:"backendAddressPools,omitempty"`
}

ApplicationGatewayBackendHealth - Response for ApplicationGatewayBackendHealth API service call.

func (ApplicationGatewayBackendHealth) MarshalJSON 

func (a ApplicationGatewayBackendHealth) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendHealth.

type ApplicationGatewayBackendHealthHTTPSettings 

type ApplicationGatewayBackendHealthHTTPSettings struct {
	// Reference to an ApplicationGatewayBackendHttpSettings resource.
	BackendHTTPSettings *ApplicationGatewayBackendHTTPSettings `json:"backendHttpSettings,omitempty"`

	// List of ApplicationGatewayBackendHealthServer resources.
	Servers []*ApplicationGatewayBackendHealthServer `json:"servers,omitempty"`
}

ApplicationGatewayBackendHealthHTTPSettings - Application gateway BackendHealthHttp settings.

func (ApplicationGatewayBackendHealthHTTPSettings) MarshalJSON 

func (a ApplicationGatewayBackendHealthHTTPSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendHealthHTTPSettings.

type ApplicationGatewayBackendHealthOnDemand 

type ApplicationGatewayBackendHealthOnDemand struct {
	// Reference to an ApplicationGatewayBackendAddressPool resource.
	BackendAddressPool *ApplicationGatewayBackendAddressPool `json:"backendAddressPool,omitempty"`

	// Application gateway BackendHealthHttp settings.
	BackendHealthHTTPSettings *ApplicationGatewayBackendHealthHTTPSettings `json:"backendHealthHttpSettings,omitempty"`
}

ApplicationGatewayBackendHealthOnDemand - Result of on demand test probe.

type ApplicationGatewayBackendHealthPool 

type ApplicationGatewayBackendHealthPool struct {
	// Reference to an ApplicationGatewayBackendAddressPool resource.
	BackendAddressPool *ApplicationGatewayBackendAddressPool `json:"backendAddressPool,omitempty"`

	// List of ApplicationGatewayBackendHealthHttpSettings resources.
	BackendHTTPSettingsCollection []*ApplicationGatewayBackendHealthHTTPSettings `json:"backendHttpSettingsCollection,omitempty"`
}

ApplicationGatewayBackendHealthPool - Application gateway BackendHealth pool.

func (ApplicationGatewayBackendHealthPool) MarshalJSON 

func (a ApplicationGatewayBackendHealthPool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendHealthPool.

type ApplicationGatewayBackendHealthServer 

type ApplicationGatewayBackendHealthServer struct {
	// IP address or FQDN of backend server.
	Address *string `json:"address,omitempty"`

	// Health of backend server.
	Health *ApplicationGatewayBackendHealthServerHealth `json:"health,omitempty"`

	// Health Probe Log.
	HealthProbeLog *string `json:"healthProbeLog,omitempty"`

	// Reference to IP configuration of backend server.
	IPConfiguration *InterfaceIPConfiguration `json:"ipConfiguration,omitempty"`
}

ApplicationGatewayBackendHealthServer - Application gateway backendhealth http settings.

type ApplicationGatewayBackendHealthServerHealth 

type ApplicationGatewayBackendHealthServerHealth string

ApplicationGatewayBackendHealthServerHealth - Health of backend server. 

const (
	ApplicationGatewayBackendHealthServerHealthDown     ApplicationGatewayBackendHealthServerHealth = "Down"
	ApplicationGatewayBackendHealthServerHealthDraining ApplicationGatewayBackendHealthServerHealth = "Draining"
	ApplicationGatewayBackendHealthServerHealthPartial  ApplicationGatewayBackendHealthServerHealth = "Partial"
	ApplicationGatewayBackendHealthServerHealthUnknown  ApplicationGatewayBackendHealthServerHealth = "Unknown"
	ApplicationGatewayBackendHealthServerHealthUp       ApplicationGatewayBackendHealthServerHealth = "Up"
)

func PossibleApplicationGatewayBackendHealthServerHealthValues 

func PossibleApplicationGatewayBackendHealthServerHealthValues() []ApplicationGatewayBackendHealthServerHealth

PossibleApplicationGatewayBackendHealthServerHealthValues returns the possible values for the ApplicationGatewayBackendHealthServerHealth const type.

func (ApplicationGatewayBackendHealthServerHealth) ToPtr 

func (c ApplicationGatewayBackendHealthServerHealth) ToPtr() *ApplicationGatewayBackendHealthServerHealth

ToPtr returns a *ApplicationGatewayBackendHealthServerHealth pointing to the current value.

type ApplicationGatewayClientAuthConfiguration 

type ApplicationGatewayClientAuthConfiguration struct {
	// Verify client certificate issuer name on the application gateway.
	VerifyClientCertIssuerDN *bool `json:"verifyClientCertIssuerDN,omitempty"`
}

ApplicationGatewayClientAuthConfiguration - Application gateway client authentication configuration.

type ApplicationGatewayConnectionDraining 

type ApplicationGatewayConnectionDraining struct {
	// REQUIRED; The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.
	DrainTimeoutInSec *int32 `json:"drainTimeoutInSec,omitempty"`

	// REQUIRED; Whether connection draining is enabled or not.
	Enabled *bool `json:"enabled,omitempty"`
}

ApplicationGatewayConnectionDraining - Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.

type ApplicationGatewayCookieBasedAffinity 

type ApplicationGatewayCookieBasedAffinity string

ApplicationGatewayCookieBasedAffinity - Cookie based affinity. 

const (
	ApplicationGatewayCookieBasedAffinityDisabled ApplicationGatewayCookieBasedAffinity = "Disabled"
	ApplicationGatewayCookieBasedAffinityEnabled  ApplicationGatewayCookieBasedAffinity = "Enabled"
)

func PossibleApplicationGatewayCookieBasedAffinityValues 

func PossibleApplicationGatewayCookieBasedAffinityValues() []ApplicationGatewayCookieBasedAffinity

PossibleApplicationGatewayCookieBasedAffinityValues returns the possible values for the ApplicationGatewayCookieBasedAffinity const type.

func (ApplicationGatewayCookieBasedAffinity) ToPtr 

func (c ApplicationGatewayCookieBasedAffinity) ToPtr() *ApplicationGatewayCookieBasedAffinity

ToPtr returns a *ApplicationGatewayCookieBasedAffinity pointing to the current value.

type ApplicationGatewayCustomError 

type ApplicationGatewayCustomError struct {
	// Error page URL of the application gateway customer error.
	CustomErrorPageURL *string `json:"customErrorPageUrl,omitempty"`

	// Status code of the application gateway customer error.
	StatusCode *ApplicationGatewayCustomErrorStatusCode `json:"statusCode,omitempty"`
}

ApplicationGatewayCustomError - Customer error of an application gateway.

type ApplicationGatewayCustomErrorStatusCode 

type ApplicationGatewayCustomErrorStatusCode string

ApplicationGatewayCustomErrorStatusCode - Status code of the application gateway customer error. 

const (
	ApplicationGatewayCustomErrorStatusCodeHTTPStatus403 ApplicationGatewayCustomErrorStatusCode = "HttpStatus403"
	ApplicationGatewayCustomErrorStatusCodeHTTPStatus502 ApplicationGatewayCustomErrorStatusCode = "HttpStatus502"
)

func PossibleApplicationGatewayCustomErrorStatusCodeValues 

func PossibleApplicationGatewayCustomErrorStatusCodeValues() []ApplicationGatewayCustomErrorStatusCode

PossibleApplicationGatewayCustomErrorStatusCodeValues returns the possible values for the ApplicationGatewayCustomErrorStatusCode const type.

func (ApplicationGatewayCustomErrorStatusCode) ToPtr 

func (c ApplicationGatewayCustomErrorStatusCode) ToPtr() *ApplicationGatewayCustomErrorStatusCode

ToPtr returns a *ApplicationGatewayCustomErrorStatusCode pointing to the current value.

type ApplicationGatewayFirewallDisabledRuleGroup 

type ApplicationGatewayFirewallDisabledRuleGroup struct {
	// REQUIRED; The name of the rule group that will be disabled.
	RuleGroupName *string `json:"ruleGroupName,omitempty"`

	// The list of rules that will be disabled. If null, all rules of the rule group will be disabled.
	Rules []*int32 `json:"rules,omitempty"`
}

ApplicationGatewayFirewallDisabledRuleGroup - Allows to disable rules within a rule group or an entire rule group.

func (ApplicationGatewayFirewallDisabledRuleGroup) MarshalJSON 

func (a ApplicationGatewayFirewallDisabledRuleGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFirewallDisabledRuleGroup.

type ApplicationGatewayFirewallExclusion 

type ApplicationGatewayFirewallExclusion struct {
	// REQUIRED; The variable to be excluded.
	MatchVariable *string `json:"matchVariable,omitempty"`

	// REQUIRED; When matchVariable is a collection, operator used to specify which elements in the collection this exclusion
	// applies to.
	Selector *string `json:"selector,omitempty"`

	// REQUIRED; When matchVariable is a collection, operate on the selector to specify which elements in the collection this
	// exclusion applies to.
	SelectorMatchOperator *string `json:"selectorMatchOperator,omitempty"`
}

ApplicationGatewayFirewallExclusion - Allow to exclude some variable satisfy the condition for the WAF check.

type ApplicationGatewayFirewallMode 

type ApplicationGatewayFirewallMode string

ApplicationGatewayFirewallMode - Web application firewall mode. 

const (
	ApplicationGatewayFirewallModeDetection  ApplicationGatewayFirewallMode = "Detection"
	ApplicationGatewayFirewallModePrevention ApplicationGatewayFirewallMode = "Prevention"
)

func PossibleApplicationGatewayFirewallModeValues 

func PossibleApplicationGatewayFirewallModeValues() []ApplicationGatewayFirewallMode

PossibleApplicationGatewayFirewallModeValues returns the possible values for the ApplicationGatewayFirewallMode const type.

func (ApplicationGatewayFirewallMode) ToPtr 

func (c ApplicationGatewayFirewallMode) ToPtr() *ApplicationGatewayFirewallMode

ToPtr returns a *ApplicationGatewayFirewallMode pointing to the current value.

type ApplicationGatewayFirewallRule 

type ApplicationGatewayFirewallRule struct {
	// REQUIRED; The identifier of the web application firewall rule.
	RuleID *int32 `json:"ruleId,omitempty"`

	// The description of the web application firewall rule.
	Description *string `json:"description,omitempty"`
}

ApplicationGatewayFirewallRule - A web application firewall rule.

type ApplicationGatewayFirewallRuleGroup 

type ApplicationGatewayFirewallRuleGroup struct {
	// REQUIRED; The name of the web application firewall rule group.
	RuleGroupName *string `json:"ruleGroupName,omitempty"`

	// REQUIRED; The rules of the web application firewall rule group.
	Rules []*ApplicationGatewayFirewallRule `json:"rules,omitempty"`

	// The description of the web application firewall rule group.
	Description *string `json:"description,omitempty"`
}

ApplicationGatewayFirewallRuleGroup - A web application firewall rule group.

func (ApplicationGatewayFirewallRuleGroup) MarshalJSON 

func (a ApplicationGatewayFirewallRuleGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFirewallRuleGroup.

type ApplicationGatewayFirewallRuleSet 

type ApplicationGatewayFirewallRuleSet struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the application gateway firewall rule set.
	Properties *ApplicationGatewayFirewallRuleSetPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayFirewallRuleSet - A web application firewall rule set.

func (ApplicationGatewayFirewallRuleSet) MarshalJSON 

func (a ApplicationGatewayFirewallRuleSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFirewallRuleSet.

type ApplicationGatewayFirewallRuleSetPropertiesFormat 

type ApplicationGatewayFirewallRuleSetPropertiesFormat struct {
	// REQUIRED; The rule groups of the web application firewall rule set.
	RuleGroups []*ApplicationGatewayFirewallRuleGroup `json:"ruleGroups,omitempty"`

	// REQUIRED; The type of the web application firewall rule set.
	RuleSetType *string `json:"ruleSetType,omitempty"`

	// REQUIRED; The version of the web application firewall rule set type.
	RuleSetVersion *string `json:"ruleSetVersion,omitempty"`

	// READ-ONLY; The provisioning state of the web application firewall rule set.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayFirewallRuleSetPropertiesFormat - Properties of the web application firewall rule set.

func (ApplicationGatewayFirewallRuleSetPropertiesFormat) MarshalJSON 

func (a ApplicationGatewayFirewallRuleSetPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFirewallRuleSetPropertiesFormat.

type ApplicationGatewayFrontendIPConfiguration 

type ApplicationGatewayFrontendIPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the frontend IP configuration that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway frontend IP configuration.
	Properties *ApplicationGatewayFrontendIPConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayFrontendIPConfiguration - Frontend IP configuration of an application gateway.

type ApplicationGatewayFrontendIPConfigurationPropertiesFormat 

type ApplicationGatewayFrontendIPConfigurationPropertiesFormat struct {
	// PrivateIPAddress of the network interface IP Configuration.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// The private IP address allocation method.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// Reference to the application gateway private link configuration.
	PrivateLinkConfiguration *SubResource `json:"privateLinkConfiguration,omitempty"`

	// Reference to the PublicIP resource.
	PublicIPAddress *SubResource `json:"publicIPAddress,omitempty"`

	// Reference to the subnet resource.
	Subnet *SubResource `json:"subnet,omitempty"`

	// READ-ONLY; The provisioning state of the frontend IP configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayFrontendIPConfigurationPropertiesFormat - Properties of Frontend IP configuration of an application gateway.

type ApplicationGatewayFrontendPort 

type ApplicationGatewayFrontendPort struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the frontend port that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway frontend port.
	Properties *ApplicationGatewayFrontendPortPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayFrontendPort - Frontend port of an application gateway.

type ApplicationGatewayFrontendPortPropertiesFormat 

type ApplicationGatewayFrontendPortPropertiesFormat struct {
	// Frontend port.
	Port *int32 `json:"port,omitempty"`

	// READ-ONLY; The provisioning state of the frontend port resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayFrontendPortPropertiesFormat - Properties of Frontend port of an application gateway.

type ApplicationGatewayGlobalConfiguration 

type ApplicationGatewayGlobalConfiguration struct {
	// Enable request buffering.
	EnableRequestBuffering *bool `json:"enableRequestBuffering,omitempty"`

	// Enable response buffering.
	EnableResponseBuffering *bool `json:"enableResponseBuffering,omitempty"`
}

ApplicationGatewayGlobalConfiguration - Application Gateway global configuration.

type ApplicationGatewayHTTPListener 

type ApplicationGatewayHTTPListener struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the HTTP listener that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway HTTP listener.
	Properties *ApplicationGatewayHTTPListenerPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayHTTPListener - Http listener of an application gateway.

type ApplicationGatewayHTTPListenerPropertiesFormat 

type ApplicationGatewayHTTPListenerPropertiesFormat struct {
	// Custom error configurations of the HTTP listener.
	CustomErrorConfigurations []*ApplicationGatewayCustomError `json:"customErrorConfigurations,omitempty"`

	// Reference to the FirewallPolicy resource.
	FirewallPolicy *SubResource `json:"firewallPolicy,omitempty"`

	// Frontend IP configuration resource of an application gateway.
	FrontendIPConfiguration *SubResource `json:"frontendIPConfiguration,omitempty"`

	// Frontend port resource of an application gateway.
	FrontendPort *SubResource `json:"frontendPort,omitempty"`

	// Host name of HTTP listener.
	HostName *string `json:"hostName,omitempty"`

	// List of Host names for HTTP Listener that allows special wildcard characters as well.
	HostNames []*string `json:"hostNames,omitempty"`

	// Protocol of the HTTP listener.
	Protocol *ApplicationGatewayProtocol `json:"protocol,omitempty"`

	// Applicable only if protocol is https. Enables SNI for multi-hosting.
	RequireServerNameIndication *bool `json:"requireServerNameIndication,omitempty"`

	// SSL certificate resource of an application gateway.
	SSLCertificate *SubResource `json:"sslCertificate,omitempty"`

	// SSL profile resource of the application gateway.
	SSLProfile *SubResource `json:"sslProfile,omitempty"`

	// READ-ONLY; The provisioning state of the HTTP listener resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayHTTPListenerPropertiesFormat - Properties of HTTP listener of an application gateway.

func (ApplicationGatewayHTTPListenerPropertiesFormat) MarshalJSON 

func (a ApplicationGatewayHTTPListenerPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayHTTPListenerPropertiesFormat.

type ApplicationGatewayHeaderConfiguration 

type ApplicationGatewayHeaderConfiguration struct {
	// Header name of the header configuration.
	HeaderName *string `json:"headerName,omitempty"`

	// Header value of the header configuration.
	HeaderValue *string `json:"headerValue,omitempty"`
}

ApplicationGatewayHeaderConfiguration - Header configuration of the Actions set in Application Gateway.

type ApplicationGatewayIPConfiguration 

type ApplicationGatewayIPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the IP configuration that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway IP configuration.
	Properties *ApplicationGatewayIPConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayIPConfiguration - IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.

type ApplicationGatewayIPConfigurationPropertiesFormat 

type ApplicationGatewayIPConfigurationPropertiesFormat struct {
	// Reference to the subnet resource. A subnet from where application gateway gets its private address.
	Subnet *SubResource `json:"subnet,omitempty"`

	// READ-ONLY; The provisioning state of the application gateway IP configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayIPConfigurationPropertiesFormat - Properties of IP configuration of an application gateway.

type ApplicationGatewayListResult 

type ApplicationGatewayListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of an application gateways in a resource group.
	Value []*ApplicationGateway `json:"value,omitempty"`
}

ApplicationGatewayListResult - Response for ListApplicationGateways API service call.

func (ApplicationGatewayListResult) MarshalJSON 

func (a ApplicationGatewayListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayListResult.

type ApplicationGatewayLoadDistributionAlgorithm 

type ApplicationGatewayLoadDistributionAlgorithm string

ApplicationGatewayLoadDistributionAlgorithm - Load Distribution Algorithm enums. 

const (
	ApplicationGatewayLoadDistributionAlgorithmIPHash           ApplicationGatewayLoadDistributionAlgorithm = "IpHash"
	ApplicationGatewayLoadDistributionAlgorithmLeastConnections ApplicationGatewayLoadDistributionAlgorithm = "LeastConnections"
	ApplicationGatewayLoadDistributionAlgorithmRoundRobin       ApplicationGatewayLoadDistributionAlgorithm = "RoundRobin"
)

func PossibleApplicationGatewayLoadDistributionAlgorithmValues 

func PossibleApplicationGatewayLoadDistributionAlgorithmValues() []ApplicationGatewayLoadDistributionAlgorithm

PossibleApplicationGatewayLoadDistributionAlgorithmValues returns the possible values for the ApplicationGatewayLoadDistributionAlgorithm const type.

func (ApplicationGatewayLoadDistributionAlgorithm) ToPtr 

func (c ApplicationGatewayLoadDistributionAlgorithm) ToPtr() *ApplicationGatewayLoadDistributionAlgorithm

ToPtr returns a *ApplicationGatewayLoadDistributionAlgorithm pointing to the current value.

type ApplicationGatewayLoadDistributionPolicy 

type ApplicationGatewayLoadDistributionPolicy struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the load distribution policy that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway load distribution policy.
	Properties *ApplicationGatewayLoadDistributionPolicyPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayLoadDistributionPolicy - Load Distribution Policy of an application gateway.

type ApplicationGatewayLoadDistributionPolicyPropertiesFormat 

type ApplicationGatewayLoadDistributionPolicyPropertiesFormat struct {
	// Load Distribution Targets resource of an application gateway.
	LoadDistributionAlgorithm *ApplicationGatewayLoadDistributionAlgorithm `json:"loadDistributionAlgorithm,omitempty"`

	// Load Distribution Targets resource of an application gateway.
	LoadDistributionTargets []*ApplicationGatewayLoadDistributionTarget `json:"loadDistributionTargets,omitempty"`

	// READ-ONLY; The provisioning state of the Load Distribution Policy resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayLoadDistributionPolicyPropertiesFormat - Properties of Load Distribution Policy of an application gateway.

func (ApplicationGatewayLoadDistributionPolicyPropertiesFormat) MarshalJSON 

func (a ApplicationGatewayLoadDistributionPolicyPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayLoadDistributionPolicyPropertiesFormat.

type ApplicationGatewayLoadDistributionTarget 

type ApplicationGatewayLoadDistributionTarget struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the load distribution policy that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway load distribution target.
	Properties *ApplicationGatewayLoadDistributionTargetPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayLoadDistributionTarget - Load Distribution Target of an application gateway.

type ApplicationGatewayLoadDistributionTargetPropertiesFormat 

type ApplicationGatewayLoadDistributionTargetPropertiesFormat struct {
	// Backend address pool resource of the application gateway.
	BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`

	// Weight per server. Range between 1 and 100.
	WeightPerServer *int32 `json:"weightPerServer,omitempty"`
}

type ApplicationGatewayOnDemandProbe 

type ApplicationGatewayOnDemandProbe struct {
	// Reference to backend pool of application gateway to which probe request will be sent.
	BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`

	// Reference to backend http setting of application gateway to be used for test probe.
	BackendHTTPSettings *SubResource `json:"backendHttpSettings,omitempty"`

	// Host name to send the probe to.
	Host *string `json:"host,omitempty"`

	// Criterion for classifying a healthy probe response.
	Match *ApplicationGatewayProbeHealthResponseMatch `json:"match,omitempty"`

	// Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.
	Path *string `json:"path,omitempty"`

	// Whether the host header should be picked from the backend http settings. Default value is false.
	PickHostNameFromBackendHTTPSettings *bool `json:"pickHostNameFromBackendHttpSettings,omitempty"`

	// The protocol used for the probe.
	Protocol *ApplicationGatewayProtocol `json:"protocol,omitempty"`

	// 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"`
}

ApplicationGatewayOnDemandProbe - Details of on demand test probe request.

type ApplicationGatewayOperationalState 

type ApplicationGatewayOperationalState string

ApplicationGatewayOperationalState - Operational state of the application gateway resource. 

const (
	ApplicationGatewayOperationalStateRunning  ApplicationGatewayOperationalState = "Running"
	ApplicationGatewayOperationalStateStarting ApplicationGatewayOperationalState = "Starting"
	ApplicationGatewayOperationalStateStopped  ApplicationGatewayOperationalState = "Stopped"
	ApplicationGatewayOperationalStateStopping ApplicationGatewayOperationalState = "Stopping"
)

func PossibleApplicationGatewayOperationalStateValues 

func PossibleApplicationGatewayOperationalStateValues() []ApplicationGatewayOperationalState

PossibleApplicationGatewayOperationalStateValues returns the possible values for the ApplicationGatewayOperationalState const type.

func (ApplicationGatewayOperationalState) ToPtr 

func (c ApplicationGatewayOperationalState) ToPtr() *ApplicationGatewayOperationalState

ToPtr returns a *ApplicationGatewayOperationalState pointing to the current value.

type ApplicationGatewayPathRule 

type ApplicationGatewayPathRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the path rule that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway path rule.
	Properties *ApplicationGatewayPathRulePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayPathRule - Path rule of URL path map of an application gateway.

type ApplicationGatewayPathRulePropertiesFormat 

type ApplicationGatewayPathRulePropertiesFormat struct {
	// Backend address pool resource of URL path map path rule.
	BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`

	// Backend http settings resource of URL path map path rule.
	BackendHTTPSettings *SubResource `json:"backendHttpSettings,omitempty"`

	// Reference to the FirewallPolicy resource.
	FirewallPolicy *SubResource `json:"firewallPolicy,omitempty"`

	// Load Distribution Policy resource of URL path map path rule.
	LoadDistributionPolicy *SubResource `json:"loadDistributionPolicy,omitempty"`

	// Path rules of URL path map.
	Paths []*string `json:"paths,omitempty"`

	// Redirect configuration resource of URL path map path rule.
	RedirectConfiguration *SubResource `json:"redirectConfiguration,omitempty"`

	// Rewrite rule set resource of URL path map path rule.
	RewriteRuleSet *SubResource `json:"rewriteRuleSet,omitempty"`

	// READ-ONLY; The provisioning state of the path rule resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayPathRulePropertiesFormat - Properties of path rule of an application gateway.

func (ApplicationGatewayPathRulePropertiesFormat) MarshalJSON 

func (a ApplicationGatewayPathRulePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPathRulePropertiesFormat.

type ApplicationGatewayPrivateEndpointConnection 

type ApplicationGatewayPrivateEndpointConnection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the private endpoint connection on an application gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway private endpoint connection.
	Properties *ApplicationGatewayPrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayPrivateEndpointConnection - Private Endpoint connection on an application gateway.

type ApplicationGatewayPrivateEndpointConnectionListResult 

type ApplicationGatewayPrivateEndpointConnectionListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of private endpoint connections on an application gateway.
	Value []*ApplicationGatewayPrivateEndpointConnection `json:"value,omitempty"`
}

ApplicationGatewayPrivateEndpointConnectionListResult - Response for ListApplicationGatewayPrivateEndpointConnection API service call. Gets all private endpoint connections for an application gateway.

func (ApplicationGatewayPrivateEndpointConnectionListResult) MarshalJSON 

func (a ApplicationGatewayPrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateEndpointConnectionListResult.

type ApplicationGatewayPrivateEndpointConnectionProperties 

type ApplicationGatewayPrivateEndpointConnectionProperties struct {
	// A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// READ-ONLY; The consumer link id.
	LinkIdentifier *string `json:"linkIdentifier,omitempty" azure:"ro"`

	// READ-ONLY; The resource of private end point.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the application gateway private endpoint connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayPrivateEndpointConnectionProperties - Properties of Private Link Resource of an application gateway.

type ApplicationGatewayPrivateEndpointConnectionsClient 

type ApplicationGatewayPrivateEndpointConnectionsClient struct {
	// contains filtered or unexported fields
}

ApplicationGatewayPrivateEndpointConnectionsClient contains the methods for the ApplicationGatewayPrivateEndpointConnections group. Don't use this type directly, use NewApplicationGatewayPrivateEndpointConnectionsClient() instead.

func NewApplicationGatewayPrivateEndpointConnectionsClient 

func NewApplicationGatewayPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ApplicationGatewayPrivateEndpointConnectionsClient

NewApplicationGatewayPrivateEndpointConnectionsClient creates a new instance of ApplicationGatewayPrivateEndpointConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ApplicationGatewayPrivateEndpointConnectionsClient) BeginDelete 

func (client *ApplicationGatewayPrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, applicationGatewayName string, connectionName string, options *ApplicationGatewayPrivateEndpointConnectionsClientBeginDeleteOptions) (ApplicationGatewayPrivateEndpointConnectionsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified private endpoint connection on application gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. connectionName - The name of the application gateway private endpoint connection. options - ApplicationGatewayPrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the ApplicationGatewayPrivateEndpointConnectionsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewayPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ApplicationGatewayPrivateEndpointConnectionsClient) BeginUpdate 

func (client *ApplicationGatewayPrivateEndpointConnectionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, applicationGatewayName string, connectionName string, parameters ApplicationGatewayPrivateEndpointConnection, options *ApplicationGatewayPrivateEndpointConnectionsClientBeginUpdateOptions) (ApplicationGatewayPrivateEndpointConnectionsClientUpdatePollerResponse, error)

BeginUpdate - Updates the specified private endpoint connection on application gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. connectionName - The name of the application gateway private endpoint connection. parameters - Parameters supplied to update application gateway private endpoint connection operation. options - ApplicationGatewayPrivateEndpointConnectionsClientBeginUpdateOptions contains the optional parameters for the ApplicationGatewayPrivateEndpointConnectionsClient.BeginUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewayPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		"<connection-name>",
		armnetwork.ApplicationGatewayPrivateEndpointConnection{
			Name: to.StringPtr("<name>"),
			Properties: &armnetwork.ApplicationGatewayPrivateEndpointConnectionProperties{
				PrivateEndpoint: &armnetwork.PrivateEndpoint{
					ID: to.StringPtr("<id>"),
				},
				PrivateLinkServiceConnectionState: &armnetwork.PrivateLinkServiceConnectionState{
					Description: to.StringPtr("<description>"),
					Status:      to.StringPtr("<status>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewayPrivateEndpointConnectionsClientUpdateResult)
}

Output:

func (*ApplicationGatewayPrivateEndpointConnectionsClient) Get 

func (client *ApplicationGatewayPrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, applicationGatewayName string, connectionName string, options *ApplicationGatewayPrivateEndpointConnectionsClientGetOptions) (ApplicationGatewayPrivateEndpointConnectionsClientGetResponse, error)

Get - Gets the specified private endpoint connection on application gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. connectionName - The name of the application gateway private endpoint connection. options - ApplicationGatewayPrivateEndpointConnectionsClientGetOptions contains the optional parameters for the ApplicationGatewayPrivateEndpointConnectionsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewayPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewayPrivateEndpointConnectionsClientGetResult)
}

Output:

func (*ApplicationGatewayPrivateEndpointConnectionsClient) List 

func (client *ApplicationGatewayPrivateEndpointConnectionsClient) List(resourceGroupName string, applicationGatewayName string, options *ApplicationGatewayPrivateEndpointConnectionsClientListOptions) *ApplicationGatewayPrivateEndpointConnectionsClientListPager

List - Lists all private endpoint connections on an application gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. options - ApplicationGatewayPrivateEndpointConnectionsClientListOptions contains the optional parameters for the ApplicationGatewayPrivateEndpointConnectionsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewayPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<application-gateway-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ApplicationGatewayPrivateEndpointConnectionsClientBeginDeleteOptions added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientBeginDeleteOptions struct {
}

ApplicationGatewayPrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the ApplicationGatewayPrivateEndpointConnectionsClient.BeginDelete method.

type ApplicationGatewayPrivateEndpointConnectionsClientBeginUpdateOptions added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientBeginUpdateOptions struct {
}

ApplicationGatewayPrivateEndpointConnectionsClientBeginUpdateOptions contains the optional parameters for the ApplicationGatewayPrivateEndpointConnectionsClient.BeginUpdate method.

type ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller) Done added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (ApplicationGatewayPrivateEndpointConnectionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ApplicationGatewayPrivateEndpointConnectionsClientDeleteResponse will be returned.

func (*ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller) Poll added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ApplicationGatewayPrivateEndpointConnectionsClientDeletePollerResponse added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ApplicationGatewayPrivateEndpointConnectionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewayPrivateEndpointConnectionsClientDeletePollerResponse contains the response from method ApplicationGatewayPrivateEndpointConnectionsClient.Delete.

func (ApplicationGatewayPrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ApplicationGatewayPrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ApplicationGatewayPrivateEndpointConnectionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ApplicationGatewayPrivateEndpointConnectionsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ApplicationGatewayPrivateEndpointConnectionsClientDeletePollerResponse) Resume(ctx context.Context, client *ApplicationGatewayPrivateEndpointConnectionsClient, token string) error

Resume rehydrates a ApplicationGatewayPrivateEndpointConnectionsClientDeletePollerResponse from the provided client and resume token.

type ApplicationGatewayPrivateEndpointConnectionsClientDeleteResponse added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewayPrivateEndpointConnectionsClientDeleteResponse contains the response from method ApplicationGatewayPrivateEndpointConnectionsClient.Delete.

type ApplicationGatewayPrivateEndpointConnectionsClientGetOptions added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientGetOptions struct {
}

ApplicationGatewayPrivateEndpointConnectionsClientGetOptions contains the optional parameters for the ApplicationGatewayPrivateEndpointConnectionsClient.Get method.

type ApplicationGatewayPrivateEndpointConnectionsClientGetResponse added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientGetResponse struct {
	ApplicationGatewayPrivateEndpointConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewayPrivateEndpointConnectionsClientGetResponse contains the response from method ApplicationGatewayPrivateEndpointConnectionsClient.Get.

type ApplicationGatewayPrivateEndpointConnectionsClientGetResult added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientGetResult struct {
	ApplicationGatewayPrivateEndpointConnection
}

ApplicationGatewayPrivateEndpointConnectionsClientGetResult contains the result from method ApplicationGatewayPrivateEndpointConnectionsClient.Get.

type ApplicationGatewayPrivateEndpointConnectionsClientListOptions added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientListOptions struct {
}

ApplicationGatewayPrivateEndpointConnectionsClientListOptions contains the optional parameters for the ApplicationGatewayPrivateEndpointConnectionsClient.List method.

type ApplicationGatewayPrivateEndpointConnectionsClientListPager added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientListPager struct {
	// contains filtered or unexported fields
}

ApplicationGatewayPrivateEndpointConnectionsClientListPager provides operations for iterating over paged responses.

func (*ApplicationGatewayPrivateEndpointConnectionsClientListPager) Err added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ApplicationGatewayPrivateEndpointConnectionsClientListPager) NextPage added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ApplicationGatewayPrivateEndpointConnectionsClientListPager) PageResponse added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientListPager) PageResponse() ApplicationGatewayPrivateEndpointConnectionsClientListResponse

PageResponse returns the current ApplicationGatewayPrivateEndpointConnectionsClientListResponse page.

type ApplicationGatewayPrivateEndpointConnectionsClientListResponse added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientListResponse struct {
	ApplicationGatewayPrivateEndpointConnectionsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewayPrivateEndpointConnectionsClientListResponse contains the response from method ApplicationGatewayPrivateEndpointConnectionsClient.List.

type ApplicationGatewayPrivateEndpointConnectionsClientListResult added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientListResult struct {
	ApplicationGatewayPrivateEndpointConnectionListResult
}

ApplicationGatewayPrivateEndpointConnectionsClientListResult contains the result from method ApplicationGatewayPrivateEndpointConnectionsClient.List.

type ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller struct {
	// contains filtered or unexported fields
}

ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller) Done added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller) FinalResponse added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller) FinalResponse(ctx context.Context) (ApplicationGatewayPrivateEndpointConnectionsClientUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ApplicationGatewayPrivateEndpointConnectionsClientUpdateResponse will be returned.

func (*ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller) Poll added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller) ResumeToken added in v0.3.0 

func (p *ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ApplicationGatewayPrivateEndpointConnectionsClientUpdatePollerResponse added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ApplicationGatewayPrivateEndpointConnectionsClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewayPrivateEndpointConnectionsClientUpdatePollerResponse contains the response from method ApplicationGatewayPrivateEndpointConnectionsClient.Update.

func (ApplicationGatewayPrivateEndpointConnectionsClientUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ApplicationGatewayPrivateEndpointConnectionsClientUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ApplicationGatewayPrivateEndpointConnectionsClientUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ApplicationGatewayPrivateEndpointConnectionsClientUpdatePollerResponse) Resume added in v0.3.0 

func (l *ApplicationGatewayPrivateEndpointConnectionsClientUpdatePollerResponse) Resume(ctx context.Context, client *ApplicationGatewayPrivateEndpointConnectionsClient, token string) error

Resume rehydrates a ApplicationGatewayPrivateEndpointConnectionsClientUpdatePollerResponse from the provided client and resume token.

type ApplicationGatewayPrivateEndpointConnectionsClientUpdateResponse added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientUpdateResponse struct {
	ApplicationGatewayPrivateEndpointConnectionsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewayPrivateEndpointConnectionsClientUpdateResponse contains the response from method ApplicationGatewayPrivateEndpointConnectionsClient.Update.

type ApplicationGatewayPrivateEndpointConnectionsClientUpdateResult added in v0.3.0 

type ApplicationGatewayPrivateEndpointConnectionsClientUpdateResult struct {
	ApplicationGatewayPrivateEndpointConnection
}

ApplicationGatewayPrivateEndpointConnectionsClientUpdateResult contains the result from method ApplicationGatewayPrivateEndpointConnectionsClient.Update.

type ApplicationGatewayPrivateLinkConfiguration 

type ApplicationGatewayPrivateLinkConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the private link configuration that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway private link configuration.
	Properties *ApplicationGatewayPrivateLinkConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayPrivateLinkConfiguration - Private Link Configuration on an application gateway.

type ApplicationGatewayPrivateLinkConfigurationProperties 

type ApplicationGatewayPrivateLinkConfigurationProperties struct {
	// An array of application gateway private link ip configurations.
	IPConfigurations []*ApplicationGatewayPrivateLinkIPConfiguration `json:"ipConfigurations,omitempty"`

	// READ-ONLY; The provisioning state of the application gateway private link configuration.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayPrivateLinkConfigurationProperties - Properties of private link configuration on an application gateway.

func (ApplicationGatewayPrivateLinkConfigurationProperties) MarshalJSON 

func (a ApplicationGatewayPrivateLinkConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateLinkConfigurationProperties.

type ApplicationGatewayPrivateLinkIPConfiguration 

type ApplicationGatewayPrivateLinkIPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of application gateway private link ip configuration.
	Name *string `json:"name,omitempty"`

	// Properties of an application gateway private link ip configuration.
	Properties *ApplicationGatewayPrivateLinkIPConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; The resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayPrivateLinkIPConfiguration - The application gateway private link ip configuration.

type ApplicationGatewayPrivateLinkIPConfigurationProperties 

type ApplicationGatewayPrivateLinkIPConfigurationProperties struct {
	// Whether the ip configuration is primary or not.
	Primary *bool `json:"primary,omitempty"`

	// The private IP address of the IP configuration.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// The private IP address allocation method.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// Reference to the subnet resource.
	Subnet *SubResource `json:"subnet,omitempty"`

	// READ-ONLY; The provisioning state of the application gateway private link IP configuration.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayPrivateLinkIPConfigurationProperties - Properties of an application gateway private link IP configuration.

type ApplicationGatewayPrivateLinkResource 

type ApplicationGatewayPrivateLinkResource struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the private link resource that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway private link resource.
	Properties *ApplicationGatewayPrivateLinkResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayPrivateLinkResource - PrivateLink Resource of an application gateway.

type ApplicationGatewayPrivateLinkResourceListResult 

type ApplicationGatewayPrivateLinkResourceListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of private link resources of an application gateway.
	Value []*ApplicationGatewayPrivateLinkResource `json:"value,omitempty"`
}

ApplicationGatewayPrivateLinkResourceListResult - Response for ListApplicationGatewayPrivateLinkResources API service call. Gets all private link resources for an application gateway.

func (ApplicationGatewayPrivateLinkResourceListResult) MarshalJSON 

func (a ApplicationGatewayPrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateLinkResourceListResult.

type ApplicationGatewayPrivateLinkResourceProperties 

type ApplicationGatewayPrivateLinkResourceProperties struct {
	// Required DNS zone names of the the private link resource.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; Group identifier of private link resource.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; Required member names of private link resource.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

ApplicationGatewayPrivateLinkResourceProperties - Properties of a private link resource.

func (ApplicationGatewayPrivateLinkResourceProperties) MarshalJSON 

func (a ApplicationGatewayPrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateLinkResourceProperties.

type ApplicationGatewayPrivateLinkResourcesClient 

type ApplicationGatewayPrivateLinkResourcesClient struct {
	// contains filtered or unexported fields
}

ApplicationGatewayPrivateLinkResourcesClient contains the methods for the ApplicationGatewayPrivateLinkResources group. Don't use this type directly, use NewApplicationGatewayPrivateLinkResourcesClient() instead.

func NewApplicationGatewayPrivateLinkResourcesClient 

func NewApplicationGatewayPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ApplicationGatewayPrivateLinkResourcesClient

NewApplicationGatewayPrivateLinkResourcesClient creates a new instance of ApplicationGatewayPrivateLinkResourcesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ApplicationGatewayPrivateLinkResourcesClient) List 

func (client *ApplicationGatewayPrivateLinkResourcesClient) List(resourceGroupName string, applicationGatewayName string, options *ApplicationGatewayPrivateLinkResourcesClientListOptions) *ApplicationGatewayPrivateLinkResourcesClientListPager

List - Lists all private link resources on an application gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. options - ApplicationGatewayPrivateLinkResourcesClientListOptions contains the optional parameters for the ApplicationGatewayPrivateLinkResourcesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayPrivateLinkResourceList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewayPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<application-gateway-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ApplicationGatewayPrivateLinkResourcesClientListOptions added in v0.3.0 

type ApplicationGatewayPrivateLinkResourcesClientListOptions struct {
}

ApplicationGatewayPrivateLinkResourcesClientListOptions contains the optional parameters for the ApplicationGatewayPrivateLinkResourcesClient.List method.

type ApplicationGatewayPrivateLinkResourcesClientListPager added in v0.3.0 

type ApplicationGatewayPrivateLinkResourcesClientListPager struct {
	// contains filtered or unexported fields
}

ApplicationGatewayPrivateLinkResourcesClientListPager provides operations for iterating over paged responses.

func (*ApplicationGatewayPrivateLinkResourcesClientListPager) Err added in v0.3.0 

func (p *ApplicationGatewayPrivateLinkResourcesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ApplicationGatewayPrivateLinkResourcesClientListPager) NextPage added in v0.3.0 

func (p *ApplicationGatewayPrivateLinkResourcesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ApplicationGatewayPrivateLinkResourcesClientListPager) PageResponse added in v0.3.0 

func (p *ApplicationGatewayPrivateLinkResourcesClientListPager) PageResponse() ApplicationGatewayPrivateLinkResourcesClientListResponse

PageResponse returns the current ApplicationGatewayPrivateLinkResourcesClientListResponse page.

type ApplicationGatewayPrivateLinkResourcesClientListResponse added in v0.3.0 

type ApplicationGatewayPrivateLinkResourcesClientListResponse struct {
	ApplicationGatewayPrivateLinkResourcesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewayPrivateLinkResourcesClientListResponse contains the response from method ApplicationGatewayPrivateLinkResourcesClient.List.

type ApplicationGatewayPrivateLinkResourcesClientListResult added in v0.3.0 

type ApplicationGatewayPrivateLinkResourcesClientListResult struct {
	ApplicationGatewayPrivateLinkResourceListResult
}

ApplicationGatewayPrivateLinkResourcesClientListResult contains the result from method ApplicationGatewayPrivateLinkResourcesClient.List.

type ApplicationGatewayProbe 

type ApplicationGatewayProbe struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the probe that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway probe.
	Properties *ApplicationGatewayProbePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayProbe - Probe of the application gateway.

type ApplicationGatewayProbeHealthResponseMatch 

type ApplicationGatewayProbeHealthResponseMatch struct {
	// Body that must be contained in the health response. Default value is empty.
	Body *string `json:"body,omitempty"`

	// Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.
	StatusCodes []*string `json:"statusCodes,omitempty"`
}

ApplicationGatewayProbeHealthResponseMatch - Application gateway probe health response match.

func (ApplicationGatewayProbeHealthResponseMatch) MarshalJSON 

func (a ApplicationGatewayProbeHealthResponseMatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayProbeHealthResponseMatch.

type ApplicationGatewayProbePropertiesFormat 

type ApplicationGatewayProbePropertiesFormat struct {
	// Host name to send the probe to.
	Host *string `json:"host,omitempty"`

	// 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"`

	// Criterion for classifying a healthy probe response.
	Match *ApplicationGatewayProbeHealthResponseMatch `json:"match,omitempty"`

	// Minimum number of servers that are always marked healthy. Default value is 0.
	MinServers *int32 `json:"minServers,omitempty"`

	// Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.
	Path *string `json:"path,omitempty"`

	// Whether the host header should be picked from the backend http settings. Default value is false.
	PickHostNameFromBackendHTTPSettings *bool `json:"pickHostNameFromBackendHttpSettings,omitempty"`

	// Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set,
	// port from http settings will be used. This property is valid for Standardv2 and
	// WAFv2 only.
	Port *int32 `json:"port,omitempty"`

	// The protocol used for the probe.
	Protocol *ApplicationGatewayProtocol `json:"protocol,omitempty"`

	// 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"`

	// 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"`

	// READ-ONLY; The provisioning state of the probe resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayProbePropertiesFormat - Properties of probe of an application gateway.

type ApplicationGatewayPropertiesFormat 

type ApplicationGatewayPropertiesFormat struct {
	// Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits
	// [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	AuthenticationCertificates []*ApplicationGatewayAuthenticationCertificate `json:"authenticationCertificates,omitempty"`

	// Autoscale Configuration.
	AutoscaleConfiguration *ApplicationGatewayAutoscaleConfiguration `json:"autoscaleConfiguration,omitempty"`

	// Backend address pool of the application gateway resource. For default limits, see Application Gateway limits
	// [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	BackendAddressPools []*ApplicationGatewayBackendAddressPool `json:"backendAddressPools,omitempty"`

	// Backend http settings of the application gateway resource. For default limits, see Application Gateway limits
	// [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	BackendHTTPSettingsCollection []*ApplicationGatewayBackendHTTPSettings `json:"backendHttpSettingsCollection,omitempty"`

	// Custom error configurations of the application gateway resource.
	CustomErrorConfigurations []*ApplicationGatewayCustomError `json:"customErrorConfigurations,omitempty"`

	// Whether FIPS is enabled on the application gateway resource.
	EnableFips *bool `json:"enableFips,omitempty"`

	// Whether HTTP2 is enabled on the application gateway resource.
	EnableHTTP2 *bool `json:"enableHttp2,omitempty"`

	// Reference to the FirewallPolicy resource.
	FirewallPolicy *SubResource `json:"firewallPolicy,omitempty"`

	// If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.
	ForceFirewallPolicyAssociation *bool `json:"forceFirewallPolicyAssociation,omitempty"`

	// Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits
	// [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	FrontendIPConfigurations []*ApplicationGatewayFrontendIPConfiguration `json:"frontendIPConfigurations,omitempty"`

	// Frontend ports of the application gateway resource. For default limits, see Application Gateway limits [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	FrontendPorts []*ApplicationGatewayFrontendPort `json:"frontendPorts,omitempty"`

	// Subnets of the application gateway resource. For default limits, see Application Gateway limits [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	GatewayIPConfigurations []*ApplicationGatewayIPConfiguration `json:"gatewayIPConfigurations,omitempty"`

	// Global Configuration.
	GlobalConfiguration *ApplicationGatewayGlobalConfiguration `json:"globalConfiguration,omitempty"`

	// Http listeners of the application gateway resource. For default limits, see Application Gateway limits [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	HTTPListeners []*ApplicationGatewayHTTPListener `json:"httpListeners,omitempty"`

	// Load distribution policies of the application gateway resource.
	LoadDistributionPolicies []*ApplicationGatewayLoadDistributionPolicy `json:"loadDistributionPolicies,omitempty"`

	// PrivateLink configurations on application gateway.
	PrivateLinkConfigurations []*ApplicationGatewayPrivateLinkConfiguration `json:"privateLinkConfigurations,omitempty"`

	// Probes of the application gateway resource.
	Probes []*ApplicationGatewayProbe `json:"probes,omitempty"`

	// Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits
	// [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	RedirectConfigurations []*ApplicationGatewayRedirectConfiguration `json:"redirectConfigurations,omitempty"`

	// Request routing rules of the application gateway resource.
	RequestRoutingRules []*ApplicationGatewayRequestRoutingRule `json:"requestRoutingRules,omitempty"`

	// Rewrite rules for the application gateway resource.
	RewriteRuleSets []*ApplicationGatewayRewriteRuleSet `json:"rewriteRuleSets,omitempty"`

	// SKU of the application gateway resource.
	SKU *ApplicationGatewaySKU `json:"sku,omitempty"`

	// SSL certificates of the application gateway resource. For default limits, see Application Gateway limits [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits]
	// .
	SSLCertificates []*ApplicationGatewaySSLCertificate `json:"sslCertificates,omitempty"`

	// SSL policy of the application gateway resource.
	SSLPolicy *ApplicationGatewaySSLPolicy `json:"sslPolicy,omitempty"`

	// SSL profiles of the application gateway resource. For default limits, see Application Gateway limits [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	SSLProfiles []*ApplicationGatewaySSLProfile `json:"sslProfiles,omitempty"`

	// Trusted client certificates of the application gateway resource. For default limits, see Application Gateway limits
	// [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	TrustedClientCertificates []*ApplicationGatewayTrustedClientCertificate `json:"trustedClientCertificates,omitempty"`

	// Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits
	// [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	TrustedRootCertificates []*ApplicationGatewayTrustedRootCertificate `json:"trustedRootCertificates,omitempty"`

	// URL path map of the application gateway resource. For default limits, see Application Gateway limits [https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits].
	URLPathMaps []*ApplicationGatewayURLPathMap `json:"urlPathMaps,omitempty"`

	// Web application firewall configuration.
	WebApplicationFirewallConfiguration *ApplicationGatewayWebApplicationFirewallConfiguration `json:"webApplicationFirewallConfiguration,omitempty"`

	// READ-ONLY; Operational state of the application gateway resource.
	OperationalState *ApplicationGatewayOperationalState `json:"operationalState,omitempty" azure:"ro"`

	// READ-ONLY; Private Endpoint connections on application gateway.
	PrivateEndpointConnections []*ApplicationGatewayPrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the application gateway resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the application gateway resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

ApplicationGatewayPropertiesFormat - Properties of the application gateway.

func (ApplicationGatewayPropertiesFormat) MarshalJSON 

func (a ApplicationGatewayPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPropertiesFormat.

type ApplicationGatewayProtocol 

type ApplicationGatewayProtocol string

ApplicationGatewayProtocol - Application Gateway protocol. 

const (
	ApplicationGatewayProtocolHTTP  ApplicationGatewayProtocol = "Http"
	ApplicationGatewayProtocolHTTPS ApplicationGatewayProtocol = "Https"
)

func PossibleApplicationGatewayProtocolValues 

func PossibleApplicationGatewayProtocolValues() []ApplicationGatewayProtocol

PossibleApplicationGatewayProtocolValues returns the possible values for the ApplicationGatewayProtocol const type.

func (ApplicationGatewayProtocol) ToPtr 

func (c ApplicationGatewayProtocol) ToPtr() *ApplicationGatewayProtocol

ToPtr returns a *ApplicationGatewayProtocol pointing to the current value.

type ApplicationGatewayRedirectConfiguration 

type ApplicationGatewayRedirectConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the redirect configuration that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway redirect configuration.
	Properties *ApplicationGatewayRedirectConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayRedirectConfiguration - Redirect configuration of an application gateway.

type ApplicationGatewayRedirectConfigurationPropertiesFormat 

type ApplicationGatewayRedirectConfigurationPropertiesFormat struct {
	// Include path in the redirected url.
	IncludePath *bool `json:"includePath,omitempty"`

	// Include query string in the redirected url.
	IncludeQueryString *bool `json:"includeQueryString,omitempty"`

	// Path rules specifying redirect configuration.
	PathRules []*SubResource `json:"pathRules,omitempty"`

	// HTTP redirection type.
	RedirectType *ApplicationGatewayRedirectType `json:"redirectType,omitempty"`

	// Request routing specifying redirect configuration.
	RequestRoutingRules []*SubResource `json:"requestRoutingRules,omitempty"`

	// Reference to a listener to redirect the request to.
	TargetListener *SubResource `json:"targetListener,omitempty"`

	// Url to redirect the request to.
	TargetURL *string `json:"targetUrl,omitempty"`

	// Url path maps specifying default redirect configuration.
	URLPathMaps []*SubResource `json:"urlPathMaps,omitempty"`
}

ApplicationGatewayRedirectConfigurationPropertiesFormat - Properties of redirect configuration of the application gateway.

func (ApplicationGatewayRedirectConfigurationPropertiesFormat) MarshalJSON 

func (a ApplicationGatewayRedirectConfigurationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRedirectConfigurationPropertiesFormat.

type ApplicationGatewayRedirectType 

type ApplicationGatewayRedirectType string

ApplicationGatewayRedirectType - Redirect type enum. 

const (
	ApplicationGatewayRedirectTypeFound     ApplicationGatewayRedirectType = "Found"
	ApplicationGatewayRedirectTypePermanent ApplicationGatewayRedirectType = "Permanent"
	ApplicationGatewayRedirectTypeSeeOther  ApplicationGatewayRedirectType = "SeeOther"
	ApplicationGatewayRedirectTypeTemporary ApplicationGatewayRedirectType = "Temporary"
)

func PossibleApplicationGatewayRedirectTypeValues 

func PossibleApplicationGatewayRedirectTypeValues() []ApplicationGatewayRedirectType

PossibleApplicationGatewayRedirectTypeValues returns the possible values for the ApplicationGatewayRedirectType const type.

func (ApplicationGatewayRedirectType) ToPtr 

func (c ApplicationGatewayRedirectType) ToPtr() *ApplicationGatewayRedirectType

ToPtr returns a *ApplicationGatewayRedirectType pointing to the current value.

type ApplicationGatewayRequestRoutingRule 

type ApplicationGatewayRequestRoutingRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the request routing rule that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway request routing rule.
	Properties *ApplicationGatewayRequestRoutingRulePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayRequestRoutingRule - Request routing rule of an application gateway.

type ApplicationGatewayRequestRoutingRulePropertiesFormat 

type ApplicationGatewayRequestRoutingRulePropertiesFormat struct {
	// Backend address pool resource of the application gateway.
	BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`

	// Backend http settings resource of the application gateway.
	BackendHTTPSettings *SubResource `json:"backendHttpSettings,omitempty"`

	// Http listener resource of the application gateway.
	HTTPListener *SubResource `json:"httpListener,omitempty"`

	// Load Distribution Policy resource of the application gateway.
	LoadDistributionPolicy *SubResource `json:"loadDistributionPolicy,omitempty"`

	// Priority of the request routing rule.
	Priority *int32 `json:"priority,omitempty"`

	// Redirect configuration resource of the application gateway.
	RedirectConfiguration *SubResource `json:"redirectConfiguration,omitempty"`

	// Rewrite Rule Set resource in Basic rule of the application gateway.
	RewriteRuleSet *SubResource `json:"rewriteRuleSet,omitempty"`

	// Rule type.
	RuleType *ApplicationGatewayRequestRoutingRuleType `json:"ruleType,omitempty"`

	// URL path map resource of the application gateway.
	URLPathMap *SubResource `json:"urlPathMap,omitempty"`

	// READ-ONLY; The provisioning state of the request routing rule resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayRequestRoutingRulePropertiesFormat - Properties of request routing rule of the application gateway.

type ApplicationGatewayRequestRoutingRuleType 

type ApplicationGatewayRequestRoutingRuleType string

ApplicationGatewayRequestRoutingRuleType - Rule type. 

const (
	ApplicationGatewayRequestRoutingRuleTypeBasic            ApplicationGatewayRequestRoutingRuleType = "Basic"
	ApplicationGatewayRequestRoutingRuleTypePathBasedRouting ApplicationGatewayRequestRoutingRuleType = "PathBasedRouting"
)

func PossibleApplicationGatewayRequestRoutingRuleTypeValues 

func PossibleApplicationGatewayRequestRoutingRuleTypeValues() []ApplicationGatewayRequestRoutingRuleType

PossibleApplicationGatewayRequestRoutingRuleTypeValues returns the possible values for the ApplicationGatewayRequestRoutingRuleType const type.

func (ApplicationGatewayRequestRoutingRuleType) ToPtr 

func (c ApplicationGatewayRequestRoutingRuleType) ToPtr() *ApplicationGatewayRequestRoutingRuleType

ToPtr returns a *ApplicationGatewayRequestRoutingRuleType pointing to the current value.

type ApplicationGatewayRewriteRule 

type ApplicationGatewayRewriteRule struct {
	// Set of actions to be done as part of the rewrite Rule.
	ActionSet *ApplicationGatewayRewriteRuleActionSet `json:"actionSet,omitempty"`

	// Conditions based on which the action set execution will be evaluated.
	Conditions []*ApplicationGatewayRewriteRuleCondition `json:"conditions,omitempty"`

	// Name of the rewrite rule that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.
	RuleSequence *int32 `json:"ruleSequence,omitempty"`
}

ApplicationGatewayRewriteRule - Rewrite rule of an application gateway.

func (ApplicationGatewayRewriteRule) MarshalJSON 

func (a ApplicationGatewayRewriteRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRewriteRule.

type ApplicationGatewayRewriteRuleActionSet 

type ApplicationGatewayRewriteRuleActionSet struct {
	// Request Header Actions in the Action Set.
	RequestHeaderConfigurations []*ApplicationGatewayHeaderConfiguration `json:"requestHeaderConfigurations,omitempty"`

	// Response Header Actions in the Action Set.
	ResponseHeaderConfigurations []*ApplicationGatewayHeaderConfiguration `json:"responseHeaderConfigurations,omitempty"`

	// Url Configuration Action in the Action Set.
	URLConfiguration *ApplicationGatewayURLConfiguration `json:"urlConfiguration,omitempty"`
}

ApplicationGatewayRewriteRuleActionSet - Set of actions in the Rewrite Rule in Application Gateway.

func (ApplicationGatewayRewriteRuleActionSet) MarshalJSON 

func (a ApplicationGatewayRewriteRuleActionSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRewriteRuleActionSet.

type ApplicationGatewayRewriteRuleCondition 

type ApplicationGatewayRewriteRuleCondition struct {
	// Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison.
	IgnoreCase *bool `json:"ignoreCase,omitempty"`

	// Setting this value as truth will force to check the negation of the condition given by the user.
	Negate *bool `json:"negate,omitempty"`

	// The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.
	Pattern *string `json:"pattern,omitempty"`

	// The condition parameter of the RewriteRuleCondition.
	Variable *string `json:"variable,omitempty"`
}

ApplicationGatewayRewriteRuleCondition - Set of conditions in the Rewrite Rule in Application Gateway.

type ApplicationGatewayRewriteRuleSet 

type ApplicationGatewayRewriteRuleSet struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the rewrite rule set that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway rewrite rule set.
	Properties *ApplicationGatewayRewriteRuleSetPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

ApplicationGatewayRewriteRuleSet - Rewrite rule set of an application gateway.

type ApplicationGatewayRewriteRuleSetPropertiesFormat 

type ApplicationGatewayRewriteRuleSetPropertiesFormat struct {
	// Rewrite rules in the rewrite rule set.
	RewriteRules []*ApplicationGatewayRewriteRule `json:"rewriteRules,omitempty"`

	// READ-ONLY; The provisioning state of the rewrite rule set resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayRewriteRuleSetPropertiesFormat - Properties of rewrite rule set of the application gateway.

func (ApplicationGatewayRewriteRuleSetPropertiesFormat) MarshalJSON 

func (a ApplicationGatewayRewriteRuleSetPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRewriteRuleSetPropertiesFormat.

type ApplicationGatewaySKU 

type ApplicationGatewaySKU struct {
	// Capacity (instance count) of an application gateway.
	Capacity *int32 `json:"capacity,omitempty"`

	// Name of an application gateway SKU.
	Name *ApplicationGatewaySKUName `json:"name,omitempty"`

	// Tier of an application gateway.
	Tier *ApplicationGatewayTier `json:"tier,omitempty"`
}

ApplicationGatewaySKU - SKU of an application gateway.

type ApplicationGatewaySKUName 

type ApplicationGatewaySKUName string

ApplicationGatewaySKUName - Name of an application gateway SKU. 

const (
	ApplicationGatewaySKUNameStandardLarge  ApplicationGatewaySKUName = "Standard_Large"
	ApplicationGatewaySKUNameStandardMedium ApplicationGatewaySKUName = "Standard_Medium"
	ApplicationGatewaySKUNameStandardSmall  ApplicationGatewaySKUName = "Standard_Small"
	ApplicationGatewaySKUNameStandardV2     ApplicationGatewaySKUName = "Standard_v2"
	ApplicationGatewaySKUNameWAFLarge       ApplicationGatewaySKUName = "WAF_Large"
	ApplicationGatewaySKUNameWAFMedium      ApplicationGatewaySKUName = "WAF_Medium"
	ApplicationGatewaySKUNameWAFV2          ApplicationGatewaySKUName = "WAF_v2"
)

func PossibleApplicationGatewaySKUNameValues 

func PossibleApplicationGatewaySKUNameValues() []ApplicationGatewaySKUName

PossibleApplicationGatewaySKUNameValues returns the possible values for the ApplicationGatewaySKUName const type.

func (ApplicationGatewaySKUName) ToPtr 

func (c ApplicationGatewaySKUName) ToPtr() *ApplicationGatewaySKUName

ToPtr returns a *ApplicationGatewaySKUName pointing to the current value.

type ApplicationGatewaySSLCertificate 

type ApplicationGatewaySSLCertificate struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the SSL certificate that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway SSL certificate.
	Properties *ApplicationGatewaySSLCertificatePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewaySSLCertificate - SSL certificates of an application gateway.

type ApplicationGatewaySSLCertificatePropertiesFormat 

type ApplicationGatewaySSLCertificatePropertiesFormat struct {
	// Base-64 encoded pfx certificate. Only applicable in PUT Request.
	Data *string `json:"data,omitempty"`

	// Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.
	KeyVaultSecretID *string `json:"keyVaultSecretId,omitempty"`

	// Password for the pfx file specified in data. Only applicable in PUT request.
	Password *string `json:"password,omitempty"`

	// READ-ONLY; The provisioning state of the SSL certificate resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.
	PublicCertData *string `json:"publicCertData,omitempty" azure:"ro"`
}

ApplicationGatewaySSLCertificatePropertiesFormat - Properties of SSL certificates of an application gateway.

type ApplicationGatewaySSLCipherSuite 

type ApplicationGatewaySSLCipherSuite string

ApplicationGatewaySSLCipherSuite - Ssl cipher suites enums. 

const (
	ApplicationGatewaySSLCipherSuiteTLSDHEDSSWITH3DESEDECBCSHA       ApplicationGatewaySSLCipherSuite = "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSDHEDSSWITHAES128CBCSHA        ApplicationGatewaySSLCipherSuite = "TLS_DHE_DSS_WITH_AES_128_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSDHEDSSWITHAES128CBCSHA256     ApplicationGatewaySSLCipherSuite = "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256"
	ApplicationGatewaySSLCipherSuiteTLSDHEDSSWITHAES256CBCSHA        ApplicationGatewaySSLCipherSuite = "TLS_DHE_DSS_WITH_AES_256_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSDHEDSSWITHAES256CBCSHA256     ApplicationGatewaySSLCipherSuite = "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256"
	ApplicationGatewaySSLCipherSuiteTLSDHERSAWITHAES128CBCSHA        ApplicationGatewaySSLCipherSuite = "TLS_DHE_RSA_WITH_AES_128_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSDHERSAWITHAES128GCMSHA256     ApplicationGatewaySSLCipherSuite = "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256"
	ApplicationGatewaySSLCipherSuiteTLSDHERSAWITHAES256CBCSHA        ApplicationGatewaySSLCipherSuite = "TLS_DHE_RSA_WITH_AES_256_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSDHERSAWITHAES256GCMSHA384     ApplicationGatewaySSLCipherSuite = "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384"
	ApplicationGatewaySSLCipherSuiteTLSECDHEECDSAWITHAES128CBCSHA    ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSECDHEECDSAWITHAES128CBCSHA256 ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256"
	ApplicationGatewaySSLCipherSuiteTLSECDHEECDSAWITHAES128GCMSHA256 ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"
	ApplicationGatewaySSLCipherSuiteTLSECDHEECDSAWITHAES256CBCSHA    ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSECDHEECDSAWITHAES256CBCSHA384 ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384"
	ApplicationGatewaySSLCipherSuiteTLSECDHEECDSAWITHAES256GCMSHA384 ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"
	ApplicationGatewaySSLCipherSuiteTLSECDHERSAWITHAES128CBCSHA      ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSECDHERSAWITHAES128CBCSHA256   ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"
	ApplicationGatewaySSLCipherSuiteTLSECDHERSAWITHAES128GCMSHA256   ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
	ApplicationGatewaySSLCipherSuiteTLSECDHERSAWITHAES256CBCSHA      ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSECDHERSAWITHAES256CBCSHA384   ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"
	ApplicationGatewaySSLCipherSuiteTLSECDHERSAWITHAES256GCMSHA384   ApplicationGatewaySSLCipherSuite = "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
	ApplicationGatewaySSLCipherSuiteTLSRSAWITH3DESEDECBCSHA          ApplicationGatewaySSLCipherSuite = "TLS_RSA_WITH_3DES_EDE_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSRSAWITHAES128CBCSHA           ApplicationGatewaySSLCipherSuite = "TLS_RSA_WITH_AES_128_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSRSAWITHAES128CBCSHA256        ApplicationGatewaySSLCipherSuite = "TLS_RSA_WITH_AES_128_CBC_SHA256"
	ApplicationGatewaySSLCipherSuiteTLSRSAWITHAES128GCMSHA256        ApplicationGatewaySSLCipherSuite = "TLS_RSA_WITH_AES_128_GCM_SHA256"
	ApplicationGatewaySSLCipherSuiteTLSRSAWITHAES256CBCSHA           ApplicationGatewaySSLCipherSuite = "TLS_RSA_WITH_AES_256_CBC_SHA"
	ApplicationGatewaySSLCipherSuiteTLSRSAWITHAES256CBCSHA256        ApplicationGatewaySSLCipherSuite = "TLS_RSA_WITH_AES_256_CBC_SHA256"
	ApplicationGatewaySSLCipherSuiteTLSRSAWITHAES256GCMSHA384        ApplicationGatewaySSLCipherSuite = "TLS_RSA_WITH_AES_256_GCM_SHA384"
)

func PossibleApplicationGatewaySSLCipherSuiteValues 

func PossibleApplicationGatewaySSLCipherSuiteValues() []ApplicationGatewaySSLCipherSuite

PossibleApplicationGatewaySSLCipherSuiteValues returns the possible values for the ApplicationGatewaySSLCipherSuite const type.

func (ApplicationGatewaySSLCipherSuite) ToPtr 

func (c ApplicationGatewaySSLCipherSuite) ToPtr() *ApplicationGatewaySSLCipherSuite

ToPtr returns a *ApplicationGatewaySSLCipherSuite pointing to the current value.

type ApplicationGatewaySSLPolicy 

type ApplicationGatewaySSLPolicy struct {
	// Ssl cipher suites to be enabled in the specified order to application gateway.
	CipherSuites []*ApplicationGatewaySSLCipherSuite `json:"cipherSuites,omitempty"`

	// Ssl protocols to be disabled on application gateway.
	DisabledSSLProtocols []*ApplicationGatewaySSLProtocol `json:"disabledSslProtocols,omitempty"`

	// Minimum version of Ssl protocol to be supported on application gateway.
	MinProtocolVersion *ApplicationGatewaySSLProtocol `json:"minProtocolVersion,omitempty"`

	// Name of Ssl predefined policy.
	PolicyName *ApplicationGatewaySSLPolicyName `json:"policyName,omitempty"`

	// Type of Ssl Policy.
	PolicyType *ApplicationGatewaySSLPolicyType `json:"policyType,omitempty"`
}

ApplicationGatewaySSLPolicy - Application Gateway Ssl policy.

func (ApplicationGatewaySSLPolicy) MarshalJSON 

func (a ApplicationGatewaySSLPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewaySSLPolicy.

type ApplicationGatewaySSLPolicyName 

type ApplicationGatewaySSLPolicyName string

ApplicationGatewaySSLPolicyName - Ssl predefined policy name enums. 

const (
	ApplicationGatewaySSLPolicyNameAppGwSSLPolicy20150501  ApplicationGatewaySSLPolicyName = "AppGwSslPolicy20150501"
	ApplicationGatewaySSLPolicyNameAppGwSSLPolicy20170401  ApplicationGatewaySSLPolicyName = "AppGwSslPolicy20170401"
	ApplicationGatewaySSLPolicyNameAppGwSSLPolicy20170401S ApplicationGatewaySSLPolicyName = "AppGwSslPolicy20170401S"
)

func PossibleApplicationGatewaySSLPolicyNameValues 

func PossibleApplicationGatewaySSLPolicyNameValues() []ApplicationGatewaySSLPolicyName

PossibleApplicationGatewaySSLPolicyNameValues returns the possible values for the ApplicationGatewaySSLPolicyName const type.

func (ApplicationGatewaySSLPolicyName) ToPtr 

func (c ApplicationGatewaySSLPolicyName) ToPtr() *ApplicationGatewaySSLPolicyName

ToPtr returns a *ApplicationGatewaySSLPolicyName pointing to the current value.

type ApplicationGatewaySSLPolicyType 

type ApplicationGatewaySSLPolicyType string

ApplicationGatewaySSLPolicyType - Type of Ssl Policy. 

const (
	ApplicationGatewaySSLPolicyTypeCustom     ApplicationGatewaySSLPolicyType = "Custom"
	ApplicationGatewaySSLPolicyTypePredefined ApplicationGatewaySSLPolicyType = "Predefined"
)

func PossibleApplicationGatewaySSLPolicyTypeValues 

func PossibleApplicationGatewaySSLPolicyTypeValues() []ApplicationGatewaySSLPolicyType

PossibleApplicationGatewaySSLPolicyTypeValues returns the possible values for the ApplicationGatewaySSLPolicyType const type.

func (ApplicationGatewaySSLPolicyType) ToPtr 

func (c ApplicationGatewaySSLPolicyType) ToPtr() *ApplicationGatewaySSLPolicyType

ToPtr returns a *ApplicationGatewaySSLPolicyType pointing to the current value.

type ApplicationGatewaySSLPredefinedPolicy 

type ApplicationGatewaySSLPredefinedPolicy struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the Ssl predefined policy.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway SSL predefined policy.
	Properties *ApplicationGatewaySSLPredefinedPolicyPropertiesFormat `json:"properties,omitempty"`
}

ApplicationGatewaySSLPredefinedPolicy - An Ssl predefined policy.

type ApplicationGatewaySSLPredefinedPolicyPropertiesFormat 

type ApplicationGatewaySSLPredefinedPolicyPropertiesFormat struct {
	// Ssl cipher suites to be enabled in the specified order for application gateway.
	CipherSuites []*ApplicationGatewaySSLCipherSuite `json:"cipherSuites,omitempty"`

	// Minimum version of Ssl protocol to be supported on application gateway.
	MinProtocolVersion *ApplicationGatewaySSLProtocol `json:"minProtocolVersion,omitempty"`
}

ApplicationGatewaySSLPredefinedPolicyPropertiesFormat - Properties of ApplicationGatewaySslPredefinedPolicy.

func (ApplicationGatewaySSLPredefinedPolicyPropertiesFormat) MarshalJSON 

func (a ApplicationGatewaySSLPredefinedPolicyPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewaySSLPredefinedPolicyPropertiesFormat.

type ApplicationGatewaySSLProfile 

type ApplicationGatewaySSLProfile struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the SSL profile that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway SSL profile.
	Properties *ApplicationGatewaySSLProfilePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewaySSLProfile - SSL profile of an application gateway.

type ApplicationGatewaySSLProfilePropertiesFormat 

type ApplicationGatewaySSLProfilePropertiesFormat struct {
	// Client authentication configuration of the application gateway resource.
	ClientAuthConfiguration *ApplicationGatewayClientAuthConfiguration `json:"clientAuthConfiguration,omitempty"`

	// SSL policy of the application gateway resource.
	SSLPolicy *ApplicationGatewaySSLPolicy `json:"sslPolicy,omitempty"`

	// Array of references to application gateway trusted client certificates.
	TrustedClientCertificates []*SubResource `json:"trustedClientCertificates,omitempty"`

	// READ-ONLY; The provisioning state of the HTTP listener resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewaySSLProfilePropertiesFormat - Properties of SSL profile of an application gateway.

func (ApplicationGatewaySSLProfilePropertiesFormat) MarshalJSON 

func (a ApplicationGatewaySSLProfilePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewaySSLProfilePropertiesFormat.

type ApplicationGatewaySSLProtocol 

type ApplicationGatewaySSLProtocol string

ApplicationGatewaySSLProtocol - Ssl protocol enums. 

const (
	ApplicationGatewaySSLProtocolTLSv10 ApplicationGatewaySSLProtocol = "TLSv1_0"
	ApplicationGatewaySSLProtocolTLSv11 ApplicationGatewaySSLProtocol = "TLSv1_1"
	ApplicationGatewaySSLProtocolTLSv12 ApplicationGatewaySSLProtocol = "TLSv1_2"
)

func PossibleApplicationGatewaySSLProtocolValues 

func PossibleApplicationGatewaySSLProtocolValues() []ApplicationGatewaySSLProtocol

PossibleApplicationGatewaySSLProtocolValues returns the possible values for the ApplicationGatewaySSLProtocol const type.

func (ApplicationGatewaySSLProtocol) ToPtr 

func (c ApplicationGatewaySSLProtocol) ToPtr() *ApplicationGatewaySSLProtocol

ToPtr returns a *ApplicationGatewaySSLProtocol pointing to the current value.

type ApplicationGatewayTier 

type ApplicationGatewayTier string

ApplicationGatewayTier - Tier of an application gateway. 

const (
	ApplicationGatewayTierStandard   ApplicationGatewayTier = "Standard"
	ApplicationGatewayTierStandardV2 ApplicationGatewayTier = "Standard_v2"
	ApplicationGatewayTierWAF        ApplicationGatewayTier = "WAF"
	ApplicationGatewayTierWAFV2      ApplicationGatewayTier = "WAF_v2"
)

func PossibleApplicationGatewayTierValues 

func PossibleApplicationGatewayTierValues() []ApplicationGatewayTier

PossibleApplicationGatewayTierValues returns the possible values for the ApplicationGatewayTier const type.

func (ApplicationGatewayTier) ToPtr 

func (c ApplicationGatewayTier) ToPtr() *ApplicationGatewayTier

ToPtr returns a *ApplicationGatewayTier pointing to the current value.

type ApplicationGatewayTrustedClientCertificate 

type ApplicationGatewayTrustedClientCertificate struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the trusted client certificate that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway trusted client certificate.
	Properties *ApplicationGatewayTrustedClientCertificatePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayTrustedClientCertificate - Trusted client certificates of an application gateway.

type ApplicationGatewayTrustedClientCertificatePropertiesFormat 

type ApplicationGatewayTrustedClientCertificatePropertiesFormat struct {
	// Certificate public data.
	Data *string `json:"data,omitempty"`

	// READ-ONLY; Distinguished name of client certificate issuer.
	ClientCertIssuerDN *string `json:"clientCertIssuerDN,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the trusted client certificate resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Validated certificate data.
	ValidatedCertData *string `json:"validatedCertData,omitempty" azure:"ro"`
}

ApplicationGatewayTrustedClientCertificatePropertiesFormat - Trusted client certificates properties of an application gateway.

type ApplicationGatewayTrustedRootCertificate 

type ApplicationGatewayTrustedRootCertificate struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the trusted root certificate that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway trusted root certificate.
	Properties *ApplicationGatewayTrustedRootCertificatePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayTrustedRootCertificate - Trusted Root certificates of an application gateway.

type ApplicationGatewayTrustedRootCertificatePropertiesFormat 

type ApplicationGatewayTrustedRootCertificatePropertiesFormat struct {
	// Certificate public data.
	Data *string `json:"data,omitempty"`

	// Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.
	KeyVaultSecretID *string `json:"keyVaultSecretId,omitempty"`

	// READ-ONLY; The provisioning state of the trusted root certificate resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayTrustedRootCertificatePropertiesFormat - Trusted Root certificates properties of an application gateway.

type ApplicationGatewayURLConfiguration 

type ApplicationGatewayURLConfiguration struct {
	// Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null.
	ModifiedPath *string `json:"modifiedPath,omitempty"`

	// Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null.
	ModifiedQueryString *string `json:"modifiedQueryString,omitempty"`

	// If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path.
	// Default value is false.
	Reroute *bool `json:"reroute,omitempty"`
}

ApplicationGatewayURLConfiguration - Url configuration of the Actions set in Application Gateway.

type ApplicationGatewayURLPathMap 

type ApplicationGatewayURLPathMap struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the URL path map that is unique within an Application Gateway.
	Name *string `json:"name,omitempty"`

	// Properties of the application gateway URL path map.
	Properties *ApplicationGatewayURLPathMapPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationGatewayURLPathMap - UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.

type ApplicationGatewayURLPathMapPropertiesFormat 

type ApplicationGatewayURLPathMapPropertiesFormat struct {
	// Default backend address pool resource of URL path map.
	DefaultBackendAddressPool *SubResource `json:"defaultBackendAddressPool,omitempty"`

	// Default backend http settings resource of URL path map.
	DefaultBackendHTTPSettings *SubResource `json:"defaultBackendHttpSettings,omitempty"`

	// Default Load Distribution Policy resource of URL path map.
	DefaultLoadDistributionPolicy *SubResource `json:"defaultLoadDistributionPolicy,omitempty"`

	// Default redirect configuration resource of URL path map.
	DefaultRedirectConfiguration *SubResource `json:"defaultRedirectConfiguration,omitempty"`

	// Default Rewrite rule set resource of URL path map.
	DefaultRewriteRuleSet *SubResource `json:"defaultRewriteRuleSet,omitempty"`

	// Path rule of URL path map resource.
	PathRules []*ApplicationGatewayPathRule `json:"pathRules,omitempty"`

	// READ-ONLY; The provisioning state of the URL path map resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayURLPathMapPropertiesFormat - Properties of UrlPathMap of the application gateway.

func (ApplicationGatewayURLPathMapPropertiesFormat) MarshalJSON 

func (a ApplicationGatewayURLPathMapPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayURLPathMapPropertiesFormat.

type ApplicationGatewayWebApplicationFirewallConfiguration 

type ApplicationGatewayWebApplicationFirewallConfiguration struct {
	// REQUIRED; Whether the web application firewall is enabled or not.
	Enabled *bool `json:"enabled,omitempty"`

	// REQUIRED; Web application firewall mode.
	FirewallMode *ApplicationGatewayFirewallMode `json:"firewallMode,omitempty"`

	// REQUIRED; The type of the web application firewall rule set. Possible values are: 'OWASP'.
	RuleSetType *string `json:"ruleSetType,omitempty"`

	// REQUIRED; The version of the rule set type.
	RuleSetVersion *string `json:"ruleSetVersion,omitempty"`

	// The disabled rule groups.
	DisabledRuleGroups []*ApplicationGatewayFirewallDisabledRuleGroup `json:"disabledRuleGroups,omitempty"`

	// The exclusion list.
	Exclusions []*ApplicationGatewayFirewallExclusion `json:"exclusions,omitempty"`

	// Maximum file upload size in Mb for WAF.
	FileUploadLimitInMb *int32 `json:"fileUploadLimitInMb,omitempty"`

	// Maximum request body size for WAF.
	MaxRequestBodySize *int32 `json:"maxRequestBodySize,omitempty"`

	// Maximum request body size in Kb for WAF.
	MaxRequestBodySizeInKb *int32 `json:"maxRequestBodySizeInKb,omitempty"`

	// Whether allow WAF to check request Body.
	RequestBodyCheck *bool `json:"requestBodyCheck,omitempty"`
}

ApplicationGatewayWebApplicationFirewallConfiguration - Application gateway web application firewall configuration.

func (ApplicationGatewayWebApplicationFirewallConfiguration) MarshalJSON 

func (a ApplicationGatewayWebApplicationFirewallConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayWebApplicationFirewallConfiguration.

type ApplicationGatewaysClient 

type ApplicationGatewaysClient struct {
	// contains filtered or unexported fields
}

ApplicationGatewaysClient contains the methods for the ApplicationGateways group. Don't use this type directly, use NewApplicationGatewaysClient() instead.

func NewApplicationGatewaysClient 

func NewApplicationGatewaysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ApplicationGatewaysClient

NewApplicationGatewaysClient creates a new instance of ApplicationGatewaysClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ApplicationGatewaysClient) BeginBackendHealth 

func (client *ApplicationGatewaysClient) BeginBackendHealth(ctx context.Context, resourceGroupName string, applicationGatewayName string, options *ApplicationGatewaysClientBeginBackendHealthOptions) (ApplicationGatewaysClientBackendHealthPollerResponse, error)

BeginBackendHealth - Gets the backend health of the specified application gateway in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. options - ApplicationGatewaysClientBeginBackendHealthOptions contains the optional parameters for the ApplicationGatewaysClient.BeginBackendHealth method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayBackendHealthGet.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginBackendHealth(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		&armnetwork.ApplicationGatewaysClientBeginBackendHealthOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewaysClientBackendHealthResult)
}

Output:

func (*ApplicationGatewaysClient) BeginBackendHealthOnDemand 

func (client *ApplicationGatewaysClient) BeginBackendHealthOnDemand(ctx context.Context, resourceGroupName string, applicationGatewayName string, probeRequest ApplicationGatewayOnDemandProbe, options *ApplicationGatewaysClientBeginBackendHealthOnDemandOptions) (ApplicationGatewaysClientBackendHealthOnDemandPollerResponse, error)

BeginBackendHealthOnDemand - Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. probeRequest - Request body for on-demand test probe operation. options - ApplicationGatewaysClientBeginBackendHealthOnDemandOptions contains the optional parameters for the ApplicationGatewaysClient.BeginBackendHealthOnDemand method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayBackendHealthTest.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginBackendHealthOnDemand(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		armnetwork.ApplicationGatewayOnDemandProbe{
			Path: to.StringPtr("<path>"),
			BackendAddressPool: &armnetwork.SubResource{
				ID: to.StringPtr("<id>"),
			},
			BackendHTTPSettings: &armnetwork.SubResource{
				ID: to.StringPtr("<id>"),
			},
			PickHostNameFromBackendHTTPSettings: to.BoolPtr(true),
			Timeout:                             to.Int32Ptr(30),
			Protocol:                            armnetwork.ApplicationGatewayProtocol("Http").ToPtr(),
		},
		&armnetwork.ApplicationGatewaysClientBeginBackendHealthOnDemandOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewaysClientBackendHealthOnDemandResult)
}

Output:

func (*ApplicationGatewaysClient) BeginCreateOrUpdate 

func (client *ApplicationGatewaysClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, applicationGatewayName string, parameters ApplicationGateway, options *ApplicationGatewaysClientBeginCreateOrUpdateOptions) (ApplicationGatewaysClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified application gateway. If the operation fails it returns an *azcore.ResponseError type. 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. options - ApplicationGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the ApplicationGatewaysClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		armnetwork.ApplicationGateway{
			Location: to.StringPtr("<location>"),
			Identity: &armnetwork.ManagedServiceIdentity{
				Type: armnetwork.ResourceIdentityTypeUserAssigned.ToPtr(),
				UserAssignedIdentities: map[string]*armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
					"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {},
				},
			},
			Properties: &armnetwork.ApplicationGatewayPropertiesFormat{
				BackendAddressPools: []*armnetwork.ApplicationGatewayBackendAddressPool{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayBackendAddressPoolPropertiesFormat{
							BackendAddresses: []*armnetwork.ApplicationGatewayBackendAddress{
								{
									IPAddress: to.StringPtr("<ipaddress>"),
								},
								{
									IPAddress: to.StringPtr("<ipaddress>"),
								}},
						},
					},
					{
						ID:   to.StringPtr("<id>"),
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayBackendAddressPoolPropertiesFormat{
							BackendAddresses: []*armnetwork.ApplicationGatewayBackendAddress{
								{},
								{}},
						},
					}},
				BackendHTTPSettingsCollection: []*armnetwork.ApplicationGatewayBackendHTTPSettings{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayBackendHTTPSettingsPropertiesFormat{
							CookieBasedAffinity: armnetwork.ApplicationGatewayCookieBasedAffinity("Disabled").ToPtr(),
							Port:                to.Int32Ptr(80),
							RequestTimeout:      to.Int32Ptr(30),
							Protocol:            armnetwork.ApplicationGatewayProtocol("Http").ToPtr(),
						},
					}},
				FrontendIPConfigurations: []*armnetwork.ApplicationGatewayFrontendIPConfiguration{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayFrontendIPConfigurationPropertiesFormat{
							PublicIPAddress: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
				FrontendPorts: []*armnetwork.ApplicationGatewayFrontendPort{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayFrontendPortPropertiesFormat{
							Port: to.Int32Ptr(443),
						},
					},
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayFrontendPortPropertiesFormat{
							Port: to.Int32Ptr(80),
						},
					}},
				GatewayIPConfigurations: []*armnetwork.ApplicationGatewayIPConfiguration{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayIPConfigurationPropertiesFormat{
							Subnet: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
				GlobalConfiguration: &armnetwork.ApplicationGatewayGlobalConfiguration{
					EnableRequestBuffering:  to.BoolPtr(true),
					EnableResponseBuffering: to.BoolPtr(true),
				},
				HTTPListeners: []*armnetwork.ApplicationGatewayHTTPListener{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayHTTPListenerPropertiesFormat{
							FrontendIPConfiguration: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							FrontendPort: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							RequireServerNameIndication: to.BoolPtr(false),
							SSLCertificate: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							SSLProfile: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							Protocol: armnetwork.ApplicationGatewayProtocol("Https").ToPtr(),
						},
					},
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayHTTPListenerPropertiesFormat{
							FrontendIPConfiguration: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							FrontendPort: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							Protocol: armnetwork.ApplicationGatewayProtocol("Http").ToPtr(),
						},
					}},
				LoadDistributionPolicies: []*armnetwork.ApplicationGatewayLoadDistributionPolicy{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayLoadDistributionPolicyPropertiesFormat{
							LoadDistributionAlgorithm: armnetwork.ApplicationGatewayLoadDistributionAlgorithm("RoundRobin").ToPtr(),
							LoadDistributionTargets: []*armnetwork.ApplicationGatewayLoadDistributionTarget{
								{
									Name: to.StringPtr("<name>"),
									Properties: &armnetwork.ApplicationGatewayLoadDistributionTargetPropertiesFormat{
										BackendAddressPool: &armnetwork.SubResource{
											ID: to.StringPtr("<id>"),
										},
										WeightPerServer: to.Int32Ptr(40),
									},
								},
								{
									Name: to.StringPtr("<name>"),
									Properties: &armnetwork.ApplicationGatewayLoadDistributionTargetPropertiesFormat{
										BackendAddressPool: &armnetwork.SubResource{
											ID: to.StringPtr("<id>"),
										},
										WeightPerServer: to.Int32Ptr(60),
									},
								}},
						},
					}},
				RequestRoutingRules: []*armnetwork.ApplicationGatewayRequestRoutingRule{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayRequestRoutingRulePropertiesFormat{
							BackendAddressPool: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							BackendHTTPSettings: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							HTTPListener: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							LoadDistributionPolicy: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							Priority: to.Int32Ptr(10),
							RewriteRuleSet: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							RuleType: armnetwork.ApplicationGatewayRequestRoutingRuleType("Basic").ToPtr(),
						},
					},
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayRequestRoutingRulePropertiesFormat{
							HTTPListener: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							Priority: to.Int32Ptr(20),
							RuleType: armnetwork.ApplicationGatewayRequestRoutingRuleType("PathBasedRouting").ToPtr(),
							URLPathMap: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
				RewriteRuleSets: []*armnetwork.ApplicationGatewayRewriteRuleSet{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayRewriteRuleSetPropertiesFormat{
							RewriteRules: []*armnetwork.ApplicationGatewayRewriteRule{
								{
									Name: to.StringPtr("<name>"),
									ActionSet: &armnetwork.ApplicationGatewayRewriteRuleActionSet{
										RequestHeaderConfigurations: []*armnetwork.ApplicationGatewayHeaderConfiguration{
											{
												HeaderName:  to.StringPtr("<header-name>"),
												HeaderValue: to.StringPtr("<header-value>"),
											}},
										ResponseHeaderConfigurations: []*armnetwork.ApplicationGatewayHeaderConfiguration{
											{
												HeaderName:  to.StringPtr("<header-name>"),
												HeaderValue: to.StringPtr("<header-value>"),
											}},
										URLConfiguration: &armnetwork.ApplicationGatewayURLConfiguration{
											ModifiedPath: to.StringPtr("<modified-path>"),
										},
									},
									Conditions: []*armnetwork.ApplicationGatewayRewriteRuleCondition{
										{
											IgnoreCase: to.BoolPtr(true),
											Negate:     to.BoolPtr(false),
											Pattern:    to.StringPtr("<pattern>"),
											Variable:   to.StringPtr("<variable>"),
										}},
									RuleSequence: to.Int32Ptr(102),
								}},
						},
					}},
				SKU: &armnetwork.ApplicationGatewaySKU{
					Name:     armnetwork.ApplicationGatewaySKUName("Standard_v2").ToPtr(),
					Capacity: to.Int32Ptr(3),
					Tier:     armnetwork.ApplicationGatewayTier("Standard_v2").ToPtr(),
				},
				SSLCertificates: []*armnetwork.ApplicationGatewaySSLCertificate{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewaySSLCertificatePropertiesFormat{
							Data:     to.StringPtr("<data>"),
							Password: to.StringPtr("<password>"),
						},
					},
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewaySSLCertificatePropertiesFormat{
							KeyVaultSecretID: to.StringPtr("<key-vault-secret-id>"),
						},
					}},
				SSLProfiles: []*armnetwork.ApplicationGatewaySSLProfile{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewaySSLProfilePropertiesFormat{
							ClientAuthConfiguration: &armnetwork.ApplicationGatewayClientAuthConfiguration{
								VerifyClientCertIssuerDN: to.BoolPtr(true),
							},
							SSLPolicy: &armnetwork.ApplicationGatewaySSLPolicy{
								CipherSuites: []*armnetwork.ApplicationGatewaySSLCipherSuite{
									armnetwork.ApplicationGatewaySSLCipherSuite("TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256").ToPtr()},
								MinProtocolVersion: armnetwork.ApplicationGatewaySSLProtocol("TLSv1_1").ToPtr(),
								PolicyType:         armnetwork.ApplicationGatewaySSLPolicyType("Custom").ToPtr(),
							},
							TrustedClientCertificates: []*armnetwork.SubResource{
								{
									ID: to.StringPtr("<id>"),
								}},
						},
					}},
				TrustedClientCertificates: []*armnetwork.ApplicationGatewayTrustedClientCertificate{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayTrustedClientCertificatePropertiesFormat{
							Data: to.StringPtr("<data>"),
						},
					}},
				TrustedRootCertificates: []*armnetwork.ApplicationGatewayTrustedRootCertificate{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayTrustedRootCertificatePropertiesFormat{
							Data: to.StringPtr("<data>"),
						},
					},
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayTrustedRootCertificatePropertiesFormat{
							KeyVaultSecretID: to.StringPtr("<key-vault-secret-id>"),
						},
					}},
				URLPathMaps: []*armnetwork.ApplicationGatewayURLPathMap{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ApplicationGatewayURLPathMapPropertiesFormat{
							DefaultBackendAddressPool: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							DefaultBackendHTTPSettings: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							DefaultLoadDistributionPolicy: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							DefaultRewriteRuleSet: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							PathRules: []*armnetwork.ApplicationGatewayPathRule{
								{
									Name: to.StringPtr("<name>"),
									Properties: &armnetwork.ApplicationGatewayPathRulePropertiesFormat{
										BackendAddressPool: &armnetwork.SubResource{
											ID: to.StringPtr("<id>"),
										},
										BackendHTTPSettings: &armnetwork.SubResource{
											ID: to.StringPtr("<id>"),
										},
										LoadDistributionPolicy: &armnetwork.SubResource{
											ID: to.StringPtr("<id>"),
										},
										Paths: []*string{
											to.StringPtr("/api"),
											to.StringPtr("/v1/api")},
										RewriteRuleSet: &armnetwork.SubResource{
											ID: to.StringPtr("<id>"),
										},
									},
								}},
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewaysClientCreateOrUpdateResult)
}

Output:

func (*ApplicationGatewaysClient) BeginDelete 

func (client *ApplicationGatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, applicationGatewayName string, options *ApplicationGatewaysClientBeginDeleteOptions) (ApplicationGatewaysClientDeletePollerResponse, error)

BeginDelete - Deletes the specified application gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. options - ApplicationGatewaysClientBeginDeleteOptions contains the optional parameters for the ApplicationGatewaysClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ApplicationGatewaysClient) BeginStart 

func (client *ApplicationGatewaysClient) BeginStart(ctx context.Context, resourceGroupName string, applicationGatewayName string, options *ApplicationGatewaysClientBeginStartOptions) (ApplicationGatewaysClientStartPollerResponse, error)

BeginStart - Starts the specified application gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. options - ApplicationGatewaysClientBeginStartOptions contains the optional parameters for the ApplicationGatewaysClient.BeginStart method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayStart.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStart(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ApplicationGatewaysClient) BeginStop 

func (client *ApplicationGatewaysClient) BeginStop(ctx context.Context, resourceGroupName string, applicationGatewayName string, options *ApplicationGatewaysClientBeginStopOptions) (ApplicationGatewaysClientStopPollerResponse, error)

BeginStop - Stops the specified application gateway in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. options - ApplicationGatewaysClientBeginStopOptions contains the optional parameters for the ApplicationGatewaysClient.BeginStop method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayStop.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStop(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ApplicationGatewaysClient) Get 

func (client *ApplicationGatewaysClient) Get(ctx context.Context, resourceGroupName string, applicationGatewayName string, options *ApplicationGatewaysClientGetOptions) (ApplicationGatewaysClientGetResponse, error)

Get - Gets the specified application gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. options - ApplicationGatewaysClientGetOptions contains the optional parameters for the ApplicationGatewaysClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewaysClientGetResult)
}

Output:

func (*ApplicationGatewaysClient) GetSSLPredefinedPolicy 

func (client *ApplicationGatewaysClient) GetSSLPredefinedPolicy(ctx context.Context, predefinedPolicyName string, options *ApplicationGatewaysClientGetSSLPredefinedPolicyOptions) (ApplicationGatewaysClientGetSSLPredefinedPolicyResponse, error)

GetSSLPredefinedPolicy - Gets Ssl predefined policy with the specified policy name. If the operation fails it returns an *azcore.ResponseError type. predefinedPolicyName - Name of Ssl predefined policy. options - ApplicationGatewaysClientGetSSLPredefinedPolicyOptions contains the optional parameters for the ApplicationGatewaysClient.GetSSLPredefinedPolicy method.

func (*ApplicationGatewaysClient) List 

func (client *ApplicationGatewaysClient) List(resourceGroupName string, options *ApplicationGatewaysClientListOptions) *ApplicationGatewaysClientListPager

List - Lists all application gateways in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - ApplicationGatewaysClientListOptions contains the optional parameters for the ApplicationGatewaysClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ApplicationGatewaysClient) ListAll 

func (client *ApplicationGatewaysClient) ListAll(options *ApplicationGatewaysClientListAllOptions) *ApplicationGatewaysClientListAllPager

ListAll - Gets all the application gateways in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ApplicationGatewaysClientListAllOptions contains the optional parameters for the ApplicationGatewaysClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ApplicationGatewaysClient) ListAvailableRequestHeaders 

func (client *ApplicationGatewaysClient) ListAvailableRequestHeaders(ctx context.Context, options *ApplicationGatewaysClientListAvailableRequestHeadersOptions) (ApplicationGatewaysClientListAvailableRequestHeadersResponse, error)

ListAvailableRequestHeaders - Lists all available request headers. If the operation fails it returns an *azcore.ResponseError type. options - ApplicationGatewaysClientListAvailableRequestHeadersOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableRequestHeaders method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.ListAvailableRequestHeaders(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewaysClientListAvailableRequestHeadersResult)
}

Output:

func (*ApplicationGatewaysClient) ListAvailableResponseHeaders 

func (client *ApplicationGatewaysClient) ListAvailableResponseHeaders(ctx context.Context, options *ApplicationGatewaysClientListAvailableResponseHeadersOptions) (ApplicationGatewaysClientListAvailableResponseHeadersResponse, error)

ListAvailableResponseHeaders - Lists all available response headers. If the operation fails it returns an *azcore.ResponseError type. options - ApplicationGatewaysClientListAvailableResponseHeadersOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableResponseHeaders method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.ListAvailableResponseHeaders(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewaysClientListAvailableResponseHeadersResult)
}

Output:

func (*ApplicationGatewaysClient) ListAvailableSSLOptions 

func (client *ApplicationGatewaysClient) ListAvailableSSLOptions(ctx context.Context, options *ApplicationGatewaysClientListAvailableSSLOptionsOptions) (ApplicationGatewaysClientListAvailableSSLOptionsResponse, error)

ListAvailableSSLOptions - Lists available Ssl options for configuring Ssl policy. If the operation fails it returns an *azcore.ResponseError type. options - ApplicationGatewaysClientListAvailableSSLOptionsOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableSSLOptions method.

func (*ApplicationGatewaysClient) ListAvailableSSLPredefinedPolicies 

func (client *ApplicationGatewaysClient) ListAvailableSSLPredefinedPolicies(options *ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesOptions) *ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesPager

ListAvailableSSLPredefinedPolicies - Lists all SSL predefined policies for configuring Ssl policy. If the operation fails it returns an *azcore.ResponseError type. options - ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableSSLPredefinedPolicies method.

func (*ApplicationGatewaysClient) ListAvailableServerVariables 

func (client *ApplicationGatewaysClient) ListAvailableServerVariables(ctx context.Context, options *ApplicationGatewaysClientListAvailableServerVariablesOptions) (ApplicationGatewaysClientListAvailableServerVariablesResponse, error)

ListAvailableServerVariables - Lists all available server variables. If the operation fails it returns an *azcore.ResponseError type. options - ApplicationGatewaysClientListAvailableServerVariablesOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableServerVariables method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayAvailableServerVariablesGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.ListAvailableServerVariables(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewaysClientListAvailableServerVariablesResult)
}

Output:

func (*ApplicationGatewaysClient) ListAvailableWafRuleSets 

func (client *ApplicationGatewaysClient) ListAvailableWafRuleSets(ctx context.Context, options *ApplicationGatewaysClientListAvailableWafRuleSetsOptions) (ApplicationGatewaysClientListAvailableWafRuleSetsResponse, error)

ListAvailableWafRuleSets - Lists all available web application firewall rule sets. If the operation fails it returns an *azcore.ResponseError type. options - ApplicationGatewaysClientListAvailableWafRuleSetsOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableWafRuleSets method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.ListAvailableWafRuleSets(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewaysClientListAvailableWafRuleSetsResult)
}

Output:

func (*ApplicationGatewaysClient) UpdateTags 

func (client *ApplicationGatewaysClient) UpdateTags(ctx context.Context, resourceGroupName string, applicationGatewayName string, parameters TagsObject, options *ApplicationGatewaysClientUpdateTagsOptions) (ApplicationGatewaysClientUpdateTagsResponse, error)

UpdateTags - Updates the specified application gateway tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationGatewayName - The name of the application gateway. parameters - Parameters supplied to update application gateway tags. options - ApplicationGatewaysClientUpdateTagsOptions contains the optional parameters for the ApplicationGatewaysClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationGatewayUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<application-gateway-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationGatewaysClientUpdateTagsResult)
}

Output:

type ApplicationGatewaysClientBackendHealthOnDemandPoller added in v0.3.0 

type ApplicationGatewaysClientBackendHealthOnDemandPoller struct {
	// contains filtered or unexported fields
}

ApplicationGatewaysClientBackendHealthOnDemandPoller provides polling facilities until the operation reaches a terminal state.

func (*ApplicationGatewaysClientBackendHealthOnDemandPoller) Done added in v0.3.0 

func (p *ApplicationGatewaysClientBackendHealthOnDemandPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ApplicationGatewaysClientBackendHealthOnDemandPoller) FinalResponse added in v0.3.0 

func (p *ApplicationGatewaysClientBackendHealthOnDemandPoller) FinalResponse(ctx context.Context) (ApplicationGatewaysClientBackendHealthOnDemandResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ApplicationGatewaysClientBackendHealthOnDemandResponse will be returned.

func (*ApplicationGatewaysClientBackendHealthOnDemandPoller) Poll added in v0.3.0 

func (p *ApplicationGatewaysClientBackendHealthOnDemandPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ApplicationGatewaysClientBackendHealthOnDemandPoller) ResumeToken added in v0.3.0 

func (p *ApplicationGatewaysClientBackendHealthOnDemandPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ApplicationGatewaysClientBackendHealthOnDemandPollerResponse added in v0.3.0 

type ApplicationGatewaysClientBackendHealthOnDemandPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ApplicationGatewaysClientBackendHealthOnDemandPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientBackendHealthOnDemandPollerResponse contains the response from method ApplicationGatewaysClient.BackendHealthOnDemand.

func (ApplicationGatewaysClientBackendHealthOnDemandPollerResponse) PollUntilDone added in v0.3.0 

func (l ApplicationGatewaysClientBackendHealthOnDemandPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ApplicationGatewaysClientBackendHealthOnDemandResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ApplicationGatewaysClientBackendHealthOnDemandPollerResponse) Resume added in v0.3.0 

func (l *ApplicationGatewaysClientBackendHealthOnDemandPollerResponse) Resume(ctx context.Context, client *ApplicationGatewaysClient, token string) error

Resume rehydrates a ApplicationGatewaysClientBackendHealthOnDemandPollerResponse from the provided client and resume token.

type ApplicationGatewaysClientBackendHealthOnDemandResponse added in v0.3.0 

type ApplicationGatewaysClientBackendHealthOnDemandResponse struct {
	ApplicationGatewaysClientBackendHealthOnDemandResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientBackendHealthOnDemandResponse contains the response from method ApplicationGatewaysClient.BackendHealthOnDemand.

type ApplicationGatewaysClientBackendHealthOnDemandResult added in v0.3.0 

type ApplicationGatewaysClientBackendHealthOnDemandResult struct {
	ApplicationGatewayBackendHealthOnDemand
}

ApplicationGatewaysClientBackendHealthOnDemandResult contains the result from method ApplicationGatewaysClient.BackendHealthOnDemand.

type ApplicationGatewaysClientBackendHealthPoller added in v0.3.0 

type ApplicationGatewaysClientBackendHealthPoller struct {
	// contains filtered or unexported fields
}

ApplicationGatewaysClientBackendHealthPoller provides polling facilities until the operation reaches a terminal state.

func (*ApplicationGatewaysClientBackendHealthPoller) Done added in v0.3.0 

func (p *ApplicationGatewaysClientBackendHealthPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ApplicationGatewaysClientBackendHealthPoller) FinalResponse added in v0.3.0 

func (p *ApplicationGatewaysClientBackendHealthPoller) FinalResponse(ctx context.Context) (ApplicationGatewaysClientBackendHealthResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ApplicationGatewaysClientBackendHealthResponse will be returned.

func (*ApplicationGatewaysClientBackendHealthPoller) Poll added in v0.3.0 

func (p *ApplicationGatewaysClientBackendHealthPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ApplicationGatewaysClientBackendHealthPoller) ResumeToken added in v0.3.0 

func (p *ApplicationGatewaysClientBackendHealthPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ApplicationGatewaysClientBackendHealthPollerResponse added in v0.3.0 

type ApplicationGatewaysClientBackendHealthPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ApplicationGatewaysClientBackendHealthPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientBackendHealthPollerResponse contains the response from method ApplicationGatewaysClient.BackendHealth.

func (ApplicationGatewaysClientBackendHealthPollerResponse) PollUntilDone added in v0.3.0 

func (l ApplicationGatewaysClientBackendHealthPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ApplicationGatewaysClientBackendHealthResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ApplicationGatewaysClientBackendHealthPollerResponse) Resume added in v0.3.0 

func (l *ApplicationGatewaysClientBackendHealthPollerResponse) Resume(ctx context.Context, client *ApplicationGatewaysClient, token string) error

Resume rehydrates a ApplicationGatewaysClientBackendHealthPollerResponse from the provided client and resume token.

type ApplicationGatewaysClientBackendHealthResponse added in v0.3.0 

type ApplicationGatewaysClientBackendHealthResponse struct {
	ApplicationGatewaysClientBackendHealthResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientBackendHealthResponse contains the response from method ApplicationGatewaysClient.BackendHealth.

type ApplicationGatewaysClientBackendHealthResult added in v0.3.0 

type ApplicationGatewaysClientBackendHealthResult struct {
	ApplicationGatewayBackendHealth
}

ApplicationGatewaysClientBackendHealthResult contains the result from method ApplicationGatewaysClient.BackendHealth.

type ApplicationGatewaysClientBeginBackendHealthOnDemandOptions added in v0.3.0 

type ApplicationGatewaysClientBeginBackendHealthOnDemandOptions struct {
	// Expands BackendAddressPool and BackendHttpSettings referenced in backend health.
	Expand *string
}

ApplicationGatewaysClientBeginBackendHealthOnDemandOptions contains the optional parameters for the ApplicationGatewaysClient.BeginBackendHealthOnDemand method.

type ApplicationGatewaysClientBeginBackendHealthOptions added in v0.3.0 

type ApplicationGatewaysClientBeginBackendHealthOptions struct {
	// Expands BackendAddressPool and BackendHttpSettings referenced in backend health.
	Expand *string
}

ApplicationGatewaysClientBeginBackendHealthOptions contains the optional parameters for the ApplicationGatewaysClient.BeginBackendHealth method.

type ApplicationGatewaysClientBeginCreateOrUpdateOptions added in v0.3.0 

type ApplicationGatewaysClientBeginCreateOrUpdateOptions struct {
}

ApplicationGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the ApplicationGatewaysClient.BeginCreateOrUpdate method.

type ApplicationGatewaysClientBeginDeleteOptions added in v0.3.0 

type ApplicationGatewaysClientBeginDeleteOptions struct {
}

ApplicationGatewaysClientBeginDeleteOptions contains the optional parameters for the ApplicationGatewaysClient.BeginDelete method.

type ApplicationGatewaysClientBeginStartOptions added in v0.3.0 

type ApplicationGatewaysClientBeginStartOptions struct {
}

ApplicationGatewaysClientBeginStartOptions contains the optional parameters for the ApplicationGatewaysClient.BeginStart method.

type ApplicationGatewaysClientBeginStopOptions added in v0.3.0 

type ApplicationGatewaysClientBeginStopOptions struct {
}

ApplicationGatewaysClientBeginStopOptions contains the optional parameters for the ApplicationGatewaysClient.BeginStop method.

type ApplicationGatewaysClientCreateOrUpdatePoller added in v0.3.0 

type ApplicationGatewaysClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ApplicationGatewaysClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ApplicationGatewaysClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ApplicationGatewaysClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ApplicationGatewaysClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ApplicationGatewaysClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ApplicationGatewaysClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ApplicationGatewaysClientCreateOrUpdateResponse will be returned.

func (*ApplicationGatewaysClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ApplicationGatewaysClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ApplicationGatewaysClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ApplicationGatewaysClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ApplicationGatewaysClientCreateOrUpdatePollerResponse added in v0.3.0 

type ApplicationGatewaysClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ApplicationGatewaysClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientCreateOrUpdatePollerResponse contains the response from method ApplicationGatewaysClient.CreateOrUpdate.

func (ApplicationGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ApplicationGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ApplicationGatewaysClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ApplicationGatewaysClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ApplicationGatewaysClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ApplicationGatewaysClient, token string) error

Resume rehydrates a ApplicationGatewaysClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ApplicationGatewaysClientCreateOrUpdateResponse added in v0.3.0 

type ApplicationGatewaysClientCreateOrUpdateResponse struct {
	ApplicationGatewaysClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientCreateOrUpdateResponse contains the response from method ApplicationGatewaysClient.CreateOrUpdate.

type ApplicationGatewaysClientCreateOrUpdateResult added in v0.3.0 

type ApplicationGatewaysClientCreateOrUpdateResult struct {
	ApplicationGateway
}

ApplicationGatewaysClientCreateOrUpdateResult contains the result from method ApplicationGatewaysClient.CreateOrUpdate.

type ApplicationGatewaysClientDeletePoller added in v0.3.0 

type ApplicationGatewaysClientDeletePoller struct {
	// contains filtered or unexported fields
}

ApplicationGatewaysClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ApplicationGatewaysClientDeletePoller) Done added in v0.3.0 

func (p *ApplicationGatewaysClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ApplicationGatewaysClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ApplicationGatewaysClientDeletePoller) FinalResponse(ctx context.Context) (ApplicationGatewaysClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ApplicationGatewaysClientDeleteResponse will be returned.

func (*ApplicationGatewaysClientDeletePoller) Poll added in v0.3.0 

func (p *ApplicationGatewaysClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ApplicationGatewaysClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ApplicationGatewaysClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ApplicationGatewaysClientDeletePollerResponse added in v0.3.0 

type ApplicationGatewaysClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ApplicationGatewaysClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientDeletePollerResponse contains the response from method ApplicationGatewaysClient.Delete.

func (ApplicationGatewaysClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ApplicationGatewaysClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ApplicationGatewaysClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ApplicationGatewaysClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ApplicationGatewaysClientDeletePollerResponse) Resume(ctx context.Context, client *ApplicationGatewaysClient, token string) error

Resume rehydrates a ApplicationGatewaysClientDeletePollerResponse from the provided client and resume token.

type ApplicationGatewaysClientDeleteResponse added in v0.3.0 

type ApplicationGatewaysClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientDeleteResponse contains the response from method ApplicationGatewaysClient.Delete.

type ApplicationGatewaysClientGetOptions added in v0.3.0 

type ApplicationGatewaysClientGetOptions struct {
}

ApplicationGatewaysClientGetOptions contains the optional parameters for the ApplicationGatewaysClient.Get method.

type ApplicationGatewaysClientGetResponse added in v0.3.0 

type ApplicationGatewaysClientGetResponse struct {
	ApplicationGatewaysClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientGetResponse contains the response from method ApplicationGatewaysClient.Get.

type ApplicationGatewaysClientGetResult added in v0.3.0 

type ApplicationGatewaysClientGetResult struct {
	ApplicationGateway
}

ApplicationGatewaysClientGetResult contains the result from method ApplicationGatewaysClient.Get.

type ApplicationGatewaysClientGetSSLPredefinedPolicyOptions added in v0.3.0 

type ApplicationGatewaysClientGetSSLPredefinedPolicyOptions struct {
}

ApplicationGatewaysClientGetSSLPredefinedPolicyOptions contains the optional parameters for the ApplicationGatewaysClient.GetSSLPredefinedPolicy method.

type ApplicationGatewaysClientGetSSLPredefinedPolicyResponse added in v0.3.0 

type ApplicationGatewaysClientGetSSLPredefinedPolicyResponse struct {
	ApplicationGatewaysClientGetSSLPredefinedPolicyResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientGetSSLPredefinedPolicyResponse contains the response from method ApplicationGatewaysClient.GetSSLPredefinedPolicy.

type ApplicationGatewaysClientGetSSLPredefinedPolicyResult added in v0.3.0 

type ApplicationGatewaysClientGetSSLPredefinedPolicyResult struct {
	ApplicationGatewaySSLPredefinedPolicy
}

ApplicationGatewaysClientGetSSLPredefinedPolicyResult contains the result from method ApplicationGatewaysClient.GetSSLPredefinedPolicy.

type ApplicationGatewaysClientListAllOptions added in v0.3.0 

type ApplicationGatewaysClientListAllOptions struct {
}

ApplicationGatewaysClientListAllOptions contains the optional parameters for the ApplicationGatewaysClient.ListAll method.

type ApplicationGatewaysClientListAllPager added in v0.3.0 

type ApplicationGatewaysClientListAllPager struct {
	// contains filtered or unexported fields
}

ApplicationGatewaysClientListAllPager provides operations for iterating over paged responses.

func (*ApplicationGatewaysClientListAllPager) Err added in v0.3.0 

func (p *ApplicationGatewaysClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*ApplicationGatewaysClientListAllPager) NextPage added in v0.3.0 

func (p *ApplicationGatewaysClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ApplicationGatewaysClientListAllPager) PageResponse added in v0.3.0 

func (p *ApplicationGatewaysClientListAllPager) PageResponse() ApplicationGatewaysClientListAllResponse

PageResponse returns the current ApplicationGatewaysClientListAllResponse page.

type ApplicationGatewaysClientListAllResponse added in v0.3.0 

type ApplicationGatewaysClientListAllResponse struct {
	ApplicationGatewaysClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientListAllResponse contains the response from method ApplicationGatewaysClient.ListAll.

type ApplicationGatewaysClientListAllResult added in v0.3.0 

type ApplicationGatewaysClientListAllResult struct {
	ApplicationGatewayListResult
}

ApplicationGatewaysClientListAllResult contains the result from method ApplicationGatewaysClient.ListAll.

type ApplicationGatewaysClientListAvailableRequestHeadersOptions added in v0.3.0 

type ApplicationGatewaysClientListAvailableRequestHeadersOptions struct {
}

ApplicationGatewaysClientListAvailableRequestHeadersOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableRequestHeaders method.

type ApplicationGatewaysClientListAvailableRequestHeadersResponse added in v0.3.0 

type ApplicationGatewaysClientListAvailableRequestHeadersResponse struct {
	ApplicationGatewaysClientListAvailableRequestHeadersResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientListAvailableRequestHeadersResponse contains the response from method ApplicationGatewaysClient.ListAvailableRequestHeaders.

type ApplicationGatewaysClientListAvailableRequestHeadersResult added in v0.3.0 

type ApplicationGatewaysClientListAvailableRequestHeadersResult struct {
	// Response for ApplicationGatewayAvailableRequestHeaders API service call.
	StringArray []*string
}

ApplicationGatewaysClientListAvailableRequestHeadersResult contains the result from method ApplicationGatewaysClient.ListAvailableRequestHeaders.

type ApplicationGatewaysClientListAvailableResponseHeadersOptions added in v0.3.0 

type ApplicationGatewaysClientListAvailableResponseHeadersOptions struct {
}

ApplicationGatewaysClientListAvailableResponseHeadersOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableResponseHeaders method.

type ApplicationGatewaysClientListAvailableResponseHeadersResponse added in v0.3.0 

type ApplicationGatewaysClientListAvailableResponseHeadersResponse struct {
	ApplicationGatewaysClientListAvailableResponseHeadersResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientListAvailableResponseHeadersResponse contains the response from method ApplicationGatewaysClient.ListAvailableResponseHeaders.

type ApplicationGatewaysClientListAvailableResponseHeadersResult added in v0.3.0 

type ApplicationGatewaysClientListAvailableResponseHeadersResult struct {
	// Response for ApplicationGatewayAvailableResponseHeaders API service call.
	StringArray []*string
}

ApplicationGatewaysClientListAvailableResponseHeadersResult contains the result from method ApplicationGatewaysClient.ListAvailableResponseHeaders.

type ApplicationGatewaysClientListAvailableSSLOptionsOptions added in v0.3.0 

type ApplicationGatewaysClientListAvailableSSLOptionsOptions struct {
}

ApplicationGatewaysClientListAvailableSSLOptionsOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableSSLOptions method.

type ApplicationGatewaysClientListAvailableSSLOptionsResponse added in v0.3.0 

type ApplicationGatewaysClientListAvailableSSLOptionsResponse struct {
	ApplicationGatewaysClientListAvailableSSLOptionsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientListAvailableSSLOptionsResponse contains the response from method ApplicationGatewaysClient.ListAvailableSSLOptions.

type ApplicationGatewaysClientListAvailableSSLOptionsResult added in v0.3.0 

type ApplicationGatewaysClientListAvailableSSLOptionsResult struct {
	ApplicationGatewayAvailableSSLOptions
}

ApplicationGatewaysClientListAvailableSSLOptionsResult contains the result from method ApplicationGatewaysClient.ListAvailableSSLOptions.

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesOptions added in v0.3.0 

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesOptions struct {
}

ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableSSLPredefinedPolicies method.

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesPager added in v0.3.0 

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesPager struct {
	// contains filtered or unexported fields
}

ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesPager provides operations for iterating over paged responses.

func (*ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesPager) Err added in v0.3.0 

func (p *ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesPager) Err() error

Err returns the last error encountered while paging.

func (*ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesPager) NextPage added in v0.3.0 

func (p *ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesPager) PageResponse added in v0.3.0 

func (p *ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesPager) PageResponse() ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResponse

PageResponse returns the current ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResponse page.

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResponse added in v0.3.0 

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResponse struct {
	ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResponse contains the response from method ApplicationGatewaysClient.ListAvailableSSLPredefinedPolicies.

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResult added in v0.3.0 

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResult struct {
	ApplicationGatewayAvailableSSLPredefinedPolicies
}

ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResult contains the result from method ApplicationGatewaysClient.ListAvailableSSLPredefinedPolicies.

type ApplicationGatewaysClientListAvailableServerVariablesOptions added in v0.3.0 

type ApplicationGatewaysClientListAvailableServerVariablesOptions struct {
}

ApplicationGatewaysClientListAvailableServerVariablesOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableServerVariables method.

type ApplicationGatewaysClientListAvailableServerVariablesResponse added in v0.3.0 

type ApplicationGatewaysClientListAvailableServerVariablesResponse struct {
	ApplicationGatewaysClientListAvailableServerVariablesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientListAvailableServerVariablesResponse contains the response from method ApplicationGatewaysClient.ListAvailableServerVariables.

type ApplicationGatewaysClientListAvailableServerVariablesResult added in v0.3.0 

type ApplicationGatewaysClientListAvailableServerVariablesResult struct {
	// Response for ApplicationGatewayAvailableServerVariables API service call.
	StringArray []*string
}

ApplicationGatewaysClientListAvailableServerVariablesResult contains the result from method ApplicationGatewaysClient.ListAvailableServerVariables.

type ApplicationGatewaysClientListAvailableWafRuleSetsOptions added in v0.3.0 

type ApplicationGatewaysClientListAvailableWafRuleSetsOptions struct {
}

ApplicationGatewaysClientListAvailableWafRuleSetsOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableWafRuleSets method.

type ApplicationGatewaysClientListAvailableWafRuleSetsResponse added in v0.3.0 

type ApplicationGatewaysClientListAvailableWafRuleSetsResponse struct {
	ApplicationGatewaysClientListAvailableWafRuleSetsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientListAvailableWafRuleSetsResponse contains the response from method ApplicationGatewaysClient.ListAvailableWafRuleSets.

type ApplicationGatewaysClientListAvailableWafRuleSetsResult added in v0.3.0 

type ApplicationGatewaysClientListAvailableWafRuleSetsResult struct {
	ApplicationGatewayAvailableWafRuleSetsResult
}

ApplicationGatewaysClientListAvailableWafRuleSetsResult contains the result from method ApplicationGatewaysClient.ListAvailableWafRuleSets.

type ApplicationGatewaysClientListOptions added in v0.3.0 

type ApplicationGatewaysClientListOptions struct {
}

ApplicationGatewaysClientListOptions contains the optional parameters for the ApplicationGatewaysClient.List method.

type ApplicationGatewaysClientListPager added in v0.3.0 

type ApplicationGatewaysClientListPager struct {
	// contains filtered or unexported fields
}

ApplicationGatewaysClientListPager provides operations for iterating over paged responses.

func (*ApplicationGatewaysClientListPager) Err added in v0.3.0 

func (p *ApplicationGatewaysClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ApplicationGatewaysClientListPager) NextPage added in v0.3.0 

func (p *ApplicationGatewaysClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ApplicationGatewaysClientListPager) PageResponse added in v0.3.0 

func (p *ApplicationGatewaysClientListPager) PageResponse() ApplicationGatewaysClientListResponse

PageResponse returns the current ApplicationGatewaysClientListResponse page.

type ApplicationGatewaysClientListResponse added in v0.3.0 

type ApplicationGatewaysClientListResponse struct {
	ApplicationGatewaysClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientListResponse contains the response from method ApplicationGatewaysClient.List.

type ApplicationGatewaysClientListResult added in v0.3.0 

type ApplicationGatewaysClientListResult struct {
	ApplicationGatewayListResult
}

ApplicationGatewaysClientListResult contains the result from method ApplicationGatewaysClient.List.

type ApplicationGatewaysClientStartPoller added in v0.3.0 

type ApplicationGatewaysClientStartPoller struct {
	// contains filtered or unexported fields
}

ApplicationGatewaysClientStartPoller provides polling facilities until the operation reaches a terminal state.

func (*ApplicationGatewaysClientStartPoller) Done added in v0.3.0 

func (p *ApplicationGatewaysClientStartPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ApplicationGatewaysClientStartPoller) FinalResponse added in v0.3.0 

func (p *ApplicationGatewaysClientStartPoller) FinalResponse(ctx context.Context) (ApplicationGatewaysClientStartResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ApplicationGatewaysClientStartResponse will be returned.

func (*ApplicationGatewaysClientStartPoller) Poll added in v0.3.0 

func (p *ApplicationGatewaysClientStartPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ApplicationGatewaysClientStartPoller) ResumeToken added in v0.3.0 

func (p *ApplicationGatewaysClientStartPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ApplicationGatewaysClientStartPollerResponse added in v0.3.0 

type ApplicationGatewaysClientStartPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ApplicationGatewaysClientStartPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientStartPollerResponse contains the response from method ApplicationGatewaysClient.Start.

func (ApplicationGatewaysClientStartPollerResponse) PollUntilDone added in v0.3.0 

func (l ApplicationGatewaysClientStartPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ApplicationGatewaysClientStartResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ApplicationGatewaysClientStartPollerResponse) Resume added in v0.3.0 

func (l *ApplicationGatewaysClientStartPollerResponse) Resume(ctx context.Context, client *ApplicationGatewaysClient, token string) error

Resume rehydrates a ApplicationGatewaysClientStartPollerResponse from the provided client and resume token.

type ApplicationGatewaysClientStartResponse added in v0.3.0 

type ApplicationGatewaysClientStartResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientStartResponse contains the response from method ApplicationGatewaysClient.Start.

type ApplicationGatewaysClientStopPoller added in v0.3.0 

type ApplicationGatewaysClientStopPoller struct {
	// contains filtered or unexported fields
}

ApplicationGatewaysClientStopPoller provides polling facilities until the operation reaches a terminal state.

func (*ApplicationGatewaysClientStopPoller) Done added in v0.3.0 

func (p *ApplicationGatewaysClientStopPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ApplicationGatewaysClientStopPoller) FinalResponse added in v0.3.0 

func (p *ApplicationGatewaysClientStopPoller) FinalResponse(ctx context.Context) (ApplicationGatewaysClientStopResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ApplicationGatewaysClientStopResponse will be returned.

func (*ApplicationGatewaysClientStopPoller) Poll added in v0.3.0 

func (p *ApplicationGatewaysClientStopPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ApplicationGatewaysClientStopPoller) ResumeToken added in v0.3.0 

func (p *ApplicationGatewaysClientStopPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ApplicationGatewaysClientStopPollerResponse added in v0.3.0 

type ApplicationGatewaysClientStopPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ApplicationGatewaysClientStopPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientStopPollerResponse contains the response from method ApplicationGatewaysClient.Stop.

func (ApplicationGatewaysClientStopPollerResponse) PollUntilDone added in v0.3.0 

func (l ApplicationGatewaysClientStopPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ApplicationGatewaysClientStopResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ApplicationGatewaysClientStopPollerResponse) Resume added in v0.3.0 

func (l *ApplicationGatewaysClientStopPollerResponse) Resume(ctx context.Context, client *ApplicationGatewaysClient, token string) error

Resume rehydrates a ApplicationGatewaysClientStopPollerResponse from the provided client and resume token.

type ApplicationGatewaysClientStopResponse added in v0.3.0 

type ApplicationGatewaysClientStopResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientStopResponse contains the response from method ApplicationGatewaysClient.Stop.

type ApplicationGatewaysClientUpdateTagsOptions added in v0.3.0 

type ApplicationGatewaysClientUpdateTagsOptions struct {
}

ApplicationGatewaysClientUpdateTagsOptions contains the optional parameters for the ApplicationGatewaysClient.UpdateTags method.

type ApplicationGatewaysClientUpdateTagsResponse added in v0.3.0 

type ApplicationGatewaysClientUpdateTagsResponse struct {
	ApplicationGatewaysClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationGatewaysClientUpdateTagsResponse contains the response from method ApplicationGatewaysClient.UpdateTags.

type ApplicationGatewaysClientUpdateTagsResult added in v0.3.0 

type ApplicationGatewaysClientUpdateTagsResult struct {
	ApplicationGateway
}

ApplicationGatewaysClientUpdateTagsResult contains the result from method ApplicationGatewaysClient.UpdateTags.

type ApplicationRule 

type ApplicationRule struct {
	// REQUIRED; Rule Type.
	RuleType *FirewallPolicyRuleType `json:"ruleType,omitempty"`

	// Description of the rule.
	Description *string `json:"description,omitempty"`

	// List of destination IP addresses or Service Tags.
	DestinationAddresses []*string `json:"destinationAddresses,omitempty"`

	// List of FQDN Tags for this rule.
	FqdnTags []*string `json:"fqdnTags,omitempty"`

	// Name of the rule.
	Name *string `json:"name,omitempty"`

	// Array of Application Protocols.
	Protocols []*FirewallPolicyRuleApplicationProtocol `json:"protocols,omitempty"`

	// List of source IP addresses for this rule.
	SourceAddresses []*string `json:"sourceAddresses,omitempty"`

	// List of source IpGroups for this rule.
	SourceIPGroups []*string `json:"sourceIpGroups,omitempty"`

	// List of FQDNs for this rule.
	TargetFqdns []*string `json:"targetFqdns,omitempty"`

	// List of Urls for this rule condition.
	TargetUrls []*string `json:"targetUrls,omitempty"`

	// Terminate TLS connections for this rule.
	TerminateTLS *bool `json:"terminateTLS,omitempty"`

	// List of destination azure web categories.
	WebCategories []*string `json:"webCategories,omitempty"`
}

ApplicationRule - Rule of type application.

func (*ApplicationRule) GetFirewallPolicyRule added in v0.3.0 

func (a *ApplicationRule) GetFirewallPolicyRule() *FirewallPolicyRule

GetFirewallPolicyRule implements the FirewallPolicyRuleClassification interface for type ApplicationRule.

func (ApplicationRule) MarshalJSON 

func (a ApplicationRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationRule.

func (*ApplicationRule) UnmarshalJSON 

func (a *ApplicationRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationRule.

type ApplicationSecurityGroup 

type ApplicationSecurityGroup struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the application security group.
	Properties *ApplicationSecurityGroupPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ApplicationSecurityGroup - An application security group in a resource group.

func (ApplicationSecurityGroup) MarshalJSON 

func (a ApplicationSecurityGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationSecurityGroup.

type ApplicationSecurityGroupListResult 

type ApplicationSecurityGroupListResult struct {
	// A list of application security groups.
	Value []*ApplicationSecurityGroup `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ApplicationSecurityGroupListResult - A list of application security groups.

func (ApplicationSecurityGroupListResult) MarshalJSON 

func (a ApplicationSecurityGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationSecurityGroupListResult.

type ApplicationSecurityGroupPropertiesFormat 

type ApplicationSecurityGroupPropertiesFormat struct {
	// READ-ONLY; The provisioning state of the application security group resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the application security group resource. It uniquely identifies a resource, even
	// if the user changes its name or migrate the resource across subscriptions or resource
	// groups.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

ApplicationSecurityGroupPropertiesFormat - Application security group properties.

type ApplicationSecurityGroupsClient 

type ApplicationSecurityGroupsClient struct {
	// contains filtered or unexported fields
}

ApplicationSecurityGroupsClient contains the methods for the ApplicationSecurityGroups group. Don't use this type directly, use NewApplicationSecurityGroupsClient() instead.

func NewApplicationSecurityGroupsClient 

func NewApplicationSecurityGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ApplicationSecurityGroupsClient

NewApplicationSecurityGroupsClient creates a new instance of ApplicationSecurityGroupsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ApplicationSecurityGroupsClient) BeginCreateOrUpdate 

func (client *ApplicationSecurityGroupsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, applicationSecurityGroupName string, parameters ApplicationSecurityGroup, options *ApplicationSecurityGroupsClientBeginCreateOrUpdateOptions) (ApplicationSecurityGroupsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates an application security group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationSecurityGroupName - The name of the application security group. parameters - Parameters supplied to the create or update ApplicationSecurityGroup operation. options - ApplicationSecurityGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the ApplicationSecurityGroupsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationSecurityGroupCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationSecurityGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<application-security-group-name>",
		armnetwork.ApplicationSecurityGroup{
			Location:   to.StringPtr("<location>"),
			Properties: &armnetwork.ApplicationSecurityGroupPropertiesFormat{},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationSecurityGroupsClientCreateOrUpdateResult)
}

Output:

func (*ApplicationSecurityGroupsClient) BeginDelete 

func (client *ApplicationSecurityGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, applicationSecurityGroupName string, options *ApplicationSecurityGroupsClientBeginDeleteOptions) (ApplicationSecurityGroupsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified application security group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationSecurityGroupName - The name of the application security group. options - ApplicationSecurityGroupsClientBeginDeleteOptions contains the optional parameters for the ApplicationSecurityGroupsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationSecurityGroupDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationSecurityGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<application-security-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ApplicationSecurityGroupsClient) Get 

func (client *ApplicationSecurityGroupsClient) Get(ctx context.Context, resourceGroupName string, applicationSecurityGroupName string, options *ApplicationSecurityGroupsClientGetOptions) (ApplicationSecurityGroupsClientGetResponse, error)

Get - Gets information about the specified application security group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationSecurityGroupName - The name of the application security group. options - ApplicationSecurityGroupsClientGetOptions contains the optional parameters for the ApplicationSecurityGroupsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationSecurityGroupGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationSecurityGroupsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<application-security-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationSecurityGroupsClientGetResult)
}

Output:

func (*ApplicationSecurityGroupsClient) List 

func (client *ApplicationSecurityGroupsClient) List(resourceGroupName string, options *ApplicationSecurityGroupsClientListOptions) *ApplicationSecurityGroupsClientListPager

List - Gets all the application security groups in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - ApplicationSecurityGroupsClientListOptions contains the optional parameters for the ApplicationSecurityGroupsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationSecurityGroupList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationSecurityGroupsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ApplicationSecurityGroupsClient) ListAll 

func (client *ApplicationSecurityGroupsClient) ListAll(options *ApplicationSecurityGroupsClientListAllOptions) *ApplicationSecurityGroupsClientListAllPager

ListAll - Gets all application security groups in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ApplicationSecurityGroupsClientListAllOptions contains the optional parameters for the ApplicationSecurityGroupsClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationSecurityGroupListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationSecurityGroupsClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ApplicationSecurityGroupsClient) UpdateTags 

func (client *ApplicationSecurityGroupsClient) UpdateTags(ctx context.Context, resourceGroupName string, applicationSecurityGroupName string, parameters TagsObject, options *ApplicationSecurityGroupsClientUpdateTagsOptions) (ApplicationSecurityGroupsClientUpdateTagsResponse, error)

UpdateTags - Updates an application security group's tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. applicationSecurityGroupName - The name of the application security group. parameters - Parameters supplied to update application security group tags. options - ApplicationSecurityGroupsClientUpdateTagsOptions contains the optional parameters for the ApplicationSecurityGroupsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ApplicationSecurityGroupUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewApplicationSecurityGroupsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<application-security-group-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ApplicationSecurityGroupsClientUpdateTagsResult)
}

Output:

type ApplicationSecurityGroupsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ApplicationSecurityGroupsClientBeginCreateOrUpdateOptions struct {
}

ApplicationSecurityGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the ApplicationSecurityGroupsClient.BeginCreateOrUpdate method.

type ApplicationSecurityGroupsClientBeginDeleteOptions added in v0.3.0 

type ApplicationSecurityGroupsClientBeginDeleteOptions struct {
}

ApplicationSecurityGroupsClientBeginDeleteOptions contains the optional parameters for the ApplicationSecurityGroupsClient.BeginDelete method.

type ApplicationSecurityGroupsClientCreateOrUpdatePoller added in v0.3.0 

type ApplicationSecurityGroupsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ApplicationSecurityGroupsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ApplicationSecurityGroupsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ApplicationSecurityGroupsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ApplicationSecurityGroupsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ApplicationSecurityGroupsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ApplicationSecurityGroupsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ApplicationSecurityGroupsClientCreateOrUpdateResponse will be returned.

func (*ApplicationSecurityGroupsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ApplicationSecurityGroupsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ApplicationSecurityGroupsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ApplicationSecurityGroupsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ApplicationSecurityGroupsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ApplicationSecurityGroupsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ApplicationSecurityGroupsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationSecurityGroupsClientCreateOrUpdatePollerResponse contains the response from method ApplicationSecurityGroupsClient.CreateOrUpdate.

func (ApplicationSecurityGroupsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ApplicationSecurityGroupsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ApplicationSecurityGroupsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ApplicationSecurityGroupsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ApplicationSecurityGroupsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ApplicationSecurityGroupsClient, token string) error

Resume rehydrates a ApplicationSecurityGroupsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ApplicationSecurityGroupsClientCreateOrUpdateResponse added in v0.3.0 

type ApplicationSecurityGroupsClientCreateOrUpdateResponse struct {
	ApplicationSecurityGroupsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationSecurityGroupsClientCreateOrUpdateResponse contains the response from method ApplicationSecurityGroupsClient.CreateOrUpdate.

type ApplicationSecurityGroupsClientCreateOrUpdateResult added in v0.3.0 

type ApplicationSecurityGroupsClientCreateOrUpdateResult struct {
	ApplicationSecurityGroup
}

ApplicationSecurityGroupsClientCreateOrUpdateResult contains the result from method ApplicationSecurityGroupsClient.CreateOrUpdate.

type ApplicationSecurityGroupsClientDeletePoller added in v0.3.0 

type ApplicationSecurityGroupsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ApplicationSecurityGroupsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ApplicationSecurityGroupsClientDeletePoller) Done added in v0.3.0 

func (p *ApplicationSecurityGroupsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ApplicationSecurityGroupsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ApplicationSecurityGroupsClientDeletePoller) FinalResponse(ctx context.Context) (ApplicationSecurityGroupsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ApplicationSecurityGroupsClientDeleteResponse will be returned.

func (*ApplicationSecurityGroupsClientDeletePoller) Poll added in v0.3.0 

func (p *ApplicationSecurityGroupsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ApplicationSecurityGroupsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ApplicationSecurityGroupsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ApplicationSecurityGroupsClientDeletePollerResponse added in v0.3.0 

type ApplicationSecurityGroupsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ApplicationSecurityGroupsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationSecurityGroupsClientDeletePollerResponse contains the response from method ApplicationSecurityGroupsClient.Delete.

func (ApplicationSecurityGroupsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ApplicationSecurityGroupsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ApplicationSecurityGroupsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ApplicationSecurityGroupsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ApplicationSecurityGroupsClientDeletePollerResponse) Resume(ctx context.Context, client *ApplicationSecurityGroupsClient, token string) error

Resume rehydrates a ApplicationSecurityGroupsClientDeletePollerResponse from the provided client and resume token.

type ApplicationSecurityGroupsClientDeleteResponse added in v0.3.0 

type ApplicationSecurityGroupsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationSecurityGroupsClientDeleteResponse contains the response from method ApplicationSecurityGroupsClient.Delete.

type ApplicationSecurityGroupsClientGetOptions added in v0.3.0 

type ApplicationSecurityGroupsClientGetOptions struct {
}

ApplicationSecurityGroupsClientGetOptions contains the optional parameters for the ApplicationSecurityGroupsClient.Get method.

type ApplicationSecurityGroupsClientGetResponse added in v0.3.0 

type ApplicationSecurityGroupsClientGetResponse struct {
	ApplicationSecurityGroupsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationSecurityGroupsClientGetResponse contains the response from method ApplicationSecurityGroupsClient.Get.

type ApplicationSecurityGroupsClientGetResult added in v0.3.0 

type ApplicationSecurityGroupsClientGetResult struct {
	ApplicationSecurityGroup
}

ApplicationSecurityGroupsClientGetResult contains the result from method ApplicationSecurityGroupsClient.Get.

type ApplicationSecurityGroupsClientListAllOptions added in v0.3.0 

type ApplicationSecurityGroupsClientListAllOptions struct {
}

ApplicationSecurityGroupsClientListAllOptions contains the optional parameters for the ApplicationSecurityGroupsClient.ListAll method.

type ApplicationSecurityGroupsClientListAllPager added in v0.3.0 

type ApplicationSecurityGroupsClientListAllPager struct {
	// contains filtered or unexported fields
}

ApplicationSecurityGroupsClientListAllPager provides operations for iterating over paged responses.

func (*ApplicationSecurityGroupsClientListAllPager) Err added in v0.3.0 

func (p *ApplicationSecurityGroupsClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*ApplicationSecurityGroupsClientListAllPager) NextPage added in v0.3.0 

func (p *ApplicationSecurityGroupsClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ApplicationSecurityGroupsClientListAllPager) PageResponse added in v0.3.0 

func (p *ApplicationSecurityGroupsClientListAllPager) PageResponse() ApplicationSecurityGroupsClientListAllResponse

PageResponse returns the current ApplicationSecurityGroupsClientListAllResponse page.

type ApplicationSecurityGroupsClientListAllResponse added in v0.3.0 

type ApplicationSecurityGroupsClientListAllResponse struct {
	ApplicationSecurityGroupsClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationSecurityGroupsClientListAllResponse contains the response from method ApplicationSecurityGroupsClient.ListAll.

type ApplicationSecurityGroupsClientListAllResult added in v0.3.0 

type ApplicationSecurityGroupsClientListAllResult struct {
	ApplicationSecurityGroupListResult
}

ApplicationSecurityGroupsClientListAllResult contains the result from method ApplicationSecurityGroupsClient.ListAll.

type ApplicationSecurityGroupsClientListOptions added in v0.3.0 

type ApplicationSecurityGroupsClientListOptions struct {
}

ApplicationSecurityGroupsClientListOptions contains the optional parameters for the ApplicationSecurityGroupsClient.List method.

type ApplicationSecurityGroupsClientListPager added in v0.3.0 

type ApplicationSecurityGroupsClientListPager struct {
	// contains filtered or unexported fields
}

ApplicationSecurityGroupsClientListPager provides operations for iterating over paged responses.

func (*ApplicationSecurityGroupsClientListPager) Err added in v0.3.0 

func (p *ApplicationSecurityGroupsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ApplicationSecurityGroupsClientListPager) NextPage added in v0.3.0 

func (p *ApplicationSecurityGroupsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ApplicationSecurityGroupsClientListPager) PageResponse added in v0.3.0 

func (p *ApplicationSecurityGroupsClientListPager) PageResponse() ApplicationSecurityGroupsClientListResponse

PageResponse returns the current ApplicationSecurityGroupsClientListResponse page.

type ApplicationSecurityGroupsClientListResponse added in v0.3.0 

type ApplicationSecurityGroupsClientListResponse struct {
	ApplicationSecurityGroupsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationSecurityGroupsClientListResponse contains the response from method ApplicationSecurityGroupsClient.List.

type ApplicationSecurityGroupsClientListResult added in v0.3.0 

type ApplicationSecurityGroupsClientListResult struct {
	ApplicationSecurityGroupListResult
}

ApplicationSecurityGroupsClientListResult contains the result from method ApplicationSecurityGroupsClient.List.

type ApplicationSecurityGroupsClientUpdateTagsOptions added in v0.3.0 

type ApplicationSecurityGroupsClientUpdateTagsOptions struct {
}

ApplicationSecurityGroupsClientUpdateTagsOptions contains the optional parameters for the ApplicationSecurityGroupsClient.UpdateTags method.

type ApplicationSecurityGroupsClientUpdateTagsResponse added in v0.3.0 

type ApplicationSecurityGroupsClientUpdateTagsResponse struct {
	ApplicationSecurityGroupsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ApplicationSecurityGroupsClientUpdateTagsResponse contains the response from method ApplicationSecurityGroupsClient.UpdateTags.

type ApplicationSecurityGroupsClientUpdateTagsResult added in v0.3.0 

type ApplicationSecurityGroupsClientUpdateTagsResult struct {
	ApplicationSecurityGroup
}

ApplicationSecurityGroupsClientUpdateTagsResult contains the result from method ApplicationSecurityGroupsClient.UpdateTags.

type AssociationType 

type AssociationType string

AssociationType - The association type of the child resource to the parent resource. 

const (
	AssociationTypeAssociated AssociationType = "Associated"
	AssociationTypeContains   AssociationType = "Contains"
)

func PossibleAssociationTypeValues 

func PossibleAssociationTypeValues() []AssociationType

PossibleAssociationTypeValues returns the possible values for the AssociationType const type.

func (AssociationType) ToPtr 

func (c AssociationType) ToPtr() *AssociationType

ToPtr returns a *AssociationType pointing to the current value.

type AuthenticationMethod 

type AuthenticationMethod string

AuthenticationMethod - VPN client authentication method. 

const (
	AuthenticationMethodEAPMSCHAPv2 AuthenticationMethod = "EAPMSCHAPv2"
	AuthenticationMethodEAPTLS      AuthenticationMethod = "EAPTLS"
)

func PossibleAuthenticationMethodValues 

func PossibleAuthenticationMethodValues() []AuthenticationMethod

PossibleAuthenticationMethodValues returns the possible values for the AuthenticationMethod const type.

func (AuthenticationMethod) ToPtr 

func (c AuthenticationMethod) ToPtr() *AuthenticationMethod

ToPtr returns a *AuthenticationMethod pointing to the current value.

type AuthorizationListResult 

type AuthorizationListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The authorizations in an ExpressRoute Circuit.
	Value []*ExpressRouteCircuitAuthorization `json:"value,omitempty"`
}

AuthorizationListResult - Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit.

func (AuthorizationListResult) MarshalJSON 

func (a AuthorizationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizationListResult.

type AuthorizationPropertiesFormat 

type AuthorizationPropertiesFormat struct {
	// The authorization key.
	AuthorizationKey *string `json:"authorizationKey,omitempty"`

	// The authorization use status.
	AuthorizationUseStatus *AuthorizationUseStatus `json:"authorizationUseStatus,omitempty"`

	// READ-ONLY; The provisioning state of the authorization resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AuthorizationPropertiesFormat - Properties of ExpressRouteCircuitAuthorization.

type AuthorizationUseStatus 

type AuthorizationUseStatus string

AuthorizationUseStatus - The authorization use status. 

const (
	AuthorizationUseStatusAvailable AuthorizationUseStatus = "Available"
	AuthorizationUseStatusInUse     AuthorizationUseStatus = "InUse"
)

func PossibleAuthorizationUseStatusValues 

func PossibleAuthorizationUseStatusValues() []AuthorizationUseStatus

PossibleAuthorizationUseStatusValues returns the possible values for the AuthorizationUseStatus const type.

func (AuthorizationUseStatus) ToPtr 

func (c AuthorizationUseStatus) ToPtr() *AuthorizationUseStatus

ToPtr returns a *AuthorizationUseStatus pointing to the current value.

type AutoApprovedPrivateLinkService 

type AutoApprovedPrivateLinkService struct {
	// The id of the private link service resource.
	PrivateLinkService *string `json:"privateLinkService,omitempty"`
}

AutoApprovedPrivateLinkService - The information of an AutoApprovedPrivateLinkService.

type AutoApprovedPrivateLinkServicesResult 

type AutoApprovedPrivateLinkServicesResult struct {
	// An array of auto approved private link service.
	Value []*AutoApprovedPrivateLinkService `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

AutoApprovedPrivateLinkServicesResult - An array of private link service id that can be linked to a private end point with auto approved.

func (AutoApprovedPrivateLinkServicesResult) MarshalJSON 

func (a AutoApprovedPrivateLinkServicesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AutoApprovedPrivateLinkServicesResult.

type Availability 

type Availability struct {
	// Duration of the availability blob.
	BlobDuration *string `json:"blobDuration,omitempty"`

	// The retention of the availability.
	Retention *string `json:"retention,omitempty"`

	// The time grain of the availability.
	TimeGrain *string `json:"timeGrain,omitempty"`
}

Availability of the metric.

type AvailableDelegation 

type AvailableDelegation struct {
	// The actions permitted to the service upon delegation.
	Actions []*string `json:"actions,omitempty"`

	// A unique identifier of the AvailableDelegation resource.
	ID *string `json:"id,omitempty"`

	// The name of the AvailableDelegation resource.
	Name *string `json:"name,omitempty"`

	// The name of the service and resource.
	ServiceName *string `json:"serviceName,omitempty"`

	// Resource type.
	Type *string `json:"type,omitempty"`
}

AvailableDelegation - The serviceName of an AvailableDelegation indicates a possible delegation for a subnet.

func (AvailableDelegation) MarshalJSON 

func (a AvailableDelegation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableDelegation.

type AvailableDelegationsClient 

type AvailableDelegationsClient struct {
	// contains filtered or unexported fields
}

AvailableDelegationsClient contains the methods for the AvailableDelegations group. Don't use this type directly, use NewAvailableDelegationsClient() instead.

func NewAvailableDelegationsClient 

func NewAvailableDelegationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AvailableDelegationsClient

NewAvailableDelegationsClient creates a new instance of AvailableDelegationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AvailableDelegationsClient) List 

func (client *AvailableDelegationsClient) List(location string, options *AvailableDelegationsClientListOptions) *AvailableDelegationsClientListPager

List - Gets all of the available subnet delegations for this subscription in this region. If the operation fails it returns an *azcore.ResponseError type. location - The location of the subnet. options - AvailableDelegationsClientListOptions contains the optional parameters for the AvailableDelegationsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AvailableDelegationsSubscriptionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAvailableDelegationsClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AvailableDelegationsClientListOptions added in v0.3.0 

type AvailableDelegationsClientListOptions struct {
}

AvailableDelegationsClientListOptions contains the optional parameters for the AvailableDelegationsClient.List method.

type AvailableDelegationsClientListPager added in v0.3.0 

type AvailableDelegationsClientListPager struct {
	// contains filtered or unexported fields
}

AvailableDelegationsClientListPager provides operations for iterating over paged responses.

func (*AvailableDelegationsClientListPager) Err added in v0.3.0 

func (p *AvailableDelegationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AvailableDelegationsClientListPager) NextPage added in v0.3.0 

func (p *AvailableDelegationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AvailableDelegationsClientListPager) PageResponse added in v0.3.0 

func (p *AvailableDelegationsClientListPager) PageResponse() AvailableDelegationsClientListResponse

PageResponse returns the current AvailableDelegationsClientListResponse page.

type AvailableDelegationsClientListResponse added in v0.3.0 

type AvailableDelegationsClientListResponse struct {
	AvailableDelegationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailableDelegationsClientListResponse contains the response from method AvailableDelegationsClient.List.

type AvailableDelegationsClientListResult added in v0.3.0 

type AvailableDelegationsClientListResult struct {
	AvailableDelegationsResult
}

AvailableDelegationsClientListResult contains the result from method AvailableDelegationsClient.List.

type AvailableDelegationsResult 

type AvailableDelegationsResult struct {
	// An array of available delegations.
	Value []*AvailableDelegation `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

AvailableDelegationsResult - An array of available delegations.

func (AvailableDelegationsResult) MarshalJSON 

func (a AvailableDelegationsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableDelegationsResult.

type AvailableEndpointServicesClient 

type AvailableEndpointServicesClient struct {
	// contains filtered or unexported fields
}

AvailableEndpointServicesClient contains the methods for the AvailableEndpointServices group. Don't use this type directly, use NewAvailableEndpointServicesClient() instead.

func NewAvailableEndpointServicesClient 

func NewAvailableEndpointServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AvailableEndpointServicesClient

NewAvailableEndpointServicesClient creates a new instance of AvailableEndpointServicesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AvailableEndpointServicesClient) List 

func (client *AvailableEndpointServicesClient) List(location string, options *AvailableEndpointServicesClientListOptions) *AvailableEndpointServicesClientListPager

List - List what values of endpoint services are available for use. If the operation fails it returns an *azcore.ResponseError type. location - The location to check available endpoint services. options - AvailableEndpointServicesClientListOptions contains the optional parameters for the AvailableEndpointServicesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/EndpointServicesList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAvailableEndpointServicesClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AvailableEndpointServicesClientListOptions added in v0.3.0 

type AvailableEndpointServicesClientListOptions struct {
}

AvailableEndpointServicesClientListOptions contains the optional parameters for the AvailableEndpointServicesClient.List method.

type AvailableEndpointServicesClientListPager added in v0.3.0 

type AvailableEndpointServicesClientListPager struct {
	// contains filtered or unexported fields
}

AvailableEndpointServicesClientListPager provides operations for iterating over paged responses.

func (*AvailableEndpointServicesClientListPager) Err added in v0.3.0 

func (p *AvailableEndpointServicesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AvailableEndpointServicesClientListPager) NextPage added in v0.3.0 

func (p *AvailableEndpointServicesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AvailableEndpointServicesClientListPager) PageResponse added in v0.3.0 

func (p *AvailableEndpointServicesClientListPager) PageResponse() AvailableEndpointServicesClientListResponse

PageResponse returns the current AvailableEndpointServicesClientListResponse page.

type AvailableEndpointServicesClientListResponse added in v0.3.0 

type AvailableEndpointServicesClientListResponse struct {
	AvailableEndpointServicesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailableEndpointServicesClientListResponse contains the response from method AvailableEndpointServicesClient.List.

type AvailableEndpointServicesClientListResult added in v0.3.0 

type AvailableEndpointServicesClientListResult struct {
	EndpointServicesListResult
}

AvailableEndpointServicesClientListResult contains the result from method AvailableEndpointServicesClient.List.

type AvailablePrivateEndpointType 

type AvailablePrivateEndpointType struct {
	// Display name of the resource.
	DisplayName *string `json:"displayName,omitempty"`

	// A unique identifier of the AvailablePrivateEndpoint Type resource.
	ID *string `json:"id,omitempty"`

	// The name of the service and resource.
	Name *string `json:"name,omitempty"`

	// The name of the service and resource.
	ResourceName *string `json:"resourceName,omitempty"`

	// Resource type.
	Type *string `json:"type,omitempty"`
}

AvailablePrivateEndpointType - The information of an AvailablePrivateEndpointType.

type AvailablePrivateEndpointTypesClient 

type AvailablePrivateEndpointTypesClient struct {
	// contains filtered or unexported fields
}

AvailablePrivateEndpointTypesClient contains the methods for the AvailablePrivateEndpointTypes group. Don't use this type directly, use NewAvailablePrivateEndpointTypesClient() instead.

func NewAvailablePrivateEndpointTypesClient 

func NewAvailablePrivateEndpointTypesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AvailablePrivateEndpointTypesClient

NewAvailablePrivateEndpointTypesClient creates a new instance of AvailablePrivateEndpointTypesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AvailablePrivateEndpointTypesClient) List 

func (client *AvailablePrivateEndpointTypesClient) List(location string, options *AvailablePrivateEndpointTypesClientListOptions) *AvailablePrivateEndpointTypesClientListPager

List - Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region. If the operation fails it returns an *azcore.ResponseError type. location - The location of the domain name. options - AvailablePrivateEndpointTypesClientListOptions contains the optional parameters for the AvailablePrivateEndpointTypesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AvailablePrivateEndpointTypesGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAvailablePrivateEndpointTypesClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*AvailablePrivateEndpointTypesClient) ListByResourceGroup 

func (client *AvailablePrivateEndpointTypesClient) ListByResourceGroup(location string, resourceGroupName string, options *AvailablePrivateEndpointTypesClientListByResourceGroupOptions) *AvailablePrivateEndpointTypesClientListByResourceGroupPager

ListByResourceGroup - Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region. If the operation fails it returns an *azcore.ResponseError type. location - The location of the domain name. resourceGroupName - The name of the resource group. options - AvailablePrivateEndpointTypesClientListByResourceGroupOptions contains the optional parameters for the AvailablePrivateEndpointTypesClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAvailablePrivateEndpointTypesClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<location>",
		"<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AvailablePrivateEndpointTypesClientListByResourceGroupOptions added in v0.3.0 

type AvailablePrivateEndpointTypesClientListByResourceGroupOptions struct {
}

AvailablePrivateEndpointTypesClientListByResourceGroupOptions contains the optional parameters for the AvailablePrivateEndpointTypesClient.ListByResourceGroup method.

type AvailablePrivateEndpointTypesClientListByResourceGroupPager added in v0.3.0 

type AvailablePrivateEndpointTypesClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

AvailablePrivateEndpointTypesClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*AvailablePrivateEndpointTypesClientListByResourceGroupPager) Err added in v0.3.0 

func (p *AvailablePrivateEndpointTypesClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*AvailablePrivateEndpointTypesClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *AvailablePrivateEndpointTypesClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AvailablePrivateEndpointTypesClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *AvailablePrivateEndpointTypesClientListByResourceGroupPager) PageResponse() AvailablePrivateEndpointTypesClientListByResourceGroupResponse

PageResponse returns the current AvailablePrivateEndpointTypesClientListByResourceGroupResponse page.

type AvailablePrivateEndpointTypesClientListByResourceGroupResponse added in v0.3.0 

type AvailablePrivateEndpointTypesClientListByResourceGroupResponse struct {
	AvailablePrivateEndpointTypesClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailablePrivateEndpointTypesClientListByResourceGroupResponse contains the response from method AvailablePrivateEndpointTypesClient.ListByResourceGroup.

type AvailablePrivateEndpointTypesClientListByResourceGroupResult added in v0.3.0 

type AvailablePrivateEndpointTypesClientListByResourceGroupResult struct {
	AvailablePrivateEndpointTypesResult
}

AvailablePrivateEndpointTypesClientListByResourceGroupResult contains the result from method AvailablePrivateEndpointTypesClient.ListByResourceGroup.

type AvailablePrivateEndpointTypesClientListOptions added in v0.3.0 

type AvailablePrivateEndpointTypesClientListOptions struct {
}

AvailablePrivateEndpointTypesClientListOptions contains the optional parameters for the AvailablePrivateEndpointTypesClient.List method.

type AvailablePrivateEndpointTypesClientListPager added in v0.3.0 

type AvailablePrivateEndpointTypesClientListPager struct {
	// contains filtered or unexported fields
}

AvailablePrivateEndpointTypesClientListPager provides operations for iterating over paged responses.

func (*AvailablePrivateEndpointTypesClientListPager) Err added in v0.3.0 

func (p *AvailablePrivateEndpointTypesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AvailablePrivateEndpointTypesClientListPager) NextPage added in v0.3.0 

func (p *AvailablePrivateEndpointTypesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AvailablePrivateEndpointTypesClientListPager) PageResponse added in v0.3.0 

func (p *AvailablePrivateEndpointTypesClientListPager) PageResponse() AvailablePrivateEndpointTypesClientListResponse

PageResponse returns the current AvailablePrivateEndpointTypesClientListResponse page.

type AvailablePrivateEndpointTypesClientListResponse added in v0.3.0 

type AvailablePrivateEndpointTypesClientListResponse struct {
	AvailablePrivateEndpointTypesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailablePrivateEndpointTypesClientListResponse contains the response from method AvailablePrivateEndpointTypesClient.List.

type AvailablePrivateEndpointTypesClientListResult added in v0.3.0 

type AvailablePrivateEndpointTypesClientListResult struct {
	AvailablePrivateEndpointTypesResult
}

AvailablePrivateEndpointTypesClientListResult contains the result from method AvailablePrivateEndpointTypesClient.List.

type AvailablePrivateEndpointTypesResult 

type AvailablePrivateEndpointTypesResult struct {
	// An array of available privateEndpoint type.
	Value []*AvailablePrivateEndpointType `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

AvailablePrivateEndpointTypesResult - An array of available PrivateEndpoint types.

func (AvailablePrivateEndpointTypesResult) MarshalJSON 

func (a AvailablePrivateEndpointTypesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailablePrivateEndpointTypesResult.

type AvailableProvidersList 

type AvailableProvidersList struct {
	// REQUIRED; List of available countries.
	Countries []*AvailableProvidersListCountry `json:"countries,omitempty"`
}

AvailableProvidersList - List of available countries with details.

func (AvailableProvidersList) MarshalJSON 

func (a AvailableProvidersList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableProvidersList.

type AvailableProvidersListCity 

type AvailableProvidersListCity struct {
	// The city or town name.
	CityName *string `json:"cityName,omitempty"`

	// A list of Internet service providers.
	Providers []*string `json:"providers,omitempty"`
}

AvailableProvidersListCity - City or town details.

func (AvailableProvidersListCity) MarshalJSON 

func (a AvailableProvidersListCity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableProvidersListCity.

type AvailableProvidersListCountry 

type AvailableProvidersListCountry struct {
	// The country name.
	CountryName *string `json:"countryName,omitempty"`

	// A list of Internet service providers.
	Providers []*string `json:"providers,omitempty"`

	// List of available states in the country.
	States []*AvailableProvidersListState `json:"states,omitempty"`
}

AvailableProvidersListCountry - Country details.

func (AvailableProvidersListCountry) MarshalJSON 

func (a AvailableProvidersListCountry) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableProvidersListCountry.

type AvailableProvidersListParameters 

type AvailableProvidersListParameters struct {
	// A list of Azure regions.
	AzureLocations []*string `json:"azureLocations,omitempty"`

	// The city or town for available providers list.
	City *string `json:"city,omitempty"`

	// The country for available providers list.
	Country *string `json:"country,omitempty"`

	// The state for available providers list.
	State *string `json:"state,omitempty"`
}

AvailableProvidersListParameters - Constraints that determine the list of available Internet service providers.

func (AvailableProvidersListParameters) MarshalJSON 

func (a AvailableProvidersListParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableProvidersListParameters.

type AvailableProvidersListState 

type AvailableProvidersListState struct {
	// List of available cities or towns in the state.
	Cities []*AvailableProvidersListCity `json:"cities,omitempty"`

	// A list of Internet service providers.
	Providers []*string `json:"providers,omitempty"`

	// The state name.
	StateName *string `json:"stateName,omitempty"`
}

AvailableProvidersListState - State details.

func (AvailableProvidersListState) MarshalJSON 

func (a AvailableProvidersListState) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableProvidersListState.

type AvailableResourceGroupDelegationsClient 

type AvailableResourceGroupDelegationsClient struct {
	// contains filtered or unexported fields
}

AvailableResourceGroupDelegationsClient contains the methods for the AvailableResourceGroupDelegations group. Don't use this type directly, use NewAvailableResourceGroupDelegationsClient() instead.

func NewAvailableResourceGroupDelegationsClient 

func NewAvailableResourceGroupDelegationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AvailableResourceGroupDelegationsClient

NewAvailableResourceGroupDelegationsClient creates a new instance of AvailableResourceGroupDelegationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AvailableResourceGroupDelegationsClient) List 

func (client *AvailableResourceGroupDelegationsClient) List(location string, resourceGroupName string, options *AvailableResourceGroupDelegationsClientListOptions) *AvailableResourceGroupDelegationsClientListPager

List - Gets all of the available subnet delegations for this resource group in this region. If the operation fails it returns an *azcore.ResponseError type. location - The location of the domain name. resourceGroupName - The name of the resource group. options - AvailableResourceGroupDelegationsClientListOptions contains the optional parameters for the AvailableResourceGroupDelegationsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AvailableDelegationsResourceGroupGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAvailableResourceGroupDelegationsClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		"<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AvailableResourceGroupDelegationsClientListOptions added in v0.3.0 

type AvailableResourceGroupDelegationsClientListOptions struct {
}

AvailableResourceGroupDelegationsClientListOptions contains the optional parameters for the AvailableResourceGroupDelegationsClient.List method.

type AvailableResourceGroupDelegationsClientListPager added in v0.3.0 

type AvailableResourceGroupDelegationsClientListPager struct {
	// contains filtered or unexported fields
}

AvailableResourceGroupDelegationsClientListPager provides operations for iterating over paged responses.

func (*AvailableResourceGroupDelegationsClientListPager) Err added in v0.3.0 

func (p *AvailableResourceGroupDelegationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AvailableResourceGroupDelegationsClientListPager) NextPage added in v0.3.0 

func (p *AvailableResourceGroupDelegationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AvailableResourceGroupDelegationsClientListPager) PageResponse added in v0.3.0 

func (p *AvailableResourceGroupDelegationsClientListPager) PageResponse() AvailableResourceGroupDelegationsClientListResponse

PageResponse returns the current AvailableResourceGroupDelegationsClientListResponse page.

type AvailableResourceGroupDelegationsClientListResponse added in v0.3.0 

type AvailableResourceGroupDelegationsClientListResponse struct {
	AvailableResourceGroupDelegationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailableResourceGroupDelegationsClientListResponse contains the response from method AvailableResourceGroupDelegationsClient.List.

type AvailableResourceGroupDelegationsClientListResult added in v0.3.0 

type AvailableResourceGroupDelegationsClientListResult struct {
	AvailableDelegationsResult
}

AvailableResourceGroupDelegationsClientListResult contains the result from method AvailableResourceGroupDelegationsClient.List.

type AvailableServiceAlias 

type AvailableServiceAlias struct {
	// The ID of the service alias.
	ID *string `json:"id,omitempty"`

	// The name of the service alias.
	Name *string `json:"name,omitempty"`

	// The resource name of the service alias.
	ResourceName *string `json:"resourceName,omitempty"`

	// The type of the resource.
	Type *string `json:"type,omitempty"`
}

AvailableServiceAlias - The available service alias.

type AvailableServiceAliasesClient 

type AvailableServiceAliasesClient struct {
	// contains filtered or unexported fields
}

AvailableServiceAliasesClient contains the methods for the AvailableServiceAliases group. Don't use this type directly, use NewAvailableServiceAliasesClient() instead.

func NewAvailableServiceAliasesClient 

func NewAvailableServiceAliasesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AvailableServiceAliasesClient

NewAvailableServiceAliasesClient creates a new instance of AvailableServiceAliasesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AvailableServiceAliasesClient) List 

func (client *AvailableServiceAliasesClient) List(location string, options *AvailableServiceAliasesClientListOptions) *AvailableServiceAliasesClientListPager

List - Gets all available service aliases for this subscription in this region. If the operation fails it returns an *azcore.ResponseError type. location - The location. options - AvailableServiceAliasesClientListOptions contains the optional parameters for the AvailableServiceAliasesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AvailableServiceAliasesList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAvailableServiceAliasesClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*AvailableServiceAliasesClient) ListByResourceGroup 

func (client *AvailableServiceAliasesClient) ListByResourceGroup(resourceGroupName string, location string, options *AvailableServiceAliasesClientListByResourceGroupOptions) *AvailableServiceAliasesClientListByResourceGroupPager

ListByResourceGroup - Gets all available service aliases for this resource group in this region. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. location - The location. options - AvailableServiceAliasesClientListByResourceGroupOptions contains the optional parameters for the AvailableServiceAliasesClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AvailableServiceAliasesListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAvailableServiceAliasesClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		"<location>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AvailableServiceAliasesClientListByResourceGroupOptions added in v0.3.0 

type AvailableServiceAliasesClientListByResourceGroupOptions struct {
}

AvailableServiceAliasesClientListByResourceGroupOptions contains the optional parameters for the AvailableServiceAliasesClient.ListByResourceGroup method.

type AvailableServiceAliasesClientListByResourceGroupPager added in v0.3.0 

type AvailableServiceAliasesClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

AvailableServiceAliasesClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*AvailableServiceAliasesClientListByResourceGroupPager) Err added in v0.3.0 

func (p *AvailableServiceAliasesClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*AvailableServiceAliasesClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *AvailableServiceAliasesClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AvailableServiceAliasesClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *AvailableServiceAliasesClientListByResourceGroupPager) PageResponse() AvailableServiceAliasesClientListByResourceGroupResponse

PageResponse returns the current AvailableServiceAliasesClientListByResourceGroupResponse page.

type AvailableServiceAliasesClientListByResourceGroupResponse added in v0.3.0 

type AvailableServiceAliasesClientListByResourceGroupResponse struct {
	AvailableServiceAliasesClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailableServiceAliasesClientListByResourceGroupResponse contains the response from method AvailableServiceAliasesClient.ListByResourceGroup.

type AvailableServiceAliasesClientListByResourceGroupResult added in v0.3.0 

type AvailableServiceAliasesClientListByResourceGroupResult struct {
	AvailableServiceAliasesResult
}

AvailableServiceAliasesClientListByResourceGroupResult contains the result from method AvailableServiceAliasesClient.ListByResourceGroup.

type AvailableServiceAliasesClientListOptions added in v0.3.0 

type AvailableServiceAliasesClientListOptions struct {
}

AvailableServiceAliasesClientListOptions contains the optional parameters for the AvailableServiceAliasesClient.List method.

type AvailableServiceAliasesClientListPager added in v0.3.0 

type AvailableServiceAliasesClientListPager struct {
	// contains filtered or unexported fields
}

AvailableServiceAliasesClientListPager provides operations for iterating over paged responses.

func (*AvailableServiceAliasesClientListPager) Err added in v0.3.0 

func (p *AvailableServiceAliasesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AvailableServiceAliasesClientListPager) NextPage added in v0.3.0 

func (p *AvailableServiceAliasesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AvailableServiceAliasesClientListPager) PageResponse added in v0.3.0 

func (p *AvailableServiceAliasesClientListPager) PageResponse() AvailableServiceAliasesClientListResponse

PageResponse returns the current AvailableServiceAliasesClientListResponse page.

type AvailableServiceAliasesClientListResponse added in v0.3.0 

type AvailableServiceAliasesClientListResponse struct {
	AvailableServiceAliasesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailableServiceAliasesClientListResponse contains the response from method AvailableServiceAliasesClient.List.

type AvailableServiceAliasesClientListResult added in v0.3.0 

type AvailableServiceAliasesClientListResult struct {
	AvailableServiceAliasesResult
}

AvailableServiceAliasesClientListResult contains the result from method AvailableServiceAliasesClient.List.

type AvailableServiceAliasesResult 

type AvailableServiceAliasesResult struct {
	// An array of available service aliases.
	Value []*AvailableServiceAlias `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

AvailableServiceAliasesResult - An array of available service aliases.

func (AvailableServiceAliasesResult) MarshalJSON 

func (a AvailableServiceAliasesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableServiceAliasesResult.

type AzureAsyncOperationResult 

type AzureAsyncOperationResult struct {
	// Details of the error occurred during specified asynchronous operation.
	Error *Error `json:"error,omitempty"`

	// Status of the Azure async operation.
	Status *NetworkOperationStatus `json:"status,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 AzureFirewall 

type AzureFirewall struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the azure firewall.
	Properties *AzureFirewallPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// A list of availability zones denoting where the resource needs to come from.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

AzureFirewall - Azure Firewall resource.

func (AzureFirewall) MarshalJSON 

func (a AzureFirewall) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewall.

type AzureFirewallApplicationRule 

type AzureFirewallApplicationRule struct {
	// Description of the rule.
	Description *string `json:"description,omitempty"`

	// List of FQDN Tags for this rule.
	FqdnTags []*string `json:"fqdnTags,omitempty"`

	// Name of the application rule.
	Name *string `json:"name,omitempty"`

	// Array of ApplicationRuleProtocols.
	Protocols []*AzureFirewallApplicationRuleProtocol `json:"protocols,omitempty"`

	// List of source IP addresses for this rule.
	SourceAddresses []*string `json:"sourceAddresses,omitempty"`

	// List of source IpGroups for this rule.
	SourceIPGroups []*string `json:"sourceIpGroups,omitempty"`

	// List of FQDNs for this rule.
	TargetFqdns []*string `json:"targetFqdns,omitempty"`
}

AzureFirewallApplicationRule - Properties of an application rule.

func (AzureFirewallApplicationRule) MarshalJSON 

func (a AzureFirewallApplicationRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewallApplicationRule.

type AzureFirewallApplicationRuleCollection 

type AzureFirewallApplicationRuleCollection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of the azure firewall application rule collection.
	Properties *AzureFirewallApplicationRuleCollectionPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

AzureFirewallApplicationRuleCollection - Application rule collection resource.

type AzureFirewallApplicationRuleCollectionPropertiesFormat 

type AzureFirewallApplicationRuleCollectionPropertiesFormat struct {
	// The action type of a rule collection.
	Action *AzureFirewallRCAction `json:"action,omitempty"`

	// Priority of the application rule collection resource.
	Priority *int32 `json:"priority,omitempty"`

	// Collection of rules used by a application rule collection.
	Rules []*AzureFirewallApplicationRule `json:"rules,omitempty"`

	// READ-ONLY; The provisioning state of the application rule collection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AzureFirewallApplicationRuleCollectionPropertiesFormat - Properties of the application rule collection.

func (AzureFirewallApplicationRuleCollectionPropertiesFormat) MarshalJSON 

func (a AzureFirewallApplicationRuleCollectionPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewallApplicationRuleCollectionPropertiesFormat.

type AzureFirewallApplicationRuleProtocol 

type AzureFirewallApplicationRuleProtocol struct {
	// Port number for the protocol, cannot be greater than 64000. This field is optional.
	Port *int32 `json:"port,omitempty"`

	// Protocol type.
	ProtocolType *AzureFirewallApplicationRuleProtocolType `json:"protocolType,omitempty"`
}

AzureFirewallApplicationRuleProtocol - Properties of the application rule protocol.

type AzureFirewallApplicationRuleProtocolType 

type AzureFirewallApplicationRuleProtocolType string

AzureFirewallApplicationRuleProtocolType - The protocol type of a Application Rule resource. 

const (
	AzureFirewallApplicationRuleProtocolTypeHTTP  AzureFirewallApplicationRuleProtocolType = "Http"
	AzureFirewallApplicationRuleProtocolTypeHTTPS AzureFirewallApplicationRuleProtocolType = "Https"
	AzureFirewallApplicationRuleProtocolTypeMssql AzureFirewallApplicationRuleProtocolType = "Mssql"
)

func PossibleAzureFirewallApplicationRuleProtocolTypeValues 

func PossibleAzureFirewallApplicationRuleProtocolTypeValues() []AzureFirewallApplicationRuleProtocolType

PossibleAzureFirewallApplicationRuleProtocolTypeValues returns the possible values for the AzureFirewallApplicationRuleProtocolType const type.

func (AzureFirewallApplicationRuleProtocolType) ToPtr 

func (c AzureFirewallApplicationRuleProtocolType) ToPtr() *AzureFirewallApplicationRuleProtocolType

ToPtr returns a *AzureFirewallApplicationRuleProtocolType pointing to the current value.

type AzureFirewallFqdnTag 

type AzureFirewallFqdnTag struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the azure firewall FQDN tag.
	Properties *AzureFirewallFqdnTagPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

AzureFirewallFqdnTag - Azure Firewall FQDN Tag Resource.

func (AzureFirewallFqdnTag) MarshalJSON 

func (a AzureFirewallFqdnTag) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewallFqdnTag.

type AzureFirewallFqdnTagListResult 

type AzureFirewallFqdnTagListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Azure Firewall FQDN Tags in a resource group.
	Value []*AzureFirewallFqdnTag `json:"value,omitempty"`
}

AzureFirewallFqdnTagListResult - Response for ListAzureFirewallFqdnTags API service call.

func (AzureFirewallFqdnTagListResult) MarshalJSON 

func (a AzureFirewallFqdnTagListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewallFqdnTagListResult.

type AzureFirewallFqdnTagPropertiesFormat 

type AzureFirewallFqdnTagPropertiesFormat struct {
	// READ-ONLY; The name of this FQDN Tag.
	FqdnTagName *string `json:"fqdnTagName,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the Azure firewall FQDN tag resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AzureFirewallFqdnTagPropertiesFormat - Azure Firewall FQDN Tag Properties.

type AzureFirewallFqdnTagsClient 

type AzureFirewallFqdnTagsClient struct {
	// contains filtered or unexported fields
}

AzureFirewallFqdnTagsClient contains the methods for the AzureFirewallFqdnTags group. Don't use this type directly, use NewAzureFirewallFqdnTagsClient() instead.

func NewAzureFirewallFqdnTagsClient 

func NewAzureFirewallFqdnTagsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AzureFirewallFqdnTagsClient

NewAzureFirewallFqdnTagsClient creates a new instance of AzureFirewallFqdnTagsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AzureFirewallFqdnTagsClient) ListAll 

func (client *AzureFirewallFqdnTagsClient) ListAll(options *AzureFirewallFqdnTagsClientListAllOptions) *AzureFirewallFqdnTagsClientListAllPager

ListAll - Gets all the Azure Firewall FQDN Tags in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - AzureFirewallFqdnTagsClientListAllOptions contains the optional parameters for the AzureFirewallFqdnTagsClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AzureFirewallFqdnTagsListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAzureFirewallFqdnTagsClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AzureFirewallFqdnTagsClientListAllOptions added in v0.3.0 

type AzureFirewallFqdnTagsClientListAllOptions struct {
}

AzureFirewallFqdnTagsClientListAllOptions contains the optional parameters for the AzureFirewallFqdnTagsClient.ListAll method.

type AzureFirewallFqdnTagsClientListAllPager added in v0.3.0 

type AzureFirewallFqdnTagsClientListAllPager struct {
	// contains filtered or unexported fields
}

AzureFirewallFqdnTagsClientListAllPager provides operations for iterating over paged responses.

func (*AzureFirewallFqdnTagsClientListAllPager) Err added in v0.3.0 

func (p *AzureFirewallFqdnTagsClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*AzureFirewallFqdnTagsClientListAllPager) NextPage added in v0.3.0 

func (p *AzureFirewallFqdnTagsClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AzureFirewallFqdnTagsClientListAllPager) PageResponse added in v0.3.0 

func (p *AzureFirewallFqdnTagsClientListAllPager) PageResponse() AzureFirewallFqdnTagsClientListAllResponse

PageResponse returns the current AzureFirewallFqdnTagsClientListAllResponse page.

type AzureFirewallFqdnTagsClientListAllResponse added in v0.3.0 

type AzureFirewallFqdnTagsClientListAllResponse struct {
	AzureFirewallFqdnTagsClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AzureFirewallFqdnTagsClientListAllResponse contains the response from method AzureFirewallFqdnTagsClient.ListAll.

type AzureFirewallFqdnTagsClientListAllResult added in v0.3.0 

type AzureFirewallFqdnTagsClientListAllResult struct {
	AzureFirewallFqdnTagListResult
}

AzureFirewallFqdnTagsClientListAllResult contains the result from method AzureFirewallFqdnTagsClient.ListAll.

type AzureFirewallIPConfiguration 

type AzureFirewallIPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the azure firewall IP configuration.
	Properties *AzureFirewallIPConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

AzureFirewallIPConfiguration - IP configuration of an Azure Firewall.

type AzureFirewallIPConfigurationPropertiesFormat 

type AzureFirewallIPConfigurationPropertiesFormat struct {
	// Reference to the PublicIP resource. This field is a mandatory input if subnet is not null.
	PublicIPAddress *SubResource `json:"publicIPAddress,omitempty"`

	// Reference to the subnet resource. This resource must be named 'AzureFirewallSubnet' or 'AzureFirewallManagementSubnet'.
	Subnet *SubResource `json:"subnet,omitempty"`

	// READ-ONLY; The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the Azure firewall IP configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AzureFirewallIPConfigurationPropertiesFormat - Properties of IP configuration of an Azure Firewall.

type AzureFirewallIPGroups 

type AzureFirewallIPGroups struct {
	// READ-ONLY; The iteration number.
	ChangeNumber *string `json:"changeNumber,omitempty" azure:"ro"`

	// READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`
}

AzureFirewallIPGroups - IpGroups associated with azure firewall.

type AzureFirewallListResult 

type AzureFirewallListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Azure Firewalls in a resource group.
	Value []*AzureFirewall `json:"value,omitempty"`
}

AzureFirewallListResult - Response for ListAzureFirewalls API service call.

func (AzureFirewallListResult) MarshalJSON 

func (a AzureFirewallListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewallListResult.

type AzureFirewallNatRCAction 

type AzureFirewallNatRCAction struct {
	// The type of action.
	Type *AzureFirewallNatRCActionType `json:"type,omitempty"`
}

AzureFirewallNatRCAction - AzureFirewall NAT Rule Collection Action.

type AzureFirewallNatRCActionType 

type AzureFirewallNatRCActionType string

AzureFirewallNatRCActionType - The action type of a NAT rule collection. 

const (
	AzureFirewallNatRCActionTypeDnat AzureFirewallNatRCActionType = "Dnat"
	AzureFirewallNatRCActionTypeSnat AzureFirewallNatRCActionType = "Snat"
)

func PossibleAzureFirewallNatRCActionTypeValues 

func PossibleAzureFirewallNatRCActionTypeValues() []AzureFirewallNatRCActionType

PossibleAzureFirewallNatRCActionTypeValues returns the possible values for the AzureFirewallNatRCActionType const type.

func (AzureFirewallNatRCActionType) ToPtr 

func (c AzureFirewallNatRCActionType) ToPtr() *AzureFirewallNatRCActionType

ToPtr returns a *AzureFirewallNatRCActionType pointing to the current value.

type AzureFirewallNatRule 

type AzureFirewallNatRule struct {
	// Description of the rule.
	Description *string `json:"description,omitempty"`

	// List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.
	DestinationAddresses []*string `json:"destinationAddresses,omitempty"`

	// List of destination ports.
	DestinationPorts []*string `json:"destinationPorts,omitempty"`

	// Name of the NAT rule.
	Name *string `json:"name,omitempty"`

	// Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.
	Protocols []*AzureFirewallNetworkRuleProtocol `json:"protocols,omitempty"`

	// List of source IP addresses for this rule.
	SourceAddresses []*string `json:"sourceAddresses,omitempty"`

	// List of source IpGroups for this rule.
	SourceIPGroups []*string `json:"sourceIpGroups,omitempty"`

	// The translated address for this NAT rule.
	TranslatedAddress *string `json:"translatedAddress,omitempty"`

	// The translated FQDN for this NAT rule.
	TranslatedFqdn *string `json:"translatedFqdn,omitempty"`

	// The translated port for this NAT rule.
	TranslatedPort *string `json:"translatedPort,omitempty"`
}

AzureFirewallNatRule - Properties of a NAT rule.

func (AzureFirewallNatRule) MarshalJSON 

func (a AzureFirewallNatRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewallNatRule.

type AzureFirewallNatRuleCollection 

type AzureFirewallNatRuleCollection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of the azure firewall NAT rule collection.
	Properties *AzureFirewallNatRuleCollectionProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

AzureFirewallNatRuleCollection - NAT rule collection resource.

type AzureFirewallNatRuleCollectionProperties 

type AzureFirewallNatRuleCollectionProperties struct {
	// The action type of a NAT rule collection.
	Action *AzureFirewallNatRCAction `json:"action,omitempty"`

	// Priority of the NAT rule collection resource.
	Priority *int32 `json:"priority,omitempty"`

	// Collection of rules used by a NAT rule collection.
	Rules []*AzureFirewallNatRule `json:"rules,omitempty"`

	// READ-ONLY; The provisioning state of the NAT rule collection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AzureFirewallNatRuleCollectionProperties - Properties of the NAT rule collection.

func (AzureFirewallNatRuleCollectionProperties) MarshalJSON 

func (a AzureFirewallNatRuleCollectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewallNatRuleCollectionProperties.

type AzureFirewallNetworkRule 

type AzureFirewallNetworkRule struct {
	// Description of the rule.
	Description *string `json:"description,omitempty"`

	// List of destination IP addresses.
	DestinationAddresses []*string `json:"destinationAddresses,omitempty"`

	// List of destination FQDNs.
	DestinationFqdns []*string `json:"destinationFqdns,omitempty"`

	// List of destination IpGroups for this rule.
	DestinationIPGroups []*string `json:"destinationIpGroups,omitempty"`

	// List of destination ports.
	DestinationPorts []*string `json:"destinationPorts,omitempty"`

	// Name of the network rule.
	Name *string `json:"name,omitempty"`

	// Array of AzureFirewallNetworkRuleProtocols.
	Protocols []*AzureFirewallNetworkRuleProtocol `json:"protocols,omitempty"`

	// List of source IP addresses for this rule.
	SourceAddresses []*string `json:"sourceAddresses,omitempty"`

	// List of source IpGroups for this rule.
	SourceIPGroups []*string `json:"sourceIpGroups,omitempty"`
}

AzureFirewallNetworkRule - Properties of the network rule.

func (AzureFirewallNetworkRule) MarshalJSON 

func (a AzureFirewallNetworkRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewallNetworkRule.

type AzureFirewallNetworkRuleCollection 

type AzureFirewallNetworkRuleCollection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of the azure firewall network rule collection.
	Properties *AzureFirewallNetworkRuleCollectionPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

AzureFirewallNetworkRuleCollection - Network rule collection resource.

type AzureFirewallNetworkRuleCollectionPropertiesFormat 

type AzureFirewallNetworkRuleCollectionPropertiesFormat struct {
	// The action type of a rule collection.
	Action *AzureFirewallRCAction `json:"action,omitempty"`

	// Priority of the network rule collection resource.
	Priority *int32 `json:"priority,omitempty"`

	// Collection of rules used by a network rule collection.
	Rules []*AzureFirewallNetworkRule `json:"rules,omitempty"`

	// READ-ONLY; The provisioning state of the network rule collection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AzureFirewallNetworkRuleCollectionPropertiesFormat - Properties of the network rule collection.

func (AzureFirewallNetworkRuleCollectionPropertiesFormat) MarshalJSON 

func (a AzureFirewallNetworkRuleCollectionPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewallNetworkRuleCollectionPropertiesFormat.

type AzureFirewallNetworkRuleProtocol 

type AzureFirewallNetworkRuleProtocol string

AzureFirewallNetworkRuleProtocol - The protocol of a Network Rule resource. 

const (
	AzureFirewallNetworkRuleProtocolAny  AzureFirewallNetworkRuleProtocol = "Any"
	AzureFirewallNetworkRuleProtocolICMP AzureFirewallNetworkRuleProtocol = "ICMP"
	AzureFirewallNetworkRuleProtocolTCP  AzureFirewallNetworkRuleProtocol = "TCP"
	AzureFirewallNetworkRuleProtocolUDP  AzureFirewallNetworkRuleProtocol = "UDP"
)

func PossibleAzureFirewallNetworkRuleProtocolValues 

func PossibleAzureFirewallNetworkRuleProtocolValues() []AzureFirewallNetworkRuleProtocol

PossibleAzureFirewallNetworkRuleProtocolValues returns the possible values for the AzureFirewallNetworkRuleProtocol const type.

func (AzureFirewallNetworkRuleProtocol) ToPtr 

func (c AzureFirewallNetworkRuleProtocol) ToPtr() *AzureFirewallNetworkRuleProtocol

ToPtr returns a *AzureFirewallNetworkRuleProtocol pointing to the current value.

type AzureFirewallPropertiesFormat 

type AzureFirewallPropertiesFormat struct {
	// The additional properties used to further config this azure firewall.
	AdditionalProperties map[string]*string `json:"additionalProperties,omitempty"`

	// Collection of application rule collections used by Azure Firewall.
	ApplicationRuleCollections []*AzureFirewallApplicationRuleCollection `json:"applicationRuleCollections,omitempty"`

	// The firewallPolicy associated with this azure firewall.
	FirewallPolicy *SubResource `json:"firewallPolicy,omitempty"`

	// IP addresses associated with AzureFirewall.
	HubIPAddresses *HubIPAddresses `json:"hubIPAddresses,omitempty"`

	// IP configuration of the Azure Firewall resource.
	IPConfigurations []*AzureFirewallIPConfiguration `json:"ipConfigurations,omitempty"`

	// IP configuration of the Azure Firewall used for management traffic.
	ManagementIPConfiguration *AzureFirewallIPConfiguration `json:"managementIpConfiguration,omitempty"`

	// Collection of NAT rule collections used by Azure Firewall.
	NatRuleCollections []*AzureFirewallNatRuleCollection `json:"natRuleCollections,omitempty"`

	// Collection of network rule collections used by Azure Firewall.
	NetworkRuleCollections []*AzureFirewallNetworkRuleCollection `json:"networkRuleCollections,omitempty"`

	// The Azure Firewall Resource SKU.
	SKU *AzureFirewallSKU `json:"sku,omitempty"`

	// The operation mode for Threat Intelligence.
	ThreatIntelMode *AzureFirewallThreatIntelMode `json:"threatIntelMode,omitempty"`

	// The virtualHub to which the firewall belongs.
	VirtualHub *SubResource `json:"virtualHub,omitempty"`

	// READ-ONLY; IpGroups associated with AzureFirewall.
	IPGroups []*AzureFirewallIPGroups `json:"ipGroups,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the Azure firewall resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AzureFirewallPropertiesFormat - Properties of the Azure Firewall.

func (AzureFirewallPropertiesFormat) MarshalJSON 

func (a AzureFirewallPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureFirewallPropertiesFormat.

type AzureFirewallPublicIPAddress 

type AzureFirewallPublicIPAddress struct {
	// Public IP Address value.
	Address *string `json:"address,omitempty"`
}

AzureFirewallPublicIPAddress - Public IP Address associated with azure firewall.

type AzureFirewallRCAction 

type AzureFirewallRCAction struct {
	// The type of action.
	Type *AzureFirewallRCActionType `json:"type,omitempty"`
}

AzureFirewallRCAction - Properties of the AzureFirewallRCAction.

type AzureFirewallRCActionType 

type AzureFirewallRCActionType string

AzureFirewallRCActionType - The action type of a rule collection. 

const (
	AzureFirewallRCActionTypeAllow AzureFirewallRCActionType = "Allow"
	AzureFirewallRCActionTypeDeny  AzureFirewallRCActionType = "Deny"
)

func PossibleAzureFirewallRCActionTypeValues 

func PossibleAzureFirewallRCActionTypeValues() []AzureFirewallRCActionType

PossibleAzureFirewallRCActionTypeValues returns the possible values for the AzureFirewallRCActionType const type.

func (AzureFirewallRCActionType) ToPtr 

func (c AzureFirewallRCActionType) ToPtr() *AzureFirewallRCActionType

ToPtr returns a *AzureFirewallRCActionType pointing to the current value.

type AzureFirewallSKU 

type AzureFirewallSKU struct {
	// Name of an Azure Firewall SKU.
	Name *AzureFirewallSKUName `json:"name,omitempty"`

	// Tier of an Azure Firewall.
	Tier *AzureFirewallSKUTier `json:"tier,omitempty"`
}

AzureFirewallSKU - SKU of an Azure Firewall.

type AzureFirewallSKUName 

type AzureFirewallSKUName string

AzureFirewallSKUName - Name of an Azure Firewall SKU. 

const (
	AzureFirewallSKUNameAZFWHub  AzureFirewallSKUName = "AZFW_Hub"
	AzureFirewallSKUNameAZFWVnet AzureFirewallSKUName = "AZFW_VNet"
)

func PossibleAzureFirewallSKUNameValues 

func PossibleAzureFirewallSKUNameValues() []AzureFirewallSKUName

PossibleAzureFirewallSKUNameValues returns the possible values for the AzureFirewallSKUName const type.

func (AzureFirewallSKUName) ToPtr 

func (c AzureFirewallSKUName) ToPtr() *AzureFirewallSKUName

ToPtr returns a *AzureFirewallSKUName pointing to the current value.

type AzureFirewallSKUTier 

type AzureFirewallSKUTier string

AzureFirewallSKUTier - Tier of an Azure Firewall. 

const (
	AzureFirewallSKUTierBasic    AzureFirewallSKUTier = "Basic"
	AzureFirewallSKUTierPremium  AzureFirewallSKUTier = "Premium"
	AzureFirewallSKUTierStandard AzureFirewallSKUTier = "Standard"
)

func PossibleAzureFirewallSKUTierValues 

func PossibleAzureFirewallSKUTierValues() []AzureFirewallSKUTier

PossibleAzureFirewallSKUTierValues returns the possible values for the AzureFirewallSKUTier const type.

func (AzureFirewallSKUTier) ToPtr 

func (c AzureFirewallSKUTier) ToPtr() *AzureFirewallSKUTier

ToPtr returns a *AzureFirewallSKUTier pointing to the current value.

type AzureFirewallThreatIntelMode 

type AzureFirewallThreatIntelMode string

AzureFirewallThreatIntelMode - The operation mode for Threat Intel. 

const (
	AzureFirewallThreatIntelModeAlert AzureFirewallThreatIntelMode = "Alert"
	AzureFirewallThreatIntelModeDeny  AzureFirewallThreatIntelMode = "Deny"
	AzureFirewallThreatIntelModeOff   AzureFirewallThreatIntelMode = "Off"
)

func PossibleAzureFirewallThreatIntelModeValues 

func PossibleAzureFirewallThreatIntelModeValues() []AzureFirewallThreatIntelMode

PossibleAzureFirewallThreatIntelModeValues returns the possible values for the AzureFirewallThreatIntelMode const type.

func (AzureFirewallThreatIntelMode) ToPtr 

func (c AzureFirewallThreatIntelMode) ToPtr() *AzureFirewallThreatIntelMode

ToPtr returns a *AzureFirewallThreatIntelMode pointing to the current value.

type AzureFirewallsClient 

type AzureFirewallsClient struct {
	// contains filtered or unexported fields
}

AzureFirewallsClient contains the methods for the AzureFirewalls group. Don't use this type directly, use NewAzureFirewallsClient() instead.

func NewAzureFirewallsClient 

func NewAzureFirewallsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AzureFirewallsClient

NewAzureFirewallsClient creates a new instance of AzureFirewallsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AzureFirewallsClient) BeginCreateOrUpdate 

func (client *AzureFirewallsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, azureFirewallName string, parameters AzureFirewall, options *AzureFirewallsClientBeginCreateOrUpdateOptions) (AzureFirewallsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified Azure Firewall. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. azureFirewallName - The name of the Azure Firewall. parameters - Parameters supplied to the create or update Azure Firewall operation. options - AzureFirewallsClientBeginCreateOrUpdateOptions contains the optional parameters for the AzureFirewallsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AzureFirewallPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAzureFirewallsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<azure-firewall-name>",
		armnetwork.AzureFirewall{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.AzureFirewallPropertiesFormat{
				ApplicationRuleCollections: []*armnetwork.AzureFirewallApplicationRuleCollection{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.AzureFirewallApplicationRuleCollectionPropertiesFormat{
							Action: &armnetwork.AzureFirewallRCAction{
								Type: armnetwork.AzureFirewallRCActionType("Deny").ToPtr(),
							},
							Priority: to.Int32Ptr(110),
							Rules: []*armnetwork.AzureFirewallApplicationRule{
								{
									Name:        to.StringPtr("<name>"),
									Description: to.StringPtr("<description>"),
									Protocols: []*armnetwork.AzureFirewallApplicationRuleProtocol{
										{
											Port:         to.Int32Ptr(443),
											ProtocolType: armnetwork.AzureFirewallApplicationRuleProtocolType("Https").ToPtr(),
										}},
									SourceAddresses: []*string{
										to.StringPtr("216.58.216.164"),
										to.StringPtr("10.0.0.0/24")},
									TargetFqdns: []*string{
										to.StringPtr("www.test.com")},
								}},
						},
					}},
				IPConfigurations: []*armnetwork.AzureFirewallIPConfiguration{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.AzureFirewallIPConfigurationPropertiesFormat{
							PublicIPAddress: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							Subnet: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
				NatRuleCollections: []*armnetwork.AzureFirewallNatRuleCollection{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.AzureFirewallNatRuleCollectionProperties{
							Action: &armnetwork.AzureFirewallNatRCAction{
								Type: armnetwork.AzureFirewallNatRCActionType("Dnat").ToPtr(),
							},
							Priority: to.Int32Ptr(112),
							Rules: []*armnetwork.AzureFirewallNatRule{
								{
									Name:        to.StringPtr("<name>"),
									Description: to.StringPtr("<description>"),
									DestinationAddresses: []*string{
										to.StringPtr("1.2.3.4")},
									DestinationPorts: []*string{
										to.StringPtr("443")},
									Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
										armnetwork.AzureFirewallNetworkRuleProtocol("TCP").ToPtr()},
									SourceAddresses: []*string{
										to.StringPtr("*")},
									TranslatedAddress: to.StringPtr("<translated-address>"),
									TranslatedPort:    to.StringPtr("<translated-port>"),
								},
								{
									Name:        to.StringPtr("<name>"),
									Description: to.StringPtr("<description>"),
									DestinationAddresses: []*string{
										to.StringPtr("1.2.3.4")},
									DestinationPorts: []*string{
										to.StringPtr("80")},
									Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
										armnetwork.AzureFirewallNetworkRuleProtocol("TCP").ToPtr()},
									SourceAddresses: []*string{
										to.StringPtr("*")},
									TranslatedFqdn: to.StringPtr("<translated-fqdn>"),
									TranslatedPort: to.StringPtr("<translated-port>"),
								}},
						},
					}},
				NetworkRuleCollections: []*armnetwork.AzureFirewallNetworkRuleCollection{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.AzureFirewallNetworkRuleCollectionPropertiesFormat{
							Action: &armnetwork.AzureFirewallRCAction{
								Type: armnetwork.AzureFirewallRCActionType("Deny").ToPtr(),
							},
							Priority: to.Int32Ptr(112),
							Rules: []*armnetwork.AzureFirewallNetworkRule{
								{
									Name:        to.StringPtr("<name>"),
									Description: to.StringPtr("<description>"),
									DestinationAddresses: []*string{
										to.StringPtr("*")},
									DestinationPorts: []*string{
										to.StringPtr("443-444"),
										to.StringPtr("8443")},
									Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
										armnetwork.AzureFirewallNetworkRuleProtocol("TCP").ToPtr()},
									SourceAddresses: []*string{
										to.StringPtr("192.168.1.1-192.168.1.12"),
										to.StringPtr("10.1.4.12-10.1.4.255")},
								},
								{
									Name:        to.StringPtr("<name>"),
									Description: to.StringPtr("<description>"),
									DestinationFqdns: []*string{
										to.StringPtr("www.amazon.com")},
									DestinationPorts: []*string{
										to.StringPtr("443-444"),
										to.StringPtr("8443")},
									Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
										armnetwork.AzureFirewallNetworkRuleProtocol("TCP").ToPtr()},
									SourceAddresses: []*string{
										to.StringPtr("10.2.4.12-10.2.4.255")},
								}},
						},
					}},
				SKU: &armnetwork.AzureFirewallSKU{
					Name: armnetwork.AzureFirewallSKUName("AZFW_VNet").ToPtr(),
					Tier: armnetwork.AzureFirewallSKUTier("Standard").ToPtr(),
				},
				ThreatIntelMode: armnetwork.AzureFirewallThreatIntelMode("Alert").ToPtr(),
			},
			Zones: []*string{},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.AzureFirewallsClientCreateOrUpdateResult)
}

Output:

func (*AzureFirewallsClient) BeginDelete 

func (client *AzureFirewallsClient) BeginDelete(ctx context.Context, resourceGroupName string, azureFirewallName string, options *AzureFirewallsClientBeginDeleteOptions) (AzureFirewallsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified Azure Firewall. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. azureFirewallName - The name of the Azure Firewall. options - AzureFirewallsClientBeginDeleteOptions contains the optional parameters for the AzureFirewallsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AzureFirewallDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAzureFirewallsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<azure-firewall-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*AzureFirewallsClient) BeginUpdateTags 

func (client *AzureFirewallsClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, azureFirewallName string, parameters TagsObject, options *AzureFirewallsClientBeginUpdateTagsOptions) (AzureFirewallsClientUpdateTagsPollerResponse, error)

BeginUpdateTags - Updates tags of an Azure Firewall resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. azureFirewallName - The name of the Azure Firewall. parameters - Parameters supplied to update azure firewall tags. options - AzureFirewallsClientBeginUpdateTagsOptions contains the optional parameters for the AzureFirewallsClient.BeginUpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AzureFirewallUpdateTags.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAzureFirewallsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdateTags(ctx,
		"<resource-group-name>",
		"<azure-firewall-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.AzureFirewallsClientUpdateTagsResult)
}

Output:

func (*AzureFirewallsClient) Get 

func (client *AzureFirewallsClient) Get(ctx context.Context, resourceGroupName string, azureFirewallName string, options *AzureFirewallsClientGetOptions) (AzureFirewallsClientGetResponse, error)

Get - Gets the specified Azure Firewall. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. azureFirewallName - The name of the Azure Firewall. options - AzureFirewallsClientGetOptions contains the optional parameters for the AzureFirewallsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AzureFirewallGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAzureFirewallsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<azure-firewall-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.AzureFirewallsClientGetResult)
}

Output:

func (*AzureFirewallsClient) List 

func (client *AzureFirewallsClient) List(resourceGroupName string, options *AzureFirewallsClientListOptions) *AzureFirewallsClientListPager

List - Lists all Azure Firewalls in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - AzureFirewallsClientListOptions contains the optional parameters for the AzureFirewallsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AzureFirewallListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAzureFirewallsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*AzureFirewallsClient) ListAll 

func (client *AzureFirewallsClient) ListAll(options *AzureFirewallsClientListAllOptions) *AzureFirewallsClientListAllPager

ListAll - Gets all the Azure Firewalls in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - AzureFirewallsClientListAllOptions contains the optional parameters for the AzureFirewallsClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AzureFirewallListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewAzureFirewallsClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type AzureFirewallsClientBeginCreateOrUpdateOptions added in v0.3.0 

type AzureFirewallsClientBeginCreateOrUpdateOptions struct {
}

AzureFirewallsClientBeginCreateOrUpdateOptions contains the optional parameters for the AzureFirewallsClient.BeginCreateOrUpdate method.

type AzureFirewallsClientBeginDeleteOptions added in v0.3.0 

type AzureFirewallsClientBeginDeleteOptions struct {
}

AzureFirewallsClientBeginDeleteOptions contains the optional parameters for the AzureFirewallsClient.BeginDelete method.

type AzureFirewallsClientBeginUpdateTagsOptions added in v0.3.0 

type AzureFirewallsClientBeginUpdateTagsOptions struct {
}

AzureFirewallsClientBeginUpdateTagsOptions contains the optional parameters for the AzureFirewallsClient.BeginUpdateTags method.

type AzureFirewallsClientCreateOrUpdatePoller added in v0.3.0 

type AzureFirewallsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

AzureFirewallsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*AzureFirewallsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *AzureFirewallsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*AzureFirewallsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *AzureFirewallsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (AzureFirewallsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final AzureFirewallsClientCreateOrUpdateResponse will be returned.

func (*AzureFirewallsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *AzureFirewallsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*AzureFirewallsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *AzureFirewallsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type AzureFirewallsClientCreateOrUpdatePollerResponse added in v0.3.0 

type AzureFirewallsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *AzureFirewallsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AzureFirewallsClientCreateOrUpdatePollerResponse contains the response from method AzureFirewallsClient.CreateOrUpdate.

func (AzureFirewallsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l AzureFirewallsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (AzureFirewallsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*AzureFirewallsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *AzureFirewallsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *AzureFirewallsClient, token string) error

Resume rehydrates a AzureFirewallsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type AzureFirewallsClientCreateOrUpdateResponse added in v0.3.0 

type AzureFirewallsClientCreateOrUpdateResponse struct {
	AzureFirewallsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AzureFirewallsClientCreateOrUpdateResponse contains the response from method AzureFirewallsClient.CreateOrUpdate.

type AzureFirewallsClientCreateOrUpdateResult added in v0.3.0 

type AzureFirewallsClientCreateOrUpdateResult struct {
	AzureFirewall
}

AzureFirewallsClientCreateOrUpdateResult contains the result from method AzureFirewallsClient.CreateOrUpdate.

type AzureFirewallsClientDeletePoller added in v0.3.0 

type AzureFirewallsClientDeletePoller struct {
	// contains filtered or unexported fields
}

AzureFirewallsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*AzureFirewallsClientDeletePoller) Done added in v0.3.0 

func (p *AzureFirewallsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*AzureFirewallsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *AzureFirewallsClientDeletePoller) FinalResponse(ctx context.Context) (AzureFirewallsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final AzureFirewallsClientDeleteResponse will be returned.

func (*AzureFirewallsClientDeletePoller) Poll added in v0.3.0 

func (p *AzureFirewallsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*AzureFirewallsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *AzureFirewallsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type AzureFirewallsClientDeletePollerResponse added in v0.3.0 

type AzureFirewallsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *AzureFirewallsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AzureFirewallsClientDeletePollerResponse contains the response from method AzureFirewallsClient.Delete.

func (AzureFirewallsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l AzureFirewallsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (AzureFirewallsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*AzureFirewallsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *AzureFirewallsClientDeletePollerResponse) Resume(ctx context.Context, client *AzureFirewallsClient, token string) error

Resume rehydrates a AzureFirewallsClientDeletePollerResponse from the provided client and resume token.

type AzureFirewallsClientDeleteResponse added in v0.3.0 

type AzureFirewallsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AzureFirewallsClientDeleteResponse contains the response from method AzureFirewallsClient.Delete.

type AzureFirewallsClientGetOptions added in v0.3.0 

type AzureFirewallsClientGetOptions struct {
}

AzureFirewallsClientGetOptions contains the optional parameters for the AzureFirewallsClient.Get method.

type AzureFirewallsClientGetResponse added in v0.3.0 

type AzureFirewallsClientGetResponse struct {
	AzureFirewallsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AzureFirewallsClientGetResponse contains the response from method AzureFirewallsClient.Get.

type AzureFirewallsClientGetResult added in v0.3.0 

type AzureFirewallsClientGetResult struct {
	AzureFirewall
}

AzureFirewallsClientGetResult contains the result from method AzureFirewallsClient.Get.

type AzureFirewallsClientListAllOptions added in v0.3.0 

type AzureFirewallsClientListAllOptions struct {
}

AzureFirewallsClientListAllOptions contains the optional parameters for the AzureFirewallsClient.ListAll method.

type AzureFirewallsClientListAllPager added in v0.3.0 

type AzureFirewallsClientListAllPager struct {
	// contains filtered or unexported fields
}

AzureFirewallsClientListAllPager provides operations for iterating over paged responses.

func (*AzureFirewallsClientListAllPager) Err added in v0.3.0 

func (p *AzureFirewallsClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*AzureFirewallsClientListAllPager) NextPage added in v0.3.0 

func (p *AzureFirewallsClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AzureFirewallsClientListAllPager) PageResponse added in v0.3.0 

func (p *AzureFirewallsClientListAllPager) PageResponse() AzureFirewallsClientListAllResponse

PageResponse returns the current AzureFirewallsClientListAllResponse page.

type AzureFirewallsClientListAllResponse added in v0.3.0 

type AzureFirewallsClientListAllResponse struct {
	AzureFirewallsClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AzureFirewallsClientListAllResponse contains the response from method AzureFirewallsClient.ListAll.

type AzureFirewallsClientListAllResult added in v0.3.0 

type AzureFirewallsClientListAllResult struct {
	AzureFirewallListResult
}

AzureFirewallsClientListAllResult contains the result from method AzureFirewallsClient.ListAll.

type AzureFirewallsClientListOptions added in v0.3.0 

type AzureFirewallsClientListOptions struct {
}

AzureFirewallsClientListOptions contains the optional parameters for the AzureFirewallsClient.List method.

type AzureFirewallsClientListPager added in v0.3.0 

type AzureFirewallsClientListPager struct {
	// contains filtered or unexported fields
}

AzureFirewallsClientListPager provides operations for iterating over paged responses.

func (*AzureFirewallsClientListPager) Err added in v0.3.0 

func (p *AzureFirewallsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AzureFirewallsClientListPager) NextPage added in v0.3.0 

func (p *AzureFirewallsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AzureFirewallsClientListPager) PageResponse added in v0.3.0 

func (p *AzureFirewallsClientListPager) PageResponse() AzureFirewallsClientListResponse

PageResponse returns the current AzureFirewallsClientListResponse page.

type AzureFirewallsClientListResponse added in v0.3.0 

type AzureFirewallsClientListResponse struct {
	AzureFirewallsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AzureFirewallsClientListResponse contains the response from method AzureFirewallsClient.List.

type AzureFirewallsClientListResult added in v0.3.0 

type AzureFirewallsClientListResult struct {
	AzureFirewallListResult
}

AzureFirewallsClientListResult contains the result from method AzureFirewallsClient.List.

type AzureFirewallsClientUpdateTagsPoller added in v0.3.0 

type AzureFirewallsClientUpdateTagsPoller struct {
	// contains filtered or unexported fields
}

AzureFirewallsClientUpdateTagsPoller provides polling facilities until the operation reaches a terminal state.

func (*AzureFirewallsClientUpdateTagsPoller) Done added in v0.3.0 

func (p *AzureFirewallsClientUpdateTagsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*AzureFirewallsClientUpdateTagsPoller) FinalResponse added in v0.3.0 

func (p *AzureFirewallsClientUpdateTagsPoller) FinalResponse(ctx context.Context) (AzureFirewallsClientUpdateTagsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final AzureFirewallsClientUpdateTagsResponse will be returned.

func (*AzureFirewallsClientUpdateTagsPoller) Poll added in v0.3.0 

func (p *AzureFirewallsClientUpdateTagsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*AzureFirewallsClientUpdateTagsPoller) ResumeToken added in v0.3.0 

func (p *AzureFirewallsClientUpdateTagsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type AzureFirewallsClientUpdateTagsPollerResponse added in v0.3.0 

type AzureFirewallsClientUpdateTagsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *AzureFirewallsClientUpdateTagsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AzureFirewallsClientUpdateTagsPollerResponse contains the response from method AzureFirewallsClient.UpdateTags.

func (AzureFirewallsClientUpdateTagsPollerResponse) PollUntilDone added in v0.3.0 

func (l AzureFirewallsClientUpdateTagsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (AzureFirewallsClientUpdateTagsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*AzureFirewallsClientUpdateTagsPollerResponse) Resume added in v0.3.0 

func (l *AzureFirewallsClientUpdateTagsPollerResponse) Resume(ctx context.Context, client *AzureFirewallsClient, token string) error

Resume rehydrates a AzureFirewallsClientUpdateTagsPollerResponse from the provided client and resume token.

type AzureFirewallsClientUpdateTagsResponse added in v0.3.0 

type AzureFirewallsClientUpdateTagsResponse struct {
	AzureFirewallsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AzureFirewallsClientUpdateTagsResponse contains the response from method AzureFirewallsClient.UpdateTags.

type AzureFirewallsClientUpdateTagsResult added in v0.3.0 

type AzureFirewallsClientUpdateTagsResult struct {
	AzureFirewall
}

AzureFirewallsClientUpdateTagsResult contains the result from method AzureFirewallsClient.UpdateTags.

type AzureReachabilityReport 

type AzureReachabilityReport struct {
	// REQUIRED; The aggregation level of Azure reachability report. Can be Country, State or City.
	AggregationLevel *string `json:"aggregationLevel,omitempty"`

	// REQUIRED; Parameters that define a geographic location.
	ProviderLocation *AzureReachabilityReportLocation `json:"providerLocation,omitempty"`

	// REQUIRED; List of Azure reachability report items.
	ReachabilityReport []*AzureReachabilityReportItem `json:"reachabilityReport,omitempty"`
}

AzureReachabilityReport - Azure reachability report details.

func (AzureReachabilityReport) MarshalJSON 

func (a AzureReachabilityReport) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureReachabilityReport.

type AzureReachabilityReportItem 

type AzureReachabilityReportItem struct {
	// The Azure region.
	AzureLocation *string `json:"azureLocation,omitempty"`

	// List of latency details for each of the time series.
	Latencies []*AzureReachabilityReportLatencyInfo `json:"latencies,omitempty"`

	// The Internet service provider.
	Provider *string `json:"provider,omitempty"`
}

AzureReachabilityReportItem - Azure reachability report details for a given provider location.

func (AzureReachabilityReportItem) MarshalJSON 

func (a AzureReachabilityReportItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureReachabilityReportItem.

type AzureReachabilityReportLatencyInfo 

type AzureReachabilityReportLatencyInfo struct {
	// The relative latency score between 1 and 100, higher values indicating a faster connection.
	Score *int32 `json:"score,omitempty"`

	// The time stamp.
	TimeStamp *time.Time `json:"timeStamp,omitempty"`
}

AzureReachabilityReportLatencyInfo - Details on latency for a time series.

func (AzureReachabilityReportLatencyInfo) MarshalJSON 

func (a AzureReachabilityReportLatencyInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureReachabilityReportLatencyInfo.

func (*AzureReachabilityReportLatencyInfo) UnmarshalJSON 

func (a *AzureReachabilityReportLatencyInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureReachabilityReportLatencyInfo.

type AzureReachabilityReportLocation 

type AzureReachabilityReportLocation struct {
	// REQUIRED; The name of the country.
	Country *string `json:"country,omitempty"`

	// The name of the city or town.
	City *string `json:"city,omitempty"`

	// The name of the state.
	State *string `json:"state,omitempty"`
}

AzureReachabilityReportLocation - Parameters that define a geographic location.

type AzureReachabilityReportParameters 

type AzureReachabilityReportParameters struct {
	// REQUIRED; The end time for the Azure reachability report.
	EndTime *time.Time `json:"endTime,omitempty"`

	// REQUIRED; Parameters that define a geographic location.
	ProviderLocation *AzureReachabilityReportLocation `json:"providerLocation,omitempty"`

	// REQUIRED; The start time for the Azure reachability report.
	StartTime *time.Time `json:"startTime,omitempty"`

	// Optional Azure regions to scope the query to.
	AzureLocations []*string `json:"azureLocations,omitempty"`

	// List of Internet service providers.
	Providers []*string `json:"providers,omitempty"`
}

AzureReachabilityReportParameters - Geographic and time constraints for Azure reachability report.

func (AzureReachabilityReportParameters) MarshalJSON 

func (a AzureReachabilityReportParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureReachabilityReportParameters.

func (*AzureReachabilityReportParameters) UnmarshalJSON 

func (a *AzureReachabilityReportParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureReachabilityReportParameters.

type AzureWebCategory 

type AzureWebCategory struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Properties of the Azure Web Category.
	Properties *AzureWebCategoryPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

AzureWebCategory - Azure Web Category Resource.

type AzureWebCategoryListResult 

type AzureWebCategoryListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Azure Web Categories for a given Subscription.
	Value []*AzureWebCategory `json:"value,omitempty"`
}

AzureWebCategoryListResult - Response for ListAzureWebCategories API service call.

func (AzureWebCategoryListResult) MarshalJSON 

func (a AzureWebCategoryListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureWebCategoryListResult.

type AzureWebCategoryPropertiesFormat 

type AzureWebCategoryPropertiesFormat struct {
	// READ-ONLY; The name of the group that the category belongs to.
	Group *string `json:"group,omitempty" azure:"ro"`
}

AzureWebCategoryPropertiesFormat - Azure Web Category Properties.

type BGPCommunity 

type BGPCommunity struct {
	// The name of the bgp community. e.g. Skype.
	CommunityName *string `json:"communityName,omitempty"`

	// The prefixes that the bgp community contains.
	CommunityPrefixes []*string `json:"communityPrefixes,omitempty"`

	// The value of the bgp community. For more information: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing.
	CommunityValue *string `json:"communityValue,omitempty"`

	// Customer is authorized to use bgp community or not.
	IsAuthorizedToUse *bool `json:"isAuthorizedToUse,omitempty"`

	// The service group of the bgp community contains.
	ServiceGroup *string `json:"serviceGroup,omitempty"`

	// The region which the service support. e.g. For O365, region is Global.
	ServiceSupportedRegion *string `json:"serviceSupportedRegion,omitempty"`
}

BGPCommunity - Contains bgp community information offered in Service Community resources.

func (BGPCommunity) MarshalJSON 

func (b BGPCommunity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BGPCommunity.

type BackendAddressInboundNatRulePortMappings added in v0.2.0 

type BackendAddressInboundNatRulePortMappings struct {
	// Collection of inbound NAT rule port mappings.
	InboundNatRulePortMappings []*InboundNatRulePortMapping `json:"inboundNatRulePortMappings,omitempty"`
}

BackendAddressInboundNatRulePortMappings - The response for a QueryInboundNatRulePortMapping API.

func (BackendAddressInboundNatRulePortMappings) MarshalJSON added in v0.2.0 

func (b BackendAddressInboundNatRulePortMappings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackendAddressInboundNatRulePortMappings.

type BackendAddressPool 

type BackendAddressPool struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can
	// be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of load balancer backend address pool.
	Properties *BackendAddressPoolPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BackendAddressPool - Pool of backend IP addresses.

type BackendAddressPoolPropertiesFormat 

type BackendAddressPoolPropertiesFormat struct {
	// An array of backend addresses.
	LoadBalancerBackendAddresses []*LoadBalancerBackendAddress `json:"loadBalancerBackendAddresses,omitempty"`

	// The location of the backend address pool.
	Location *string `json:"location,omitempty"`

	// An array of gateway load balancer tunnel interfaces.
	TunnelInterfaces []*GatewayLoadBalancerTunnelInterface `json:"tunnelInterfaces,omitempty"`

	// READ-ONLY; An array of references to IP addresses defined in network interfaces.
	BackendIPConfigurations []*InterfaceIPConfiguration `json:"backendIPConfigurations,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to inbound NAT rules that use this backend address pool.
	InboundNatRules []*SubResource `json:"inboundNatRules,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to load balancing rules that use this backend address pool.
	LoadBalancingRules []*SubResource `json:"loadBalancingRules,omitempty" azure:"ro"`

	// READ-ONLY; A reference to an outbound rule that uses this backend address pool.
	OutboundRule *SubResource `json:"outboundRule,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to outbound rules that use this backend address pool.
	OutboundRules []*SubResource `json:"outboundRules,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the backend address pool resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

BackendAddressPoolPropertiesFormat - Properties of the backend address pool.

func (BackendAddressPoolPropertiesFormat) MarshalJSON 

func (b BackendAddressPoolPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackendAddressPoolPropertiesFormat.

type BastionActiveSession 

type BastionActiveSession struct {
	// READ-ONLY; The protocol used to connect to the target.
	Protocol *BastionConnectProtocol `json:"protocol,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource.
	ResourceType *string `json:"resourceType,omitempty" azure:"ro"`

	// READ-ONLY; Duration in mins the session has been active.
	SessionDurationInMins *float32 `json:"sessionDurationInMins,omitempty" azure:"ro"`

	// READ-ONLY; A unique id for the session.
	SessionID *string `json:"sessionId,omitempty" azure:"ro"`

	// READ-ONLY; The time when the session started.
	StartTime map[string]interface{} `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; The host name of the target.
	TargetHostName *string `json:"targetHostName,omitempty" azure:"ro"`

	// READ-ONLY; The IP Address of the target.
	TargetIPAddress *string `json:"targetIpAddress,omitempty" azure:"ro"`

	// READ-ONLY; The resource group of the target.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty" azure:"ro"`

	// READ-ONLY; The resource id of the target.
	TargetResourceID *string `json:"targetResourceId,omitempty" azure:"ro"`

	// READ-ONLY; The subscription id for the target virtual machine.
	TargetSubscriptionID *string `json:"targetSubscriptionId,omitempty" azure:"ro"`

	// READ-ONLY; The user name who is active on this session.
	UserName *string `json:"userName,omitempty" azure:"ro"`
}

BastionActiveSession - The session detail for a target.

type BastionActiveSessionListResult 

type BastionActiveSessionListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of active sessions on the bastion.
	Value []*BastionActiveSession `json:"value,omitempty"`
}

BastionActiveSessionListResult - Response for GetActiveSessions.

func (BastionActiveSessionListResult) MarshalJSON 

func (b BastionActiveSessionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionActiveSessionListResult.

type BastionConnectProtocol 

type BastionConnectProtocol string

BastionConnectProtocol - The protocol used to connect to the target. 

const (
	BastionConnectProtocolRDP BastionConnectProtocol = "RDP"
	BastionConnectProtocolSSH BastionConnectProtocol = "SSH"
)

func PossibleBastionConnectProtocolValues 

func PossibleBastionConnectProtocolValues() []BastionConnectProtocol

PossibleBastionConnectProtocolValues returns the possible values for the BastionConnectProtocol const type.

func (BastionConnectProtocol) ToPtr 

func (c BastionConnectProtocol) ToPtr() *BastionConnectProtocol

ToPtr returns a *BastionConnectProtocol pointing to the current value.

type BastionHost 

type BastionHost struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Represents the bastion host resource.
	Properties *BastionHostPropertiesFormat `json:"properties,omitempty"`

	// The sku of this Bastion Host.
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BastionHost - Bastion Host resource.

func (BastionHost) MarshalJSON 

func (b BastionHost) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionHost.

type BastionHostIPConfiguration 

type BastionHostIPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Represents the ip configuration associated with the resource.
	Properties *BastionHostIPConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Ip configuration type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BastionHostIPConfiguration - IP configuration of an Bastion Host.

type BastionHostIPConfigurationPropertiesFormat 

type BastionHostIPConfigurationPropertiesFormat struct {
	// REQUIRED; Reference of the PublicIP resource.
	PublicIPAddress *SubResource `json:"publicIPAddress,omitempty"`

	// REQUIRED; Reference of the subnet resource.
	Subnet *SubResource `json:"subnet,omitempty"`

	// Private IP allocation method.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// READ-ONLY; The provisioning state of the bastion host IP configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

BastionHostIPConfigurationPropertiesFormat - Properties of IP configuration of an Bastion Host.

type BastionHostListResult 

type BastionHostListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Bastion Hosts in a resource group.
	Value []*BastionHost `json:"value,omitempty"`
}

BastionHostListResult - Response for ListBastionHosts API service call.

func (BastionHostListResult) MarshalJSON 

func (b BastionHostListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionHostListResult.

type BastionHostPropertiesFormat 

type BastionHostPropertiesFormat struct {
	// FQDN for the endpoint on which bastion host is accessible.
	DNSName *string `json:"dnsName,omitempty"`

	// Enable/Disable Copy/Paste feature of the Bastion Host resource.
	DisableCopyPaste *bool `json:"disableCopyPaste,omitempty"`

	// Enable/Disable File Copy feature of the Bastion Host resource.
	EnableFileCopy *bool `json:"enableFileCopy,omitempty"`

	// Enable/Disable IP Connect feature of the Bastion Host resource.
	EnableIPConnect *bool `json:"enableIpConnect,omitempty"`

	// Enable/Disable Shareable Link of the Bastion Host resource.
	EnableShareableLink *bool `json:"enableShareableLink,omitempty"`

	// Enable/Disable Tunneling feature of the Bastion Host resource.
	EnableTunneling *bool `json:"enableTunneling,omitempty"`

	// IP configuration of the Bastion Host resource.
	IPConfigurations []*BastionHostIPConfiguration `json:"ipConfigurations,omitempty"`

	// The scale units for the Bastion Host resource.
	ScaleUnits *int32 `json:"scaleUnits,omitempty"`

	// READ-ONLY; The provisioning state of the bastion host resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

BastionHostPropertiesFormat - Properties of the Bastion Host.

func (BastionHostPropertiesFormat) MarshalJSON 

func (b BastionHostPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionHostPropertiesFormat.

type BastionHostSKUName 

type BastionHostSKUName string

BastionHostSKUName - The name of this Bastion Host. 

const (
	BastionHostSKUNameBasic    BastionHostSKUName = "Basic"
	BastionHostSKUNameStandard BastionHostSKUName = "Standard"
)

func PossibleBastionHostSKUNameValues 

func PossibleBastionHostSKUNameValues() []BastionHostSKUName

PossibleBastionHostSKUNameValues returns the possible values for the BastionHostSKUName const type.

func (BastionHostSKUName) ToPtr 

func (c BastionHostSKUName) ToPtr() *BastionHostSKUName

ToPtr returns a *BastionHostSKUName pointing to the current value.

type BastionHostsClient 

type BastionHostsClient struct {
	// contains filtered or unexported fields
}

BastionHostsClient contains the methods for the BastionHosts group. Don't use this type directly, use NewBastionHostsClient() instead.

func NewBastionHostsClient 

func NewBastionHostsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *BastionHostsClient

NewBastionHostsClient creates a new instance of BastionHostsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*BastionHostsClient) BeginCreateOrUpdate 

func (client *BastionHostsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, bastionHostName string, parameters BastionHost, options *BastionHostsClientBeginCreateOrUpdateOptions) (BastionHostsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified Bastion Host. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. bastionHostName - The name of the Bastion Host. parameters - Parameters supplied to the create or update Bastion Host operation. options - BastionHostsClientBeginCreateOrUpdateOptions contains the optional parameters for the BastionHostsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/BastionHostPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewBastionHostsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<bastion-host-name>",
		armnetwork.BastionHost{
			Properties: &armnetwork.BastionHostPropertiesFormat{
				IPConfigurations: []*armnetwork.BastionHostIPConfiguration{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.BastionHostIPConfigurationPropertiesFormat{
							PublicIPAddress: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							Subnet: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.BastionHostsClientCreateOrUpdateResult)
}

Output:

func (*BastionHostsClient) BeginDelete 

func (client *BastionHostsClient) BeginDelete(ctx context.Context, resourceGroupName string, bastionHostName string, options *BastionHostsClientBeginDeleteOptions) (BastionHostsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified Bastion Host. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. bastionHostName - The name of the Bastion Host. options - BastionHostsClientBeginDeleteOptions contains the optional parameters for the BastionHostsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/BastionHostDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewBastionHostsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<bastion-host-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*BastionHostsClient) BeginUpdateTags 

func (client *BastionHostsClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, bastionHostName string, parameters TagsObject, options *BastionHostsClientBeginUpdateTagsOptions) (BastionHostsClientUpdateTagsPollerResponse, error)

BeginUpdateTags - Updates Tags for BastionHost resource If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. bastionHostName - The name of the Bastion Host. parameters - Parameters supplied to update BastionHost tags. options - BastionHostsClientBeginUpdateTagsOptions contains the optional parameters for the BastionHostsClient.BeginUpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/BastionHostPatch.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewBastionHostsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdateTags(ctx,
		"<resource-group-name>",
		"<bastion-host-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.BastionHostsClientUpdateTagsResult)
}

Output:

func (*BastionHostsClient) Get 

func (client *BastionHostsClient) Get(ctx context.Context, resourceGroupName string, bastionHostName string, options *BastionHostsClientGetOptions) (BastionHostsClientGetResponse, error)

Get - Gets the specified Bastion Host. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. bastionHostName - The name of the Bastion Host. options - BastionHostsClientGetOptions contains the optional parameters for the BastionHostsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/BastionHostGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewBastionHostsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<bastion-host-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.BastionHostsClientGetResult)
}

Output:

func (*BastionHostsClient) List 

func (client *BastionHostsClient) List(options *BastionHostsClientListOptions) *BastionHostsClientListPager

List - Lists all Bastion Hosts in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - BastionHostsClientListOptions contains the optional parameters for the BastionHostsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/BastionHostListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewBastionHostsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*BastionHostsClient) ListByResourceGroup 

func (client *BastionHostsClient) ListByResourceGroup(resourceGroupName string, options *BastionHostsClientListByResourceGroupOptions) *BastionHostsClientListByResourceGroupPager

ListByResourceGroup - Lists all Bastion Hosts in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - BastionHostsClientListByResourceGroupOptions contains the optional parameters for the BastionHostsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/BastionHostListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewBastionHostsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type BastionHostsClientBeginCreateOrUpdateOptions added in v0.3.0 

type BastionHostsClientBeginCreateOrUpdateOptions struct {
}

BastionHostsClientBeginCreateOrUpdateOptions contains the optional parameters for the BastionHostsClient.BeginCreateOrUpdate method.

type BastionHostsClientBeginDeleteOptions added in v0.3.0 

type BastionHostsClientBeginDeleteOptions struct {
}

BastionHostsClientBeginDeleteOptions contains the optional parameters for the BastionHostsClient.BeginDelete method.

type BastionHostsClientBeginUpdateTagsOptions added in v0.3.0 

type BastionHostsClientBeginUpdateTagsOptions struct {
}

BastionHostsClientBeginUpdateTagsOptions contains the optional parameters for the BastionHostsClient.BeginUpdateTags method.

type BastionHostsClientCreateOrUpdatePoller added in v0.3.0 

type BastionHostsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

BastionHostsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*BastionHostsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *BastionHostsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*BastionHostsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *BastionHostsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (BastionHostsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final BastionHostsClientCreateOrUpdateResponse will be returned.

func (*BastionHostsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *BastionHostsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*BastionHostsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *BastionHostsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type BastionHostsClientCreateOrUpdatePollerResponse added in v0.3.0 

type BastionHostsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *BastionHostsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BastionHostsClientCreateOrUpdatePollerResponse contains the response from method BastionHostsClient.CreateOrUpdate.

func (BastionHostsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l BastionHostsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (BastionHostsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*BastionHostsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *BastionHostsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *BastionHostsClient, token string) error

Resume rehydrates a BastionHostsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type BastionHostsClientCreateOrUpdateResponse added in v0.3.0 

type BastionHostsClientCreateOrUpdateResponse struct {
	BastionHostsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BastionHostsClientCreateOrUpdateResponse contains the response from method BastionHostsClient.CreateOrUpdate.

type BastionHostsClientCreateOrUpdateResult added in v0.3.0 

type BastionHostsClientCreateOrUpdateResult struct {
	BastionHost
}

BastionHostsClientCreateOrUpdateResult contains the result from method BastionHostsClient.CreateOrUpdate.

type BastionHostsClientDeletePoller added in v0.3.0 

type BastionHostsClientDeletePoller struct {
	// contains filtered or unexported fields
}

BastionHostsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*BastionHostsClientDeletePoller) Done added in v0.3.0 

func (p *BastionHostsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*BastionHostsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *BastionHostsClientDeletePoller) FinalResponse(ctx context.Context) (BastionHostsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final BastionHostsClientDeleteResponse will be returned.

func (*BastionHostsClientDeletePoller) Poll added in v0.3.0 

func (p *BastionHostsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*BastionHostsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *BastionHostsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type BastionHostsClientDeletePollerResponse added in v0.3.0 

type BastionHostsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *BastionHostsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BastionHostsClientDeletePollerResponse contains the response from method BastionHostsClient.Delete.

func (BastionHostsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l BastionHostsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (BastionHostsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*BastionHostsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *BastionHostsClientDeletePollerResponse) Resume(ctx context.Context, client *BastionHostsClient, token string) error

Resume rehydrates a BastionHostsClientDeletePollerResponse from the provided client and resume token.

type BastionHostsClientDeleteResponse added in v0.3.0 

type BastionHostsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BastionHostsClientDeleteResponse contains the response from method BastionHostsClient.Delete.

type BastionHostsClientGetOptions added in v0.3.0 

type BastionHostsClientGetOptions struct {
}

BastionHostsClientGetOptions contains the optional parameters for the BastionHostsClient.Get method.

type BastionHostsClientGetResponse added in v0.3.0 

type BastionHostsClientGetResponse struct {
	BastionHostsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BastionHostsClientGetResponse contains the response from method BastionHostsClient.Get.

type BastionHostsClientGetResult added in v0.3.0 

type BastionHostsClientGetResult struct {
	BastionHost
}

BastionHostsClientGetResult contains the result from method BastionHostsClient.Get.

type BastionHostsClientListByResourceGroupOptions added in v0.3.0 

type BastionHostsClientListByResourceGroupOptions struct {
}

BastionHostsClientListByResourceGroupOptions contains the optional parameters for the BastionHostsClient.ListByResourceGroup method.

type BastionHostsClientListByResourceGroupPager added in v0.3.0 

type BastionHostsClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

BastionHostsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*BastionHostsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *BastionHostsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*BastionHostsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *BastionHostsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*BastionHostsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *BastionHostsClientListByResourceGroupPager) PageResponse() BastionHostsClientListByResourceGroupResponse

PageResponse returns the current BastionHostsClientListByResourceGroupResponse page.

type BastionHostsClientListByResourceGroupResponse added in v0.3.0 

type BastionHostsClientListByResourceGroupResponse struct {
	BastionHostsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BastionHostsClientListByResourceGroupResponse contains the response from method BastionHostsClient.ListByResourceGroup.

type BastionHostsClientListByResourceGroupResult added in v0.3.0 

type BastionHostsClientListByResourceGroupResult struct {
	BastionHostListResult
}

BastionHostsClientListByResourceGroupResult contains the result from method BastionHostsClient.ListByResourceGroup.

type BastionHostsClientListOptions added in v0.3.0 

type BastionHostsClientListOptions struct {
}

BastionHostsClientListOptions contains the optional parameters for the BastionHostsClient.List method.

type BastionHostsClientListPager added in v0.3.0 

type BastionHostsClientListPager struct {
	// contains filtered or unexported fields
}

BastionHostsClientListPager provides operations for iterating over paged responses.

func (*BastionHostsClientListPager) Err added in v0.3.0 

func (p *BastionHostsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*BastionHostsClientListPager) NextPage added in v0.3.0 

func (p *BastionHostsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*BastionHostsClientListPager) PageResponse added in v0.3.0 

func (p *BastionHostsClientListPager) PageResponse() BastionHostsClientListResponse

PageResponse returns the current BastionHostsClientListResponse page.

type BastionHostsClientListResponse added in v0.3.0 

type BastionHostsClientListResponse struct {
	BastionHostsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BastionHostsClientListResponse contains the response from method BastionHostsClient.List.

type BastionHostsClientListResult added in v0.3.0 

type BastionHostsClientListResult struct {
	BastionHostListResult
}

BastionHostsClientListResult contains the result from method BastionHostsClient.List.

type BastionHostsClientUpdateTagsPoller added in v0.3.0 

type BastionHostsClientUpdateTagsPoller struct {
	// contains filtered or unexported fields
}

BastionHostsClientUpdateTagsPoller provides polling facilities until the operation reaches a terminal state.

func (*BastionHostsClientUpdateTagsPoller) Done added in v0.3.0 

func (p *BastionHostsClientUpdateTagsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*BastionHostsClientUpdateTagsPoller) FinalResponse added in v0.3.0 

func (p *BastionHostsClientUpdateTagsPoller) FinalResponse(ctx context.Context) (BastionHostsClientUpdateTagsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final BastionHostsClientUpdateTagsResponse will be returned.

func (*BastionHostsClientUpdateTagsPoller) Poll added in v0.3.0 

func (p *BastionHostsClientUpdateTagsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*BastionHostsClientUpdateTagsPoller) ResumeToken added in v0.3.0 

func (p *BastionHostsClientUpdateTagsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type BastionHostsClientUpdateTagsPollerResponse added in v0.3.0 

type BastionHostsClientUpdateTagsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *BastionHostsClientUpdateTagsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BastionHostsClientUpdateTagsPollerResponse contains the response from method BastionHostsClient.UpdateTags.

func (BastionHostsClientUpdateTagsPollerResponse) PollUntilDone added in v0.3.0 

func (l BastionHostsClientUpdateTagsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (BastionHostsClientUpdateTagsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*BastionHostsClientUpdateTagsPollerResponse) Resume added in v0.3.0 

func (l *BastionHostsClientUpdateTagsPollerResponse) Resume(ctx context.Context, client *BastionHostsClient, token string) error

Resume rehydrates a BastionHostsClientUpdateTagsPollerResponse from the provided client and resume token.

type BastionHostsClientUpdateTagsResponse added in v0.3.0 

type BastionHostsClientUpdateTagsResponse struct {
	BastionHostsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BastionHostsClientUpdateTagsResponse contains the response from method BastionHostsClient.UpdateTags.

type BastionHostsClientUpdateTagsResult added in v0.3.0 

type BastionHostsClientUpdateTagsResult struct {
	BastionHost
}

BastionHostsClientUpdateTagsResult contains the result from method BastionHostsClient.UpdateTags.

type BastionSessionDeleteResult 

type BastionSessionDeleteResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of sessions with their corresponding state.
	Value []*BastionSessionState `json:"value,omitempty"`
}

BastionSessionDeleteResult - Response for DisconnectActiveSessions.

func (BastionSessionDeleteResult) MarshalJSON 

func (b BastionSessionDeleteResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionSessionDeleteResult.

type BastionSessionState 

type BastionSessionState struct {
	// READ-ONLY; Used for extra information.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; A unique id for the session.
	SessionID *string `json:"sessionId,omitempty" azure:"ro"`

	// READ-ONLY; The state of the session. Disconnected/Failed/NotFound.
	State *string `json:"state,omitempty" azure:"ro"`
}

BastionSessionState - The session state detail for a target. 

type BastionShareableLink struct {
	// REQUIRED; Reference of the virtual machine resource.
	VM *VM `json:"vm,omitempty"`

	// READ-ONLY; The unique Bastion Shareable Link to the virtual machine.
	Bsl *string `json:"bsl,omitempty" azure:"ro"`

	// READ-ONLY; The time when the link was created.
	CreatedAt *string `json:"createdAt,omitempty" azure:"ro"`

	// READ-ONLY; Optional field indicating the warning or error message related to the vm in case of partial failure.
	Message *string `json:"message,omitempty" azure:"ro"`
}

BastionShareableLink - Bastion Shareable Link.

type BastionShareableLinkListRequest 

type BastionShareableLinkListRequest struct {
	// List of VM references.
	VMs []*BastionShareableLink `json:"vms,omitempty"`
}

BastionShareableLinkListRequest - Post request for all the Bastion Shareable Link endpoints.

func (BastionShareableLinkListRequest) MarshalJSON 

func (b BastionShareableLinkListRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionShareableLinkListRequest.

type BastionShareableLinkListResult 

type BastionShareableLinkListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Bastion Shareable Links for the request.
	Value []*BastionShareableLink `json:"value,omitempty"`
}

BastionShareableLinkListResult - Response for all the Bastion Shareable Link endpoints.

func (BastionShareableLinkListResult) MarshalJSON 

func (b BastionShareableLinkListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionShareableLinkListResult.

type BgpConnection 

type BgpConnection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the connection.
	Name *string `json:"name,omitempty"`

	// The properties of the Bgp connections.
	Properties *BgpConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Connection type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BgpConnection - Virtual Appliance Site resource.

type BgpConnectionProperties 

type BgpConnectionProperties struct {
	// The reference to the HubVirtualNetworkConnection resource.
	HubVirtualNetworkConnection *SubResource `json:"hubVirtualNetworkConnection,omitempty"`

	// Peer ASN.
	PeerAsn *int64 `json:"peerAsn,omitempty"`

	// Peer IP.
	PeerIP *string `json:"peerIp,omitempty"`

	// READ-ONLY; The current state of the VirtualHub to Peer.
	ConnectionState *HubBgpConnectionStatus `json:"connectionState,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

BgpConnectionProperties - Properties of the bgp connection.

type BgpPeerState 

type BgpPeerState string

BgpPeerState - The BGP peer state. 

const (
	BgpPeerStateConnected  BgpPeerState = "Connected"
	BgpPeerStateConnecting BgpPeerState = "Connecting"
	BgpPeerStateIdle       BgpPeerState = "Idle"
	BgpPeerStateStopped    BgpPeerState = "Stopped"
	BgpPeerStateUnknown    BgpPeerState = "Unknown"
)

func PossibleBgpPeerStateValues 

func PossibleBgpPeerStateValues() []BgpPeerState

PossibleBgpPeerStateValues returns the possible values for the BgpPeerState const type.

func (BgpPeerState) ToPtr 

func (c BgpPeerState) ToPtr() *BgpPeerState

ToPtr returns a *BgpPeerState pointing to the current value.

type BgpPeerStatus 

type BgpPeerStatus struct {
	// READ-ONLY; The autonomous system number of the remote BGP peer.
	Asn *int64 `json:"asn,omitempty" azure:"ro"`

	// READ-ONLY; For how long the peering has been up.
	ConnectedDuration *string `json:"connectedDuration,omitempty" azure:"ro"`

	// READ-ONLY; The virtual network gateway's local address.
	LocalAddress *string `json:"localAddress,omitempty" azure:"ro"`

	// READ-ONLY; The number of BGP messages received.
	MessagesReceived *int64 `json:"messagesReceived,omitempty" azure:"ro"`

	// READ-ONLY; The number of BGP messages sent.
	MessagesSent *int64 `json:"messagesSent,omitempty" azure:"ro"`

	// READ-ONLY; The remote BGP peer.
	Neighbor *string `json:"neighbor,omitempty" azure:"ro"`

	// READ-ONLY; The number of routes learned from this peer.
	RoutesReceived *int64 `json:"routesReceived,omitempty" azure:"ro"`

	// READ-ONLY; The BGP peer state.
	State *BgpPeerState `json:"state,omitempty" azure:"ro"`
}

BgpPeerStatus - BGP peer status details.

type BgpPeerStatusListResult 

type BgpPeerStatusListResult struct {
	// List of BGP peers.
	Value []*BgpPeerStatus `json:"value,omitempty"`
}

BgpPeerStatusListResult - Response for list BGP peer status API service call.

func (BgpPeerStatusListResult) MarshalJSON 

func (b BgpPeerStatusListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BgpPeerStatusListResult.

type BgpServiceCommunitiesClient 

type BgpServiceCommunitiesClient struct {
	// contains filtered or unexported fields
}

BgpServiceCommunitiesClient contains the methods for the BgpServiceCommunities group. Don't use this type directly, use NewBgpServiceCommunitiesClient() instead.

func NewBgpServiceCommunitiesClient 

func NewBgpServiceCommunitiesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *BgpServiceCommunitiesClient

NewBgpServiceCommunitiesClient creates a new instance of BgpServiceCommunitiesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*BgpServiceCommunitiesClient) List 

func (client *BgpServiceCommunitiesClient) List(options *BgpServiceCommunitiesClientListOptions) *BgpServiceCommunitiesClientListPager

List - Gets all the available bgp service communities. If the operation fails it returns an *azcore.ResponseError type. options - BgpServiceCommunitiesClientListOptions contains the optional parameters for the BgpServiceCommunitiesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceCommunityList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewBgpServiceCommunitiesClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type BgpServiceCommunitiesClientListOptions added in v0.3.0 

type BgpServiceCommunitiesClientListOptions struct {
}

BgpServiceCommunitiesClientListOptions contains the optional parameters for the BgpServiceCommunitiesClient.List method.

type BgpServiceCommunitiesClientListPager added in v0.3.0 

type BgpServiceCommunitiesClientListPager struct {
	// contains filtered or unexported fields
}

BgpServiceCommunitiesClientListPager provides operations for iterating over paged responses.

func (*BgpServiceCommunitiesClientListPager) Err added in v0.3.0 

func (p *BgpServiceCommunitiesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*BgpServiceCommunitiesClientListPager) NextPage added in v0.3.0 

func (p *BgpServiceCommunitiesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*BgpServiceCommunitiesClientListPager) PageResponse added in v0.3.0 

func (p *BgpServiceCommunitiesClientListPager) PageResponse() BgpServiceCommunitiesClientListResponse

PageResponse returns the current BgpServiceCommunitiesClientListResponse page.

type BgpServiceCommunitiesClientListResponse added in v0.3.0 

type BgpServiceCommunitiesClientListResponse struct {
	BgpServiceCommunitiesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

BgpServiceCommunitiesClientListResponse contains the response from method BgpServiceCommunitiesClient.List.

type BgpServiceCommunitiesClientListResult added in v0.3.0 

type BgpServiceCommunitiesClientListResult struct {
	BgpServiceCommunityListResult
}

BgpServiceCommunitiesClientListResult contains the result from method BgpServiceCommunitiesClient.List.

type BgpServiceCommunity 

type BgpServiceCommunity struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the BGP service community.
	Properties *BgpServiceCommunityPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

BgpServiceCommunity - Service Community Properties.

func (BgpServiceCommunity) MarshalJSON 

func (b BgpServiceCommunity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BgpServiceCommunity.

type BgpServiceCommunityListResult 

type BgpServiceCommunityListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of service community resources.
	Value []*BgpServiceCommunity `json:"value,omitempty"`
}

BgpServiceCommunityListResult - Response for the ListServiceCommunity API service call.

func (BgpServiceCommunityListResult) MarshalJSON 

func (b BgpServiceCommunityListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BgpServiceCommunityListResult.

type BgpServiceCommunityPropertiesFormat 

type BgpServiceCommunityPropertiesFormat struct {
	// A list of bgp communities.
	BgpCommunities []*BGPCommunity `json:"bgpCommunities,omitempty"`

	// The name of the bgp community. e.g. Skype.
	ServiceName *string `json:"serviceName,omitempty"`
}

BgpServiceCommunityPropertiesFormat - Properties of Service Community.

func (BgpServiceCommunityPropertiesFormat) MarshalJSON 

func (b BgpServiceCommunityPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BgpServiceCommunityPropertiesFormat.

type BgpSettings 

type BgpSettings struct {
	// The BGP speaker's ASN.
	Asn *int64 `json:"asn,omitempty"`

	// The BGP peering address and BGP identifier of this BGP speaker.
	BgpPeeringAddress *string `json:"bgpPeeringAddress,omitempty"`

	// BGP peering address with IP configuration ID for virtual network gateway.
	BgpPeeringAddresses []*IPConfigurationBgpPeeringAddress `json:"bgpPeeringAddresses,omitempty"`

	// The weight added to routes learned from this BGP speaker.
	PeerWeight *int32 `json:"peerWeight,omitempty"`
}

BgpSettings - BGP settings details.

func (BgpSettings) MarshalJSON 

func (b BgpSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BgpSettings.

type BreakOutCategoryPolicies 

type BreakOutCategoryPolicies struct {
	// Flag to control breakout of o365 allow category.
	Allow *bool `json:"allow,omitempty"`

	// Flag to control breakout of o365 default category.
	Default *bool `json:"default,omitempty"`

	// Flag to control breakout of o365 optimize category.
	Optimize *bool `json:"optimize,omitempty"`
}

BreakOutCategoryPolicies - Network Virtual Appliance Sku Properties.

type CheckPrivateLinkServiceVisibilityRequest 

type CheckPrivateLinkServiceVisibilityRequest struct {
	// The alias of the private link service.
	PrivateLinkServiceAlias *string `json:"privateLinkServiceAlias,omitempty"`
}

CheckPrivateLinkServiceVisibilityRequest - Request body of the CheckPrivateLinkServiceVisibility API service call.

type CircuitConnectionStatus 

type CircuitConnectionStatus string

CircuitConnectionStatus - Express Route Circuit connection state. 

const (
	CircuitConnectionStatusConnected    CircuitConnectionStatus = "Connected"
	CircuitConnectionStatusConnecting   CircuitConnectionStatus = "Connecting"
	CircuitConnectionStatusDisconnected CircuitConnectionStatus = "Disconnected"
)

func PossibleCircuitConnectionStatusValues 

func PossibleCircuitConnectionStatusValues() []CircuitConnectionStatus

PossibleCircuitConnectionStatusValues returns the possible values for the CircuitConnectionStatus const type.

func (CircuitConnectionStatus) ToPtr 

func (c CircuitConnectionStatus) ToPtr() *CircuitConnectionStatus

ToPtr returns a *CircuitConnectionStatus pointing to the current value.

type CloudError 

type CloudError struct {
	// Cloud error body.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError - An error response from the service.

type CloudErrorBody 

type CloudErrorBody struct {
	// An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`

	// A list of additional details about the error.
	Details []*CloudErrorBody `json:"details,omitempty"`

	// A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`

	// The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
}

CloudErrorBody - An error response from the service.

func (CloudErrorBody) MarshalJSON 

func (c CloudErrorBody) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudErrorBody.

type CommissionedState 

type CommissionedState string

CommissionedState - The commissioned state of the Custom IP Prefix. 

const (
	CommissionedStateCommissioned    CommissionedState = "Commissioned"
	CommissionedStateCommissioning   CommissionedState = "Commissioning"
	CommissionedStateDecommissioning CommissionedState = "Decommissioning"
	CommissionedStateDeprovisioning  CommissionedState = "Deprovisioning"
	CommissionedStateProvisioned     CommissionedState = "Provisioned"
	CommissionedStateProvisioning    CommissionedState = "Provisioning"
)

func PossibleCommissionedStateValues 

func PossibleCommissionedStateValues() []CommissionedState

PossibleCommissionedStateValues returns the possible values for the CommissionedState const type.

func (CommissionedState) ToPtr 

func (c CommissionedState) ToPtr() *CommissionedState

ToPtr returns a *CommissionedState pointing to the current value.

type Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties 

type Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties struct {
	// READ-ONLY; The client id of user assigned identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal id of user assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

type ConfigurationDiagnosticParameters added in v0.3.0 

type ConfigurationDiagnosticParameters struct {
	// REQUIRED; List of network configuration diagnostic profiles.
	Profiles []*ConfigurationDiagnosticProfile `json:"profiles,omitempty"`

	// REQUIRED; The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface,
	// VMSS/NetworkInterface and Application Gateway.
	TargetResourceID *string `json:"targetResourceId,omitempty"`

	// Verbosity level.
	VerbosityLevel *VerbosityLevel `json:"verbosityLevel,omitempty"`
}

ConfigurationDiagnosticParameters - Parameters to get network configuration diagnostic.

func (ConfigurationDiagnosticParameters) MarshalJSON added in v0.3.0 

func (c ConfigurationDiagnosticParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationDiagnosticParameters.

type ConfigurationDiagnosticProfile added in v0.3.0 

type ConfigurationDiagnosticProfile struct {
	// REQUIRED; Traffic destination. Accepted values are: '*', IP Address/CIDR, Service Tag.
	Destination *string `json:"destination,omitempty"`

	// REQUIRED; Traffic destination port. Accepted values are '*' and a single port in the range (0 - 65535).
	DestinationPort *string `json:"destinationPort,omitempty"`

	// REQUIRED; The direction of the traffic.
	Direction *Direction `json:"direction,omitempty"`

	// REQUIRED; Protocol to be verified on. Accepted values are '*', TCP, UDP.
	Protocol *string `json:"protocol,omitempty"`

	// REQUIRED; Traffic source. Accepted values are '*', IP Address/CIDR, Service Tag.
	Source *string `json:"source,omitempty"`
}

ConfigurationDiagnosticProfile - Parameters to compare with network configuration.

type ConfigurationDiagnosticResponse added in v0.3.0 

type ConfigurationDiagnosticResponse struct {
	// READ-ONLY; List of network configuration diagnostic results.
	Results []*ConfigurationDiagnosticResult `json:"results,omitempty" azure:"ro"`
}

ConfigurationDiagnosticResponse - Results of network configuration diagnostic on the target resource.

func (ConfigurationDiagnosticResponse) MarshalJSON added in v0.3.0 

func (c ConfigurationDiagnosticResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationDiagnosticResponse.

type ConfigurationDiagnosticResult added in v0.3.0 

type ConfigurationDiagnosticResult struct {
	// Network security group result.
	NetworkSecurityGroupResult *SecurityGroupResult `json:"networkSecurityGroupResult,omitempty"`

	// Network configuration diagnostic profile.
	Profile *ConfigurationDiagnosticProfile `json:"profile,omitempty"`
}

ConfigurationDiagnosticResult - Network configuration diagnostic result corresponded to provided traffic query.

type ConnectionMonitor 

type ConnectionMonitor struct {
	// REQUIRED; Properties of the connection monitor.
	Properties *ConnectionMonitorParameters `json:"properties,omitempty"`

	// Connection monitor location.
	Location *string `json:"location,omitempty"`

	// Connection monitor tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

ConnectionMonitor - Parameters that define the operation to create a connection monitor.

func (ConnectionMonitor) MarshalJSON 

func (c ConnectionMonitor) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitor.

type ConnectionMonitorDestination 

type ConnectionMonitorDestination struct {
	// Address of the connection monitor destination (IP or domain name).
	Address *string `json:"address,omitempty"`

	// The destination port used by connection monitor.
	Port *int32 `json:"port,omitempty"`

	// The ID of the resource used as the destination by connection monitor.
	ResourceID *string `json:"resourceId,omitempty"`
}

ConnectionMonitorDestination - Describes the destination of connection monitor.

type ConnectionMonitorEndpoint 

type ConnectionMonitorEndpoint struct {
	// REQUIRED; The name of the connection monitor endpoint.
	Name *string `json:"name,omitempty"`

	// Address of the connection monitor endpoint (IP or domain name).
	Address *string `json:"address,omitempty"`

	// Test coverage for the endpoint.
	CoverageLevel *CoverageLevel `json:"coverageLevel,omitempty"`

	// Filter for sub-items within the endpoint.
	Filter *ConnectionMonitorEndpointFilter `json:"filter,omitempty"`

	// Resource ID of the connection monitor endpoint.
	ResourceID *string `json:"resourceId,omitempty"`

	// Endpoint scope.
	Scope *ConnectionMonitorEndpointScope `json:"scope,omitempty"`

	// The endpoint type.
	Type *EndpointType `json:"type,omitempty"`
}

ConnectionMonitorEndpoint - Describes the connection monitor endpoint.

type ConnectionMonitorEndpointFilter 

type ConnectionMonitorEndpointFilter struct {
	// List of items in the filter.
	Items []*ConnectionMonitorEndpointFilterItem `json:"items,omitempty"`

	// The behavior of the endpoint filter. Currently only 'Include' is supported.
	Type *ConnectionMonitorEndpointFilterType `json:"type,omitempty"`
}

ConnectionMonitorEndpointFilter - Describes the connection monitor endpoint filter.

func (ConnectionMonitorEndpointFilter) MarshalJSON 

func (c ConnectionMonitorEndpointFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorEndpointFilter.

type ConnectionMonitorEndpointFilterItem 

type ConnectionMonitorEndpointFilterItem struct {
	// The address of the filter item.
	Address *string `json:"address,omitempty"`

	// The type of item included in the filter. Currently only 'AgentAddress' is supported.
	Type *ConnectionMonitorEndpointFilterItemType `json:"type,omitempty"`
}

ConnectionMonitorEndpointFilterItem - Describes the connection monitor endpoint filter item.

type ConnectionMonitorEndpointFilterItemType 

type ConnectionMonitorEndpointFilterItemType string

ConnectionMonitorEndpointFilterItemType - The type of item included in the filter. Currently only 'AgentAddress' is supported. 

const (
	ConnectionMonitorEndpointFilterItemTypeAgentAddress ConnectionMonitorEndpointFilterItemType = "AgentAddress"
)

func PossibleConnectionMonitorEndpointFilterItemTypeValues 

func PossibleConnectionMonitorEndpointFilterItemTypeValues() []ConnectionMonitorEndpointFilterItemType

PossibleConnectionMonitorEndpointFilterItemTypeValues returns the possible values for the ConnectionMonitorEndpointFilterItemType const type.

func (ConnectionMonitorEndpointFilterItemType) ToPtr 

func (c ConnectionMonitorEndpointFilterItemType) ToPtr() *ConnectionMonitorEndpointFilterItemType

ToPtr returns a *ConnectionMonitorEndpointFilterItemType pointing to the current value.

type ConnectionMonitorEndpointFilterType 

type ConnectionMonitorEndpointFilterType string

ConnectionMonitorEndpointFilterType - The behavior of the endpoint filter. Currently only 'Include' is supported. 

const (
	ConnectionMonitorEndpointFilterTypeInclude ConnectionMonitorEndpointFilterType = "Include"
)

func PossibleConnectionMonitorEndpointFilterTypeValues 

func PossibleConnectionMonitorEndpointFilterTypeValues() []ConnectionMonitorEndpointFilterType

PossibleConnectionMonitorEndpointFilterTypeValues returns the possible values for the ConnectionMonitorEndpointFilterType const type.

func (ConnectionMonitorEndpointFilterType) ToPtr 

func (c ConnectionMonitorEndpointFilterType) ToPtr() *ConnectionMonitorEndpointFilterType

ToPtr returns a *ConnectionMonitorEndpointFilterType pointing to the current value.

type ConnectionMonitorEndpointScope 

type ConnectionMonitorEndpointScope struct {
	// List of items which needs to be excluded from the endpoint scope.
	Exclude []*ConnectionMonitorEndpointScopeItem `json:"exclude,omitempty"`

	// List of items which needs to be included to the endpoint scope.
	Include []*ConnectionMonitorEndpointScopeItem `json:"include,omitempty"`
}

ConnectionMonitorEndpointScope - Describes the connection monitor endpoint scope.

func (ConnectionMonitorEndpointScope) MarshalJSON 

func (c ConnectionMonitorEndpointScope) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorEndpointScope.

type ConnectionMonitorEndpointScopeItem 

type ConnectionMonitorEndpointScopeItem struct {
	// The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address.
	Address *string `json:"address,omitempty"`
}

ConnectionMonitorEndpointScopeItem - Describes the connection monitor endpoint scope item.

type ConnectionMonitorHTTPConfiguration 

type ConnectionMonitorHTTPConfiguration struct {
	// The HTTP method to use.
	Method *HTTPConfigurationMethod `json:"method,omitempty"`

	// The path component of the URI. For instance, "/dir1/dir2".
	Path *string `json:"path,omitempty"`

	// The port to connect to.
	Port *int32 `json:"port,omitempty"`

	// Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.
	PreferHTTPS *bool `json:"preferHTTPS,omitempty"`

	// The HTTP headers to transmit with the request.
	RequestHeaders []*HTTPHeader `json:"requestHeaders,omitempty"`

	// HTTP status codes to consider successful. For instance, "2xx,301-304,418".
	ValidStatusCodeRanges []*string `json:"validStatusCodeRanges,omitempty"`
}

ConnectionMonitorHTTPConfiguration - Describes the HTTP configuration.

func (ConnectionMonitorHTTPConfiguration) MarshalJSON 

func (c ConnectionMonitorHTTPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorHTTPConfiguration.

type ConnectionMonitorIcmpConfiguration 

type ConnectionMonitorIcmpConfiguration struct {
	// Value indicating whether path evaluation with trace route should be disabled.
	DisableTraceRoute *bool `json:"disableTraceRoute,omitempty"`
}

ConnectionMonitorIcmpConfiguration - Describes the ICMP configuration.

type ConnectionMonitorListResult 

type ConnectionMonitorListResult struct {
	// Information about connection monitors.
	Value []*ConnectionMonitorResult `json:"value,omitempty"`
}

ConnectionMonitorListResult - List of connection monitors.

func (ConnectionMonitorListResult) MarshalJSON 

func (c ConnectionMonitorListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorListResult.

type ConnectionMonitorOutput 

type ConnectionMonitorOutput struct {
	// Connection monitor output destination type. Currently, only "Workspace" is supported.
	Type *OutputType `json:"type,omitempty"`

	// Describes the settings for producing output into a log analytics workspace.
	WorkspaceSettings *ConnectionMonitorWorkspaceSettings `json:"workspaceSettings,omitempty"`
}

ConnectionMonitorOutput - Describes a connection monitor output destination.

type ConnectionMonitorParameters 

type ConnectionMonitorParameters struct {
	// Determines if the connection monitor will start automatically once created.
	AutoStart *bool `json:"autoStart,omitempty"`

	// Describes the destination of connection monitor.
	Destination *ConnectionMonitorDestination `json:"destination,omitempty"`

	// List of connection monitor endpoints.
	Endpoints []*ConnectionMonitorEndpoint `json:"endpoints,omitempty"`

	// Monitoring interval in seconds.
	MonitoringIntervalInSeconds *int32 `json:"monitoringIntervalInSeconds,omitempty"`

	// Optional notes to be associated with the connection monitor.
	Notes *string `json:"notes,omitempty"`

	// List of connection monitor outputs.
	Outputs []*ConnectionMonitorOutput `json:"outputs,omitempty"`

	// Describes the source of connection monitor.
	Source *ConnectionMonitorSource `json:"source,omitempty"`

	// List of connection monitor test configurations.
	TestConfigurations []*ConnectionMonitorTestConfiguration `json:"testConfigurations,omitempty"`

	// List of connection monitor test groups.
	TestGroups []*ConnectionMonitorTestGroup `json:"testGroups,omitempty"`
}

ConnectionMonitorParameters - Parameters that define the operation to create a connection monitor.

func (ConnectionMonitorParameters) MarshalJSON 

func (c ConnectionMonitorParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorParameters.

type ConnectionMonitorQueryResult 

type ConnectionMonitorQueryResult struct {
	// Status of connection monitor source.
	SourceStatus *ConnectionMonitorSourceStatus `json:"sourceStatus,omitempty"`

	// Information about connection states.
	States []*ConnectionStateSnapshot `json:"states,omitempty"`
}

ConnectionMonitorQueryResult - List of connection states snapshots.

func (ConnectionMonitorQueryResult) MarshalJSON 

func (c ConnectionMonitorQueryResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorQueryResult.

type ConnectionMonitorResult 

type ConnectionMonitorResult struct {
	// Connection monitor location.
	Location *string `json:"location,omitempty"`

	// Properties of the connection monitor result.
	Properties *ConnectionMonitorResultProperties `json:"properties,omitempty"`

	// Connection monitor tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; ID of the connection monitor.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the connection monitor.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Connection monitor type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ConnectionMonitorResult - Information about the connection monitor.

func (ConnectionMonitorResult) MarshalJSON 

func (c ConnectionMonitorResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorResult.

type ConnectionMonitorResultProperties 

type ConnectionMonitorResultProperties struct {
	// Determines if the connection monitor will start automatically once created.
	AutoStart *bool `json:"autoStart,omitempty"`

	// Describes the destination of connection monitor.
	Destination *ConnectionMonitorDestination `json:"destination,omitempty"`

	// List of connection monitor endpoints.
	Endpoints []*ConnectionMonitorEndpoint `json:"endpoints,omitempty"`

	// Monitoring interval in seconds.
	MonitoringIntervalInSeconds *int32 `json:"monitoringIntervalInSeconds,omitempty"`

	// Optional notes to be associated with the connection monitor.
	Notes *string `json:"notes,omitempty"`

	// List of connection monitor outputs.
	Outputs []*ConnectionMonitorOutput `json:"outputs,omitempty"`

	// Describes the source of connection monitor.
	Source *ConnectionMonitorSource `json:"source,omitempty"`

	// List of connection monitor test configurations.
	TestConfigurations []*ConnectionMonitorTestConfiguration `json:"testConfigurations,omitempty"`

	// List of connection monitor test groups.
	TestGroups []*ConnectionMonitorTestGroup `json:"testGroups,omitempty"`

	// READ-ONLY; Type of connection monitor.
	ConnectionMonitorType *ConnectionMonitorType `json:"connectionMonitorType,omitempty" azure:"ro"`

	// READ-ONLY; The monitoring status of the connection monitor.
	MonitoringStatus *string `json:"monitoringStatus,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the connection monitor.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The date and time when the connection monitor was started.
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`
}

ConnectionMonitorResultProperties - Describes the properties of a connection monitor.

func (ConnectionMonitorResultProperties) MarshalJSON 

func (c ConnectionMonitorResultProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorResultProperties.

func (*ConnectionMonitorResultProperties) UnmarshalJSON 

func (c *ConnectionMonitorResultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorResultProperties.

type ConnectionMonitorSource 

type ConnectionMonitorSource struct {
	// REQUIRED; The ID of the resource used as the source by connection monitor.
	ResourceID *string `json:"resourceId,omitempty"`

	// The source port used by connection monitor.
	Port *int32 `json:"port,omitempty"`
}

ConnectionMonitorSource - Describes the source of connection monitor.

type ConnectionMonitorSourceStatus 

type ConnectionMonitorSourceStatus string

ConnectionMonitorSourceStatus - Status of connection monitor source. 

const (
	ConnectionMonitorSourceStatusActive   ConnectionMonitorSourceStatus = "Active"
	ConnectionMonitorSourceStatusInactive ConnectionMonitorSourceStatus = "Inactive"
	ConnectionMonitorSourceStatusUnknown  ConnectionMonitorSourceStatus = "Unknown"
)

func PossibleConnectionMonitorSourceStatusValues 

func PossibleConnectionMonitorSourceStatusValues() []ConnectionMonitorSourceStatus

PossibleConnectionMonitorSourceStatusValues returns the possible values for the ConnectionMonitorSourceStatus const type.

func (ConnectionMonitorSourceStatus) ToPtr 

func (c ConnectionMonitorSourceStatus) ToPtr() *ConnectionMonitorSourceStatus

ToPtr returns a *ConnectionMonitorSourceStatus pointing to the current value.

type ConnectionMonitorSuccessThreshold 

type ConnectionMonitorSuccessThreshold struct {
	// The maximum percentage of failed checks permitted for a test to evaluate as successful.
	ChecksFailedPercent *int32 `json:"checksFailedPercent,omitempty"`

	// The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.
	RoundTripTimeMs *float32 `json:"roundTripTimeMs,omitempty"`
}

ConnectionMonitorSuccessThreshold - Describes the threshold for declaring a test successful.

type ConnectionMonitorTCPConfiguration 

type ConnectionMonitorTCPConfiguration struct {
	// Destination port behavior.
	DestinationPortBehavior *DestinationPortBehavior `json:"destinationPortBehavior,omitempty"`

	// Value indicating whether path evaluation with trace route should be disabled.
	DisableTraceRoute *bool `json:"disableTraceRoute,omitempty"`

	// The port to connect to.
	Port *int32 `json:"port,omitempty"`
}

ConnectionMonitorTCPConfiguration - Describes the TCP configuration.

type ConnectionMonitorTestConfiguration 

type ConnectionMonitorTestConfiguration struct {
	// REQUIRED; The name of the connection monitor test configuration.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The protocol to use in test evaluation.
	Protocol *ConnectionMonitorTestConfigurationProtocol `json:"protocol,omitempty"`

	// The parameters used to perform test evaluation over HTTP.
	HTTPConfiguration *ConnectionMonitorHTTPConfiguration `json:"httpConfiguration,omitempty"`

	// The parameters used to perform test evaluation over ICMP.
	IcmpConfiguration *ConnectionMonitorIcmpConfiguration `json:"icmpConfiguration,omitempty"`

	// The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending
	// on other parameters.
	PreferredIPVersion *PreferredIPVersion `json:"preferredIPVersion,omitempty"`

	// The threshold for declaring a test successful.
	SuccessThreshold *ConnectionMonitorSuccessThreshold `json:"successThreshold,omitempty"`

	// The parameters used to perform test evaluation over TCP.
	TCPConfiguration *ConnectionMonitorTCPConfiguration `json:"tcpConfiguration,omitempty"`

	// The frequency of test evaluation, in seconds.
	TestFrequencySec *int32 `json:"testFrequencySec,omitempty"`
}

ConnectionMonitorTestConfiguration - Describes a connection monitor test configuration.

type ConnectionMonitorTestConfigurationProtocol 

type ConnectionMonitorTestConfigurationProtocol string

ConnectionMonitorTestConfigurationProtocol - The protocol to use in test evaluation. 

const (
	ConnectionMonitorTestConfigurationProtocolHTTP ConnectionMonitorTestConfigurationProtocol = "Http"
	ConnectionMonitorTestConfigurationProtocolIcmp ConnectionMonitorTestConfigurationProtocol = "Icmp"
	ConnectionMonitorTestConfigurationProtocolTCP  ConnectionMonitorTestConfigurationProtocol = "Tcp"
)

func PossibleConnectionMonitorTestConfigurationProtocolValues 

func PossibleConnectionMonitorTestConfigurationProtocolValues() []ConnectionMonitorTestConfigurationProtocol

PossibleConnectionMonitorTestConfigurationProtocolValues returns the possible values for the ConnectionMonitorTestConfigurationProtocol const type.

func (ConnectionMonitorTestConfigurationProtocol) ToPtr 

func (c ConnectionMonitorTestConfigurationProtocol) ToPtr() *ConnectionMonitorTestConfigurationProtocol

ToPtr returns a *ConnectionMonitorTestConfigurationProtocol pointing to the current value.

type ConnectionMonitorTestGroup 

type ConnectionMonitorTestGroup struct {
	// REQUIRED; List of destination endpoint names.
	Destinations []*string `json:"destinations,omitempty"`

	// REQUIRED; The name of the connection monitor test group.
	Name *string `json:"name,omitempty"`

	// REQUIRED; List of source endpoint names.
	Sources []*string `json:"sources,omitempty"`

	// REQUIRED; List of test configuration names.
	TestConfigurations []*string `json:"testConfigurations,omitempty"`

	// Value indicating whether test group is disabled.
	Disable *bool `json:"disable,omitempty"`
}

ConnectionMonitorTestGroup - Describes the connection monitor test group.

func (ConnectionMonitorTestGroup) MarshalJSON 

func (c ConnectionMonitorTestGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorTestGroup.

type ConnectionMonitorType 

type ConnectionMonitorType string

ConnectionMonitorType - Type of connection monitor. 

const (
	ConnectionMonitorTypeMultiEndpoint           ConnectionMonitorType = "MultiEndpoint"
	ConnectionMonitorTypeSingleSourceDestination ConnectionMonitorType = "SingleSourceDestination"
)

func PossibleConnectionMonitorTypeValues 

func PossibleConnectionMonitorTypeValues() []ConnectionMonitorType

PossibleConnectionMonitorTypeValues returns the possible values for the ConnectionMonitorType const type.

func (ConnectionMonitorType) ToPtr 

func (c ConnectionMonitorType) ToPtr() *ConnectionMonitorType

ToPtr returns a *ConnectionMonitorType pointing to the current value.

type ConnectionMonitorWorkspaceSettings 

type ConnectionMonitorWorkspaceSettings struct {
	// Log analytics workspace resource ID.
	WorkspaceResourceID *string `json:"workspaceResourceId,omitempty"`
}

ConnectionMonitorWorkspaceSettings - Describes the settings for producing output into a log analytics workspace.

type ConnectionMonitorsClient 

type ConnectionMonitorsClient struct {
	// contains filtered or unexported fields
}

ConnectionMonitorsClient contains the methods for the ConnectionMonitors group. Don't use this type directly, use NewConnectionMonitorsClient() instead.

func NewConnectionMonitorsClient 

func NewConnectionMonitorsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ConnectionMonitorsClient

NewConnectionMonitorsClient creates a new instance of ConnectionMonitorsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ConnectionMonitorsClient) BeginCreateOrUpdate 

func (client *ConnectionMonitorsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, parameters ConnectionMonitor, options *ConnectionMonitorsClientBeginCreateOrUpdateOptions) (ConnectionMonitorsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Create or update a connection monitor. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group containing Network Watcher. networkWatcherName - The name of the Network Watcher resource. connectionMonitorName - The name of the connection monitor. parameters - Parameters that define the operation to create a connection monitor. options - ConnectionMonitorsClientBeginCreateOrUpdateOptions contains the optional parameters for the ConnectionMonitorsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherConnectionMonitorCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewConnectionMonitorsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<connection-monitor-name>",
		armnetwork.ConnectionMonitor{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.ConnectionMonitorParameters{
				Endpoints: []*armnetwork.ConnectionMonitorEndpoint{
					{
						Name:       to.StringPtr("<name>"),
						ResourceID: to.StringPtr("<resource-id>"),
					},
					{
						Name:    to.StringPtr("<name>"),
						Address: to.StringPtr("<address>"),
					}},
				TestConfigurations: []*armnetwork.ConnectionMonitorTestConfiguration{
					{
						Name: to.StringPtr("<name>"),
						TCPConfiguration: &armnetwork.ConnectionMonitorTCPConfiguration{
							Port: to.Int32Ptr(80),
						},
						TestFrequencySec: to.Int32Ptr(60),
						Protocol:         armnetwork.ConnectionMonitorTestConfigurationProtocol("Tcp").ToPtr(),
					}},
				TestGroups: []*armnetwork.ConnectionMonitorTestGroup{
					{
						Name: to.StringPtr("<name>"),
						Destinations: []*string{
							to.StringPtr("destination")},
						Sources: []*string{
							to.StringPtr("source")},
						TestConfigurations: []*string{
							to.StringPtr("tcp")},
					}},
			},
		},
		&armnetwork.ConnectionMonitorsClientBeginCreateOrUpdateOptions{Migrate: nil})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ConnectionMonitorsClientCreateOrUpdateResult)
}

Output:

func (*ConnectionMonitorsClient) BeginDelete 

func (client *ConnectionMonitorsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, options *ConnectionMonitorsClientBeginDeleteOptions) (ConnectionMonitorsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified connection monitor. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group containing Network Watcher. networkWatcherName - The name of the Network Watcher resource. connectionMonitorName - The name of the connection monitor. options - ConnectionMonitorsClientBeginDeleteOptions contains the optional parameters for the ConnectionMonitorsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherConnectionMonitorDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewConnectionMonitorsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<connection-monitor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ConnectionMonitorsClient) BeginQuery 

func (client *ConnectionMonitorsClient) BeginQuery(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, options *ConnectionMonitorsClientBeginQueryOptions) (ConnectionMonitorsClientQueryPollerResponse, error)

BeginQuery - Query a snapshot of the most recent connection states. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group containing Network Watcher. networkWatcherName - The name of the Network Watcher resource. connectionMonitorName - The name given to the connection monitor. options - ConnectionMonitorsClientBeginQueryOptions contains the optional parameters for the ConnectionMonitorsClient.BeginQuery method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherConnectionMonitorQuery.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewConnectionMonitorsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginQuery(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<connection-monitor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ConnectionMonitorsClientQueryResult)
}

Output:

func (*ConnectionMonitorsClient) BeginStart 

func (client *ConnectionMonitorsClient) BeginStart(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, options *ConnectionMonitorsClientBeginStartOptions) (ConnectionMonitorsClientStartPollerResponse, error)

BeginStart - Starts the specified connection monitor. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group containing Network Watcher. networkWatcherName - The name of the Network Watcher resource. connectionMonitorName - The name of the connection monitor. options - ConnectionMonitorsClientBeginStartOptions contains the optional parameters for the ConnectionMonitorsClient.BeginStart method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherConnectionMonitorStart.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewConnectionMonitorsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStart(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<connection-monitor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ConnectionMonitorsClient) BeginStop 

func (client *ConnectionMonitorsClient) BeginStop(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, options *ConnectionMonitorsClientBeginStopOptions) (ConnectionMonitorsClientStopPollerResponse, error)

BeginStop - Stops the specified connection monitor. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group containing Network Watcher. networkWatcherName - The name of the Network Watcher resource. connectionMonitorName - The name of the connection monitor. options - ConnectionMonitorsClientBeginStopOptions contains the optional parameters for the ConnectionMonitorsClient.BeginStop method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherConnectionMonitorStop.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewConnectionMonitorsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStop(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<connection-monitor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ConnectionMonitorsClient) Get 

func (client *ConnectionMonitorsClient) Get(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, options *ConnectionMonitorsClientGetOptions) (ConnectionMonitorsClientGetResponse, error)

Get - Gets a connection monitor by name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group containing Network Watcher. networkWatcherName - The name of the Network Watcher resource. connectionMonitorName - The name of the connection monitor. options - ConnectionMonitorsClientGetOptions contains the optional parameters for the ConnectionMonitorsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherConnectionMonitorGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewConnectionMonitorsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<connection-monitor-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ConnectionMonitorsClientGetResult)
}

Output:

func (*ConnectionMonitorsClient) List 

func (client *ConnectionMonitorsClient) List(ctx context.Context, resourceGroupName string, networkWatcherName string, options *ConnectionMonitorsClientListOptions) (ConnectionMonitorsClientListResponse, error)

List - Lists all connection monitors for the specified Network Watcher. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group containing Network Watcher. networkWatcherName - The name of the Network Watcher resource. options - ConnectionMonitorsClientListOptions contains the optional parameters for the ConnectionMonitorsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherConnectionMonitorList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewConnectionMonitorsClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ConnectionMonitorsClientListResult)
}

Output:

func (*ConnectionMonitorsClient) UpdateTags 

func (client *ConnectionMonitorsClient) UpdateTags(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, parameters TagsObject, options *ConnectionMonitorsClientUpdateTagsOptions) (ConnectionMonitorsClientUpdateTagsResponse, error)

UpdateTags - Update tags of the specified connection monitor. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. connectionMonitorName - The name of the connection monitor. parameters - Parameters supplied to update connection monitor tags. options - ConnectionMonitorsClientUpdateTagsOptions contains the optional parameters for the ConnectionMonitorsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewConnectionMonitorsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<connection-monitor-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ConnectionMonitorsClientUpdateTagsResult)
}

Output:

type ConnectionMonitorsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ConnectionMonitorsClientBeginCreateOrUpdateOptions struct {
	// Value indicating whether connection monitor V1 should be migrated to V2 format.
	Migrate *string
}

ConnectionMonitorsClientBeginCreateOrUpdateOptions contains the optional parameters for the ConnectionMonitorsClient.BeginCreateOrUpdate method.

type ConnectionMonitorsClientBeginDeleteOptions added in v0.3.0 

type ConnectionMonitorsClientBeginDeleteOptions struct {
}

ConnectionMonitorsClientBeginDeleteOptions contains the optional parameters for the ConnectionMonitorsClient.BeginDelete method.

type ConnectionMonitorsClientBeginQueryOptions added in v0.3.0 

type ConnectionMonitorsClientBeginQueryOptions struct {
}

ConnectionMonitorsClientBeginQueryOptions contains the optional parameters for the ConnectionMonitorsClient.BeginQuery method.

type ConnectionMonitorsClientBeginStartOptions added in v0.3.0 

type ConnectionMonitorsClientBeginStartOptions struct {
}

ConnectionMonitorsClientBeginStartOptions contains the optional parameters for the ConnectionMonitorsClient.BeginStart method.

type ConnectionMonitorsClientBeginStopOptions added in v0.3.0 

type ConnectionMonitorsClientBeginStopOptions struct {
}

ConnectionMonitorsClientBeginStopOptions contains the optional parameters for the ConnectionMonitorsClient.BeginStop method.

type ConnectionMonitorsClientCreateOrUpdatePoller added in v0.3.0 

type ConnectionMonitorsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ConnectionMonitorsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ConnectionMonitorsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ConnectionMonitorsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ConnectionMonitorsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ConnectionMonitorsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ConnectionMonitorsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ConnectionMonitorsClientCreateOrUpdateResponse will be returned.

func (*ConnectionMonitorsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ConnectionMonitorsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ConnectionMonitorsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ConnectionMonitorsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ConnectionMonitorsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ConnectionMonitorsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConnectionMonitorsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientCreateOrUpdatePollerResponse contains the response from method ConnectionMonitorsClient.CreateOrUpdate.

func (ConnectionMonitorsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ConnectionMonitorsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConnectionMonitorsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ConnectionMonitorsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ConnectionMonitorsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ConnectionMonitorsClient, token string) error

Resume rehydrates a ConnectionMonitorsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ConnectionMonitorsClientCreateOrUpdateResponse added in v0.3.0 

type ConnectionMonitorsClientCreateOrUpdateResponse struct {
	ConnectionMonitorsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientCreateOrUpdateResponse contains the response from method ConnectionMonitorsClient.CreateOrUpdate.

type ConnectionMonitorsClientCreateOrUpdateResult added in v0.3.0 

type ConnectionMonitorsClientCreateOrUpdateResult struct {
	ConnectionMonitorResult
}

ConnectionMonitorsClientCreateOrUpdateResult contains the result from method ConnectionMonitorsClient.CreateOrUpdate.

type ConnectionMonitorsClientDeletePoller added in v0.3.0 

type ConnectionMonitorsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ConnectionMonitorsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ConnectionMonitorsClientDeletePoller) Done added in v0.3.0 

func (p *ConnectionMonitorsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ConnectionMonitorsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ConnectionMonitorsClientDeletePoller) FinalResponse(ctx context.Context) (ConnectionMonitorsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ConnectionMonitorsClientDeleteResponse will be returned.

func (*ConnectionMonitorsClientDeletePoller) Poll added in v0.3.0 

func (p *ConnectionMonitorsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ConnectionMonitorsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ConnectionMonitorsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ConnectionMonitorsClientDeletePollerResponse added in v0.3.0 

type ConnectionMonitorsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConnectionMonitorsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientDeletePollerResponse contains the response from method ConnectionMonitorsClient.Delete.

func (ConnectionMonitorsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ConnectionMonitorsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConnectionMonitorsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ConnectionMonitorsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ConnectionMonitorsClientDeletePollerResponse) Resume(ctx context.Context, client *ConnectionMonitorsClient, token string) error

Resume rehydrates a ConnectionMonitorsClientDeletePollerResponse from the provided client and resume token.

type ConnectionMonitorsClientDeleteResponse added in v0.3.0 

type ConnectionMonitorsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientDeleteResponse contains the response from method ConnectionMonitorsClient.Delete.

type ConnectionMonitorsClientGetOptions added in v0.3.0 

type ConnectionMonitorsClientGetOptions struct {
}

ConnectionMonitorsClientGetOptions contains the optional parameters for the ConnectionMonitorsClient.Get method.

type ConnectionMonitorsClientGetResponse added in v0.3.0 

type ConnectionMonitorsClientGetResponse struct {
	ConnectionMonitorsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientGetResponse contains the response from method ConnectionMonitorsClient.Get.

type ConnectionMonitorsClientGetResult added in v0.3.0 

type ConnectionMonitorsClientGetResult struct {
	ConnectionMonitorResult
}

ConnectionMonitorsClientGetResult contains the result from method ConnectionMonitorsClient.Get.

type ConnectionMonitorsClientListOptions added in v0.3.0 

type ConnectionMonitorsClientListOptions struct {
}

ConnectionMonitorsClientListOptions contains the optional parameters for the ConnectionMonitorsClient.List method.

type ConnectionMonitorsClientListResponse added in v0.3.0 

type ConnectionMonitorsClientListResponse struct {
	ConnectionMonitorsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientListResponse contains the response from method ConnectionMonitorsClient.List.

type ConnectionMonitorsClientListResult added in v0.3.0 

type ConnectionMonitorsClientListResult struct {
	ConnectionMonitorListResult
}

ConnectionMonitorsClientListResult contains the result from method ConnectionMonitorsClient.List.

type ConnectionMonitorsClientQueryPoller added in v0.3.0 

type ConnectionMonitorsClientQueryPoller struct {
	// contains filtered or unexported fields
}

ConnectionMonitorsClientQueryPoller provides polling facilities until the operation reaches a terminal state.

func (*ConnectionMonitorsClientQueryPoller) Done added in v0.3.0 

func (p *ConnectionMonitorsClientQueryPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ConnectionMonitorsClientQueryPoller) FinalResponse added in v0.3.0 

func (p *ConnectionMonitorsClientQueryPoller) FinalResponse(ctx context.Context) (ConnectionMonitorsClientQueryResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ConnectionMonitorsClientQueryResponse will be returned.

func (*ConnectionMonitorsClientQueryPoller) Poll added in v0.3.0 

func (p *ConnectionMonitorsClientQueryPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ConnectionMonitorsClientQueryPoller) ResumeToken added in v0.3.0 

func (p *ConnectionMonitorsClientQueryPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ConnectionMonitorsClientQueryPollerResponse added in v0.3.0 

type ConnectionMonitorsClientQueryPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConnectionMonitorsClientQueryPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientQueryPollerResponse contains the response from method ConnectionMonitorsClient.Query.

func (ConnectionMonitorsClientQueryPollerResponse) PollUntilDone added in v0.3.0 

func (l ConnectionMonitorsClientQueryPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConnectionMonitorsClientQueryResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ConnectionMonitorsClientQueryPollerResponse) Resume added in v0.3.0 

func (l *ConnectionMonitorsClientQueryPollerResponse) Resume(ctx context.Context, client *ConnectionMonitorsClient, token string) error

Resume rehydrates a ConnectionMonitorsClientQueryPollerResponse from the provided client and resume token.

type ConnectionMonitorsClientQueryResponse added in v0.3.0 

type ConnectionMonitorsClientQueryResponse struct {
	ConnectionMonitorsClientQueryResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientQueryResponse contains the response from method ConnectionMonitorsClient.Query.

type ConnectionMonitorsClientQueryResult added in v0.3.0 

type ConnectionMonitorsClientQueryResult struct {
	ConnectionMonitorQueryResult
}

ConnectionMonitorsClientQueryResult contains the result from method ConnectionMonitorsClient.Query.

type ConnectionMonitorsClientStartPoller added in v0.3.0 

type ConnectionMonitorsClientStartPoller struct {
	// contains filtered or unexported fields
}

ConnectionMonitorsClientStartPoller provides polling facilities until the operation reaches a terminal state.

func (*ConnectionMonitorsClientStartPoller) Done added in v0.3.0 

func (p *ConnectionMonitorsClientStartPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ConnectionMonitorsClientStartPoller) FinalResponse added in v0.3.0 

func (p *ConnectionMonitorsClientStartPoller) FinalResponse(ctx context.Context) (ConnectionMonitorsClientStartResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ConnectionMonitorsClientStartResponse will be returned.

func (*ConnectionMonitorsClientStartPoller) Poll added in v0.3.0 

func (p *ConnectionMonitorsClientStartPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ConnectionMonitorsClientStartPoller) ResumeToken added in v0.3.0 

func (p *ConnectionMonitorsClientStartPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ConnectionMonitorsClientStartPollerResponse added in v0.3.0 

type ConnectionMonitorsClientStartPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConnectionMonitorsClientStartPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientStartPollerResponse contains the response from method ConnectionMonitorsClient.Start.

func (ConnectionMonitorsClientStartPollerResponse) PollUntilDone added in v0.3.0 

func (l ConnectionMonitorsClientStartPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConnectionMonitorsClientStartResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ConnectionMonitorsClientStartPollerResponse) Resume added in v0.3.0 

func (l *ConnectionMonitorsClientStartPollerResponse) Resume(ctx context.Context, client *ConnectionMonitorsClient, token string) error

Resume rehydrates a ConnectionMonitorsClientStartPollerResponse from the provided client and resume token.

type ConnectionMonitorsClientStartResponse added in v0.3.0 

type ConnectionMonitorsClientStartResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientStartResponse contains the response from method ConnectionMonitorsClient.Start.

type ConnectionMonitorsClientStopPoller added in v0.3.0 

type ConnectionMonitorsClientStopPoller struct {
	// contains filtered or unexported fields
}

ConnectionMonitorsClientStopPoller provides polling facilities until the operation reaches a terminal state.

func (*ConnectionMonitorsClientStopPoller) Done added in v0.3.0 

func (p *ConnectionMonitorsClientStopPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ConnectionMonitorsClientStopPoller) FinalResponse added in v0.3.0 

func (p *ConnectionMonitorsClientStopPoller) FinalResponse(ctx context.Context) (ConnectionMonitorsClientStopResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ConnectionMonitorsClientStopResponse will be returned.

func (*ConnectionMonitorsClientStopPoller) Poll added in v0.3.0 

func (p *ConnectionMonitorsClientStopPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ConnectionMonitorsClientStopPoller) ResumeToken added in v0.3.0 

func (p *ConnectionMonitorsClientStopPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ConnectionMonitorsClientStopPollerResponse added in v0.3.0 

type ConnectionMonitorsClientStopPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ConnectionMonitorsClientStopPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientStopPollerResponse contains the response from method ConnectionMonitorsClient.Stop.

func (ConnectionMonitorsClientStopPollerResponse) PollUntilDone added in v0.3.0 

func (l ConnectionMonitorsClientStopPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ConnectionMonitorsClientStopResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ConnectionMonitorsClientStopPollerResponse) Resume added in v0.3.0 

func (l *ConnectionMonitorsClientStopPollerResponse) Resume(ctx context.Context, client *ConnectionMonitorsClient, token string) error

Resume rehydrates a ConnectionMonitorsClientStopPollerResponse from the provided client and resume token.

type ConnectionMonitorsClientStopResponse added in v0.3.0 

type ConnectionMonitorsClientStopResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientStopResponse contains the response from method ConnectionMonitorsClient.Stop.

type ConnectionMonitorsClientUpdateTagsOptions added in v0.3.0 

type ConnectionMonitorsClientUpdateTagsOptions struct {
}

ConnectionMonitorsClientUpdateTagsOptions contains the optional parameters for the ConnectionMonitorsClient.UpdateTags method.

type ConnectionMonitorsClientUpdateTagsResponse added in v0.3.0 

type ConnectionMonitorsClientUpdateTagsResponse struct {
	ConnectionMonitorsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ConnectionMonitorsClientUpdateTagsResponse contains the response from method ConnectionMonitorsClient.UpdateTags.

type ConnectionMonitorsClientUpdateTagsResult added in v0.3.0 

type ConnectionMonitorsClientUpdateTagsResult struct {
	ConnectionMonitorResult
}

ConnectionMonitorsClientUpdateTagsResult contains the result from method ConnectionMonitorsClient.UpdateTags.

type ConnectionResetSharedKey 

type ConnectionResetSharedKey struct {
	// REQUIRED; The virtual network connection reset shared key length, should between 1 and 128.
	KeyLength *int32 `json:"keyLength,omitempty"`
}

ConnectionResetSharedKey - The virtual network connection reset shared key.

type ConnectionSharedKey 

type ConnectionSharedKey struct {
	// REQUIRED; The virtual network connection shared key value.
	Value *string `json:"value,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`
}

ConnectionSharedKey - Response for GetConnectionSharedKey API service call.

type ConnectionState 

type ConnectionState string

ConnectionState - The connection state. 

const (
	ConnectionStateReachable   ConnectionState = "Reachable"
	ConnectionStateUnknown     ConnectionState = "Unknown"
	ConnectionStateUnreachable ConnectionState = "Unreachable"
)

func PossibleConnectionStateValues 

func PossibleConnectionStateValues() []ConnectionState

PossibleConnectionStateValues returns the possible values for the ConnectionState const type.

func (ConnectionState) ToPtr 

func (c ConnectionState) ToPtr() *ConnectionState

ToPtr returns a *ConnectionState pointing to the current value.

type ConnectionStateSnapshot 

type ConnectionStateSnapshot struct {
	// Average latency in ms.
	AvgLatencyInMs *int64 `json:"avgLatencyInMs,omitempty"`

	// The connection state.
	ConnectionState *ConnectionState `json:"connectionState,omitempty"`

	// The end time of the connection snapshot.
	EndTime *time.Time `json:"endTime,omitempty"`

	// Connectivity analysis evaluation state.
	EvaluationState *EvaluationState `json:"evaluationState,omitempty"`

	// Maximum latency in ms.
	MaxLatencyInMs *int64 `json:"maxLatencyInMs,omitempty"`

	// Minimum latency in ms.
	MinLatencyInMs *int64 `json:"minLatencyInMs,omitempty"`

	// The number of failed probes.
	ProbesFailed *int64 `json:"probesFailed,omitempty"`

	// The number of sent probes.
	ProbesSent *int64 `json:"probesSent,omitempty"`

	// The start time of the connection snapshot.
	StartTime *time.Time `json:"startTime,omitempty"`

	// READ-ONLY; List of hops between the source and the destination.
	Hops []*ConnectivityHop `json:"hops,omitempty" azure:"ro"`
}

ConnectionStateSnapshot - Connection state snapshot.

func (ConnectionStateSnapshot) MarshalJSON 

func (c ConnectionStateSnapshot) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionStateSnapshot.

func (*ConnectionStateSnapshot) UnmarshalJSON 

func (c *ConnectionStateSnapshot) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionStateSnapshot.

type ConnectionStatus 

type ConnectionStatus string

ConnectionStatus - The connection status. 

const (
	ConnectionStatusConnected    ConnectionStatus = "Connected"
	ConnectionStatusDegraded     ConnectionStatus = "Degraded"
	ConnectionStatusDisconnected ConnectionStatus = "Disconnected"
	ConnectionStatusUnknown      ConnectionStatus = "Unknown"
)

func PossibleConnectionStatusValues 

func PossibleConnectionStatusValues() []ConnectionStatus

PossibleConnectionStatusValues returns the possible values for the ConnectionStatus const type.

func (ConnectionStatus) ToPtr 

func (c ConnectionStatus) ToPtr() *ConnectionStatus

ToPtr returns a *ConnectionStatus pointing to the current value.

type ConnectivityDestination 

type ConnectivityDestination struct {
	// The IP address or URI the resource to which a connection attempt will be made.
	Address *string `json:"address,omitempty"`

	// Port on which check connectivity will be performed.
	Port *int32 `json:"port,omitempty"`

	// The ID of the resource to which a connection attempt will be made.
	ResourceID *string `json:"resourceId,omitempty"`
}

ConnectivityDestination - Parameters that define destination of connection.

type ConnectivityHop 

type ConnectivityHop struct {
	// READ-ONLY; The IP address of the hop.
	Address *string `json:"address,omitempty" azure:"ro"`

	// READ-ONLY; The ID of the hop.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; List of issues.
	Issues []*ConnectivityIssue `json:"issues,omitempty" azure:"ro"`

	// READ-ONLY; List of hop links.
	Links []*HopLink `json:"links,omitempty" azure:"ro"`

	// READ-ONLY; List of next hop identifiers.
	NextHopIDs []*string `json:"nextHopIds,omitempty" azure:"ro"`

	// READ-ONLY; List of previous hop identifiers.
	PreviousHopIDs []*string `json:"previousHopIds,omitempty" azure:"ro"`

	// READ-ONLY; List of previous hop links.
	PreviousLinks []*HopLink `json:"previousLinks,omitempty" azure:"ro"`

	// READ-ONLY; The ID of the resource corresponding to this hop.
	ResourceID *string `json:"resourceId,omitempty" azure:"ro"`

	// READ-ONLY; The type of the hop.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ConnectivityHop - Information about a hop between the source and the destination.

func (ConnectivityHop) MarshalJSON 

func (c ConnectivityHop) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityHop.

type ConnectivityInformation 

type ConnectivityInformation struct {
	// READ-ONLY; Average latency in milliseconds.
	AvgLatencyInMs *int32 `json:"avgLatencyInMs,omitempty" azure:"ro"`

	// READ-ONLY; The connection status.
	ConnectionStatus *ConnectionStatus `json:"connectionStatus,omitempty" azure:"ro"`

	// READ-ONLY; List of hops between the source and the destination.
	Hops []*ConnectivityHop `json:"hops,omitempty" azure:"ro"`

	// READ-ONLY; Maximum latency in milliseconds.
	MaxLatencyInMs *int32 `json:"maxLatencyInMs,omitempty" azure:"ro"`

	// READ-ONLY; Minimum latency in milliseconds.
	MinLatencyInMs *int32 `json:"minLatencyInMs,omitempty" azure:"ro"`

	// READ-ONLY; Number of failed probes.
	ProbesFailed *int32 `json:"probesFailed,omitempty" azure:"ro"`

	// READ-ONLY; Total number of probes sent.
	ProbesSent *int32 `json:"probesSent,omitempty" azure:"ro"`
}

ConnectivityInformation - Information on the connectivity status.

func (ConnectivityInformation) MarshalJSON 

func (c ConnectivityInformation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityInformation.

type ConnectivityIssue 

type ConnectivityIssue struct {
	// READ-ONLY; Provides additional context on the issue.
	Context []map[string]*string `json:"context,omitempty" azure:"ro"`

	// READ-ONLY; The origin of the issue.
	Origin *Origin `json:"origin,omitempty" azure:"ro"`

	// READ-ONLY; The severity of the issue.
	Severity *Severity `json:"severity,omitempty" azure:"ro"`

	// READ-ONLY; The type of issue.
	Type *IssueType `json:"type,omitempty" azure:"ro"`
}

ConnectivityIssue - Information about an issue encountered in the process of checking for connectivity.

func (ConnectivityIssue) MarshalJSON 

func (c ConnectivityIssue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityIssue.

type ConnectivityParameters 

type ConnectivityParameters struct {
	// REQUIRED; The destination of connection.
	Destination *ConnectivityDestination `json:"destination,omitempty"`

	// REQUIRED; The source of the connection.
	Source *ConnectivitySource `json:"source,omitempty"`

	// Preferred IP version of the connection.
	PreferredIPVersion *IPVersion `json:"preferredIPVersion,omitempty"`

	// Network protocol.
	Protocol *Protocol `json:"protocol,omitempty"`

	// Configuration of the protocol.
	ProtocolConfiguration *ProtocolConfiguration `json:"protocolConfiguration,omitempty"`
}

ConnectivityParameters - Parameters that determine how the connectivity check will be performed.

type ConnectivitySource 

type ConnectivitySource struct {
	// REQUIRED; The ID of the resource from which a connectivity check will be initiated.
	ResourceID *string `json:"resourceId,omitempty"`

	// The source port from which a connectivity check will be performed.
	Port *int32 `json:"port,omitempty"`
}

ConnectivitySource - Parameters that define the source of the connection.

type Container 

type Container struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`
}

Container - Reference to container resource in remote resource provider.

type ContainerNetworkInterface 

type ContainerNetworkInterface struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Container network interface properties.
	Properties *ContainerNetworkInterfacePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Sub Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ContainerNetworkInterface - Container network interface child resource.

type ContainerNetworkInterfaceConfiguration 

type ContainerNetworkInterfaceConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Container network interface configuration properties.
	Properties *ContainerNetworkInterfaceConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Sub Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ContainerNetworkInterfaceConfiguration - Container network interface configuration child resource.

type ContainerNetworkInterfaceConfigurationPropertiesFormat 

type ContainerNetworkInterfaceConfigurationPropertiesFormat struct {
	// A list of container network interfaces created from this container network interface configuration.
	ContainerNetworkInterfaces []*SubResource `json:"containerNetworkInterfaces,omitempty"`

	// A list of ip configurations of the container network interface configuration.
	IPConfigurations []*IPConfigurationProfile `json:"ipConfigurations,omitempty"`

	// READ-ONLY; The provisioning state of the container network interface configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ContainerNetworkInterfaceConfigurationPropertiesFormat - Container network interface configuration properties.

func (ContainerNetworkInterfaceConfigurationPropertiesFormat) MarshalJSON 

func (c ContainerNetworkInterfaceConfigurationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkInterfaceConfigurationPropertiesFormat.

type ContainerNetworkInterfaceIPConfiguration 

type ContainerNetworkInterfaceIPConfiguration struct {
	// The name of the resource. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of the container network interface IP configuration.
	Properties *ContainerNetworkInterfaceIPConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Sub Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ContainerNetworkInterfaceIPConfiguration - The ip configuration for a container network interface.

type ContainerNetworkInterfaceIPConfigurationPropertiesFormat 

type ContainerNetworkInterfaceIPConfigurationPropertiesFormat struct {
	// READ-ONLY; The provisioning state of the container network interface IP configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ContainerNetworkInterfaceIPConfigurationPropertiesFormat - Properties of the container network interface IP configuration.

type ContainerNetworkInterfacePropertiesFormat 

type ContainerNetworkInterfacePropertiesFormat struct {
	// Reference to the container to which this container network interface is attached.
	Container *Container `json:"container,omitempty"`

	// READ-ONLY; Container network interface configuration from which this container network interface is created.
	ContainerNetworkInterfaceConfiguration *ContainerNetworkInterfaceConfiguration `json:"containerNetworkInterfaceConfiguration,omitempty" azure:"ro"`

	// READ-ONLY; Reference to the ip configuration on this container nic.
	IPConfigurations []*ContainerNetworkInterfaceIPConfiguration `json:"ipConfigurations,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the container network interface resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ContainerNetworkInterfacePropertiesFormat - Properties of container network interface.

func (ContainerNetworkInterfacePropertiesFormat) MarshalJSON 

func (c ContainerNetworkInterfacePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkInterfacePropertiesFormat.

type CoverageLevel 

type CoverageLevel string

CoverageLevel - Test coverage for the endpoint. 

const (
	CoverageLevelAboveAverage CoverageLevel = "AboveAverage"
	CoverageLevelAverage      CoverageLevel = "Average"
	CoverageLevelBelowAverage CoverageLevel = "BelowAverage"
	CoverageLevelDefault      CoverageLevel = "Default"
	CoverageLevelFull         CoverageLevel = "Full"
	CoverageLevelLow          CoverageLevel = "Low"
)

func PossibleCoverageLevelValues 

func PossibleCoverageLevelValues() []CoverageLevel

PossibleCoverageLevelValues returns the possible values for the CoverageLevel const type.

func (CoverageLevel) ToPtr 

func (c CoverageLevel) ToPtr() *CoverageLevel

ToPtr returns a *CoverageLevel pointing to the current value.

type CustomDNSConfigPropertiesFormat 

type CustomDNSConfigPropertiesFormat struct {
	// Fqdn that resolves to private endpoint ip address.
	Fqdn *string `json:"fqdn,omitempty"`

	// A list of private ip addresses of the private endpoint.
	IPAddresses []*string `json:"ipAddresses,omitempty"`
}

CustomDNSConfigPropertiesFormat - Contains custom Dns resolution configuration from customer.

func (CustomDNSConfigPropertiesFormat) MarshalJSON 

func (c CustomDNSConfigPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomDNSConfigPropertiesFormat.

type CustomIPPrefix 

type CustomIPPrefix struct {
	// The extended location of the custom IP prefix.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Custom IP prefix properties.
	Properties *CustomIPPrefixPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// A list of availability zones denoting the IP allocated for the resource needs to come from.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

CustomIPPrefix - Custom IP prefix resource.

func (CustomIPPrefix) MarshalJSON 

func (c CustomIPPrefix) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomIPPrefix.

type CustomIPPrefixListResult 

type CustomIPPrefixListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of Custom IP prefixes that exists in a resource group.
	Value []*CustomIPPrefix `json:"value,omitempty"`
}

CustomIPPrefixListResult - Response for ListCustomIpPrefixes API service call.

func (CustomIPPrefixListResult) MarshalJSON 

func (c CustomIPPrefixListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomIPPrefixListResult.

type CustomIPPrefixPropertiesFormat 

type CustomIPPrefixPropertiesFormat struct {
	// Authorization message for WAN validation.
	AuthorizationMessage *string `json:"authorizationMessage,omitempty"`

	// The prefix range in CIDR notation. Should include the start address and the prefix length.
	Cidr *string `json:"cidr,omitempty"`

	// The commissioned state of the Custom IP Prefix.
	CommissionedState *CommissionedState `json:"commissionedState,omitempty"`

	// The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
	CustomIPPrefixParent *SubResource `json:"customIpPrefixParent,omitempty"`

	// Signed message for WAN validation.
	SignedMessage *string `json:"signedMessage,omitempty"`

	// READ-ONLY; The list of all Children for IPv6 /48 CustomIpPrefix.
	ChildCustomIPPrefixes []*SubResource `json:"childCustomIpPrefixes,omitempty" azure:"ro"`

	// READ-ONLY; The reason why resource is in failed state.
	FailedReason *string `json:"failedReason,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the custom IP prefix resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The list of all referenced PublicIpPrefixes.
	PublicIPPrefixes []*SubResource `json:"publicIpPrefixes,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the custom IP prefix resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

CustomIPPrefixPropertiesFormat - Custom IP prefix properties.

func (CustomIPPrefixPropertiesFormat) MarshalJSON 

func (c CustomIPPrefixPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomIPPrefixPropertiesFormat.

type CustomIPPrefixesClient 

type CustomIPPrefixesClient struct {
	// contains filtered or unexported fields
}

CustomIPPrefixesClient contains the methods for the CustomIPPrefixes group. Don't use this type directly, use NewCustomIPPrefixesClient() instead.

func NewCustomIPPrefixesClient 

func NewCustomIPPrefixesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *CustomIPPrefixesClient

NewCustomIPPrefixesClient creates a new instance of CustomIPPrefixesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*CustomIPPrefixesClient) BeginCreateOrUpdate 

func (client *CustomIPPrefixesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, customIPPrefixName string, parameters CustomIPPrefix, options *CustomIPPrefixesClientBeginCreateOrUpdateOptions) (CustomIPPrefixesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a custom IP prefix. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. customIPPrefixName - The name of the custom IP prefix. parameters - Parameters supplied to the create or update custom IP prefix operation. options - CustomIPPrefixesClientBeginCreateOrUpdateOptions contains the optional parameters for the CustomIPPrefixesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CustomIpPrefixCreateCustomizedValues.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewCustomIPPrefixesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<custom-ipprefix-name>",
		armnetwork.CustomIPPrefix{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.CustomIPPrefixPropertiesFormat{
				Cidr: to.StringPtr("<cidr>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CustomIPPrefixesClientCreateOrUpdateResult)
}

Output:

func (*CustomIPPrefixesClient) BeginDelete 

func (client *CustomIPPrefixesClient) BeginDelete(ctx context.Context, resourceGroupName string, customIPPrefixName string, options *CustomIPPrefixesClientBeginDeleteOptions) (CustomIPPrefixesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified custom IP prefix. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. customIPPrefixName - The name of the CustomIpPrefix. options - CustomIPPrefixesClientBeginDeleteOptions contains the optional parameters for the CustomIPPrefixesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CustomIpPrefixDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewCustomIPPrefixesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<custom-ipprefix-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*CustomIPPrefixesClient) Get 

func (client *CustomIPPrefixesClient) Get(ctx context.Context, resourceGroupName string, customIPPrefixName string, options *CustomIPPrefixesClientGetOptions) (CustomIPPrefixesClientGetResponse, error)

Get - Gets the specified custom IP prefix in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. customIPPrefixName - The name of the custom IP prefix. options - CustomIPPrefixesClientGetOptions contains the optional parameters for the CustomIPPrefixesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CustomIpPrefixGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewCustomIPPrefixesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<custom-ipprefix-name>",
		&armnetwork.CustomIPPrefixesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CustomIPPrefixesClientGetResult)
}

Output:

func (*CustomIPPrefixesClient) List 

func (client *CustomIPPrefixesClient) List(resourceGroupName string, options *CustomIPPrefixesClientListOptions) *CustomIPPrefixesClientListPager

List - Gets all custom IP prefixes in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - CustomIPPrefixesClientListOptions contains the optional parameters for the CustomIPPrefixesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CustomIpPrefixList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewCustomIPPrefixesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*CustomIPPrefixesClient) ListAll 

func (client *CustomIPPrefixesClient) ListAll(options *CustomIPPrefixesClientListAllOptions) *CustomIPPrefixesClientListAllPager

ListAll - Gets all the custom IP prefixes in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - CustomIPPrefixesClientListAllOptions contains the optional parameters for the CustomIPPrefixesClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CustomIpPrefixListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewCustomIPPrefixesClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*CustomIPPrefixesClient) UpdateTags 

func (client *CustomIPPrefixesClient) UpdateTags(ctx context.Context, resourceGroupName string, customIPPrefixName string, parameters TagsObject, options *CustomIPPrefixesClientUpdateTagsOptions) (CustomIPPrefixesClientUpdateTagsResponse, error)

UpdateTags - Updates custom IP prefix tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. customIPPrefixName - The name of the custom IP prefix. parameters - Parameters supplied to update custom IP prefix tags. options - CustomIPPrefixesClientUpdateTagsOptions contains the optional parameters for the CustomIPPrefixesClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CustomIpPrefixUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewCustomIPPrefixesClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<custom-ipprefix-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CustomIPPrefixesClientUpdateTagsResult)
}

Output:

type CustomIPPrefixesClientBeginCreateOrUpdateOptions added in v0.3.0 

type CustomIPPrefixesClientBeginCreateOrUpdateOptions struct {
}

CustomIPPrefixesClientBeginCreateOrUpdateOptions contains the optional parameters for the CustomIPPrefixesClient.BeginCreateOrUpdate method.

type CustomIPPrefixesClientBeginDeleteOptions added in v0.3.0 

type CustomIPPrefixesClientBeginDeleteOptions struct {
}

CustomIPPrefixesClientBeginDeleteOptions contains the optional parameters for the CustomIPPrefixesClient.BeginDelete method.

type CustomIPPrefixesClientCreateOrUpdatePoller added in v0.3.0 

type CustomIPPrefixesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

CustomIPPrefixesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*CustomIPPrefixesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *CustomIPPrefixesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*CustomIPPrefixesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *CustomIPPrefixesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (CustomIPPrefixesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final CustomIPPrefixesClientCreateOrUpdateResponse will be returned.

func (*CustomIPPrefixesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *CustomIPPrefixesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*CustomIPPrefixesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *CustomIPPrefixesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type CustomIPPrefixesClientCreateOrUpdatePollerResponse added in v0.3.0 

type CustomIPPrefixesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *CustomIPPrefixesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CustomIPPrefixesClientCreateOrUpdatePollerResponse contains the response from method CustomIPPrefixesClient.CreateOrUpdate.

func (CustomIPPrefixesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l CustomIPPrefixesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (CustomIPPrefixesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*CustomIPPrefixesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *CustomIPPrefixesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *CustomIPPrefixesClient, token string) error

Resume rehydrates a CustomIPPrefixesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type CustomIPPrefixesClientCreateOrUpdateResponse added in v0.3.0 

type CustomIPPrefixesClientCreateOrUpdateResponse struct {
	CustomIPPrefixesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CustomIPPrefixesClientCreateOrUpdateResponse contains the response from method CustomIPPrefixesClient.CreateOrUpdate.

type CustomIPPrefixesClientCreateOrUpdateResult added in v0.3.0 

type CustomIPPrefixesClientCreateOrUpdateResult struct {
	CustomIPPrefix
}

CustomIPPrefixesClientCreateOrUpdateResult contains the result from method CustomIPPrefixesClient.CreateOrUpdate.

type CustomIPPrefixesClientDeletePoller added in v0.3.0 

type CustomIPPrefixesClientDeletePoller struct {
	// contains filtered or unexported fields
}

CustomIPPrefixesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*CustomIPPrefixesClientDeletePoller) Done added in v0.3.0 

func (p *CustomIPPrefixesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*CustomIPPrefixesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *CustomIPPrefixesClientDeletePoller) FinalResponse(ctx context.Context) (CustomIPPrefixesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final CustomIPPrefixesClientDeleteResponse will be returned.

func (*CustomIPPrefixesClientDeletePoller) Poll added in v0.3.0 

func (p *CustomIPPrefixesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*CustomIPPrefixesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *CustomIPPrefixesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type CustomIPPrefixesClientDeletePollerResponse added in v0.3.0 

type CustomIPPrefixesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *CustomIPPrefixesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CustomIPPrefixesClientDeletePollerResponse contains the response from method CustomIPPrefixesClient.Delete.

func (CustomIPPrefixesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l CustomIPPrefixesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (CustomIPPrefixesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*CustomIPPrefixesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *CustomIPPrefixesClientDeletePollerResponse) Resume(ctx context.Context, client *CustomIPPrefixesClient, token string) error

Resume rehydrates a CustomIPPrefixesClientDeletePollerResponse from the provided client and resume token.

type CustomIPPrefixesClientDeleteResponse added in v0.3.0 

type CustomIPPrefixesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CustomIPPrefixesClientDeleteResponse contains the response from method CustomIPPrefixesClient.Delete.

type CustomIPPrefixesClientGetOptions added in v0.3.0 

type CustomIPPrefixesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

CustomIPPrefixesClientGetOptions contains the optional parameters for the CustomIPPrefixesClient.Get method.

type CustomIPPrefixesClientGetResponse added in v0.3.0 

type CustomIPPrefixesClientGetResponse struct {
	CustomIPPrefixesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CustomIPPrefixesClientGetResponse contains the response from method CustomIPPrefixesClient.Get.

type CustomIPPrefixesClientGetResult added in v0.3.0 

type CustomIPPrefixesClientGetResult struct {
	CustomIPPrefix
}

CustomIPPrefixesClientGetResult contains the result from method CustomIPPrefixesClient.Get.

type CustomIPPrefixesClientListAllOptions added in v0.3.0 

type CustomIPPrefixesClientListAllOptions struct {
}

CustomIPPrefixesClientListAllOptions contains the optional parameters for the CustomIPPrefixesClient.ListAll method.

type CustomIPPrefixesClientListAllPager added in v0.3.0 

type CustomIPPrefixesClientListAllPager struct {
	// contains filtered or unexported fields
}

CustomIPPrefixesClientListAllPager provides operations for iterating over paged responses.

func (*CustomIPPrefixesClientListAllPager) Err added in v0.3.0 

func (p *CustomIPPrefixesClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*CustomIPPrefixesClientListAllPager) NextPage added in v0.3.0 

func (p *CustomIPPrefixesClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*CustomIPPrefixesClientListAllPager) PageResponse added in v0.3.0 

func (p *CustomIPPrefixesClientListAllPager) PageResponse() CustomIPPrefixesClientListAllResponse

PageResponse returns the current CustomIPPrefixesClientListAllResponse page.

type CustomIPPrefixesClientListAllResponse added in v0.3.0 

type CustomIPPrefixesClientListAllResponse struct {
	CustomIPPrefixesClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CustomIPPrefixesClientListAllResponse contains the response from method CustomIPPrefixesClient.ListAll.

type CustomIPPrefixesClientListAllResult added in v0.3.0 

type CustomIPPrefixesClientListAllResult struct {
	CustomIPPrefixListResult
}

CustomIPPrefixesClientListAllResult contains the result from method CustomIPPrefixesClient.ListAll.

type CustomIPPrefixesClientListOptions added in v0.3.0 

type CustomIPPrefixesClientListOptions struct {
}

CustomIPPrefixesClientListOptions contains the optional parameters for the CustomIPPrefixesClient.List method.

type CustomIPPrefixesClientListPager added in v0.3.0 

type CustomIPPrefixesClientListPager struct {
	// contains filtered or unexported fields
}

CustomIPPrefixesClientListPager provides operations for iterating over paged responses.

func (*CustomIPPrefixesClientListPager) Err added in v0.3.0 

func (p *CustomIPPrefixesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*CustomIPPrefixesClientListPager) NextPage added in v0.3.0 

func (p *CustomIPPrefixesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*CustomIPPrefixesClientListPager) PageResponse added in v0.3.0 

func (p *CustomIPPrefixesClientListPager) PageResponse() CustomIPPrefixesClientListResponse

PageResponse returns the current CustomIPPrefixesClientListResponse page.

type CustomIPPrefixesClientListResponse added in v0.3.0 

type CustomIPPrefixesClientListResponse struct {
	CustomIPPrefixesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CustomIPPrefixesClientListResponse contains the response from method CustomIPPrefixesClient.List.

type CustomIPPrefixesClientListResult added in v0.3.0 

type CustomIPPrefixesClientListResult struct {
	CustomIPPrefixListResult
}

CustomIPPrefixesClientListResult contains the result from method CustomIPPrefixesClient.List.

type CustomIPPrefixesClientUpdateTagsOptions added in v0.3.0 

type CustomIPPrefixesClientUpdateTagsOptions struct {
}

CustomIPPrefixesClientUpdateTagsOptions contains the optional parameters for the CustomIPPrefixesClient.UpdateTags method.

type CustomIPPrefixesClientUpdateTagsResponse added in v0.3.0 

type CustomIPPrefixesClientUpdateTagsResponse struct {
	CustomIPPrefixesClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CustomIPPrefixesClientUpdateTagsResponse contains the response from method CustomIPPrefixesClient.UpdateTags.

type CustomIPPrefixesClientUpdateTagsResult added in v0.3.0 

type CustomIPPrefixesClientUpdateTagsResult struct {
	CustomIPPrefix
}

CustomIPPrefixesClientUpdateTagsResult contains the result from method CustomIPPrefixesClient.UpdateTags.

type DNSNameAvailabilityResult 

type DNSNameAvailabilityResult struct {
	// Domain availability (True/False).
	Available *bool `json:"available,omitempty"`
}

DNSNameAvailabilityResult - Response for the CheckDnsNameAvailability API service call.

type DNSSettings 

type DNSSettings struct {
	// Enable DNS Proxy on Firewalls attached to the Firewall Policy.
	EnableProxy *bool `json:"enableProxy,omitempty"`

	// FQDNs in Network Rules are supported when set to true.
	RequireProxyForNetworkRules *bool `json:"requireProxyForNetworkRules,omitempty"`

	// List of Custom DNS Servers.
	Servers []*string `json:"servers,omitempty"`
}

DNSSettings - DNS Proxy Settings in Firewall Policy.

func (DNSSettings) MarshalJSON 

func (d DNSSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DNSSettings.

type DdosCustomPoliciesClient 

type DdosCustomPoliciesClient struct {
	// contains filtered or unexported fields
}

DdosCustomPoliciesClient contains the methods for the DdosCustomPolicies group. Don't use this type directly, use NewDdosCustomPoliciesClient() instead.

func NewDdosCustomPoliciesClient 

func NewDdosCustomPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DdosCustomPoliciesClient

NewDdosCustomPoliciesClient creates a new instance of DdosCustomPoliciesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DdosCustomPoliciesClient) BeginCreateOrUpdate 

func (client *DdosCustomPoliciesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, ddosCustomPolicyName string, parameters DdosCustomPolicy, options *DdosCustomPoliciesClientBeginCreateOrUpdateOptions) (DdosCustomPoliciesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a DDoS custom policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ddosCustomPolicyName - The name of the DDoS custom policy. parameters - Parameters supplied to the create or update operation. options - DdosCustomPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the DdosCustomPoliciesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DdosCustomPolicyCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDdosCustomPoliciesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<ddos-custom-policy-name>",
		armnetwork.DdosCustomPolicy{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.DdosCustomPolicyPropertiesFormat{
				ProtocolCustomSettings: []*armnetwork.ProtocolCustomSettingsFormat{
					{
						Protocol: armnetwork.DdosCustomPolicyProtocol("Tcp").ToPtr(),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DdosCustomPoliciesClientCreateOrUpdateResult)
}

Output:

func (*DdosCustomPoliciesClient) BeginDelete 

func (client *DdosCustomPoliciesClient) BeginDelete(ctx context.Context, resourceGroupName string, ddosCustomPolicyName string, options *DdosCustomPoliciesClientBeginDeleteOptions) (DdosCustomPoliciesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified DDoS custom policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ddosCustomPolicyName - The name of the DDoS custom policy. options - DdosCustomPoliciesClientBeginDeleteOptions contains the optional parameters for the DdosCustomPoliciesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DdosCustomPolicyDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDdosCustomPoliciesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<ddos-custom-policy-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*DdosCustomPoliciesClient) Get 

func (client *DdosCustomPoliciesClient) Get(ctx context.Context, resourceGroupName string, ddosCustomPolicyName string, options *DdosCustomPoliciesClientGetOptions) (DdosCustomPoliciesClientGetResponse, error)

Get - Gets information about the specified DDoS custom policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ddosCustomPolicyName - The name of the DDoS custom policy. options - DdosCustomPoliciesClientGetOptions contains the optional parameters for the DdosCustomPoliciesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DdosCustomPolicyGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDdosCustomPoliciesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<ddos-custom-policy-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DdosCustomPoliciesClientGetResult)
}

Output:

func (*DdosCustomPoliciesClient) UpdateTags 

func (client *DdosCustomPoliciesClient) UpdateTags(ctx context.Context, resourceGroupName string, ddosCustomPolicyName string, parameters TagsObject, options *DdosCustomPoliciesClientUpdateTagsOptions) (DdosCustomPoliciesClientUpdateTagsResponse, error)

UpdateTags - Update a DDoS custom policy tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ddosCustomPolicyName - The name of the DDoS custom policy. parameters - Parameters supplied to update DDoS custom policy resource tags. options - DdosCustomPoliciesClientUpdateTagsOptions contains the optional parameters for the DdosCustomPoliciesClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DdosCustomPolicyUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDdosCustomPoliciesClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<ddos-custom-policy-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DdosCustomPoliciesClientUpdateTagsResult)
}

Output:

type DdosCustomPoliciesClientBeginCreateOrUpdateOptions added in v0.3.0 

type DdosCustomPoliciesClientBeginCreateOrUpdateOptions struct {
}

DdosCustomPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the DdosCustomPoliciesClient.BeginCreateOrUpdate method.

type DdosCustomPoliciesClientBeginDeleteOptions added in v0.3.0 

type DdosCustomPoliciesClientBeginDeleteOptions struct {
}

DdosCustomPoliciesClientBeginDeleteOptions contains the optional parameters for the DdosCustomPoliciesClient.BeginDelete method.

type DdosCustomPoliciesClientCreateOrUpdatePoller added in v0.3.0 

type DdosCustomPoliciesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

DdosCustomPoliciesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*DdosCustomPoliciesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *DdosCustomPoliciesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DdosCustomPoliciesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *DdosCustomPoliciesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (DdosCustomPoliciesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DdosCustomPoliciesClientCreateOrUpdateResponse will be returned.

func (*DdosCustomPoliciesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *DdosCustomPoliciesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DdosCustomPoliciesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *DdosCustomPoliciesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DdosCustomPoliciesClientCreateOrUpdatePollerResponse added in v0.3.0 

type DdosCustomPoliciesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DdosCustomPoliciesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosCustomPoliciesClientCreateOrUpdatePollerResponse contains the response from method DdosCustomPoliciesClient.CreateOrUpdate.

func (DdosCustomPoliciesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l DdosCustomPoliciesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DdosCustomPoliciesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DdosCustomPoliciesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *DdosCustomPoliciesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *DdosCustomPoliciesClient, token string) error

Resume rehydrates a DdosCustomPoliciesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type DdosCustomPoliciesClientCreateOrUpdateResponse added in v0.3.0 

type DdosCustomPoliciesClientCreateOrUpdateResponse struct {
	DdosCustomPoliciesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosCustomPoliciesClientCreateOrUpdateResponse contains the response from method DdosCustomPoliciesClient.CreateOrUpdate.

type DdosCustomPoliciesClientCreateOrUpdateResult added in v0.3.0 

type DdosCustomPoliciesClientCreateOrUpdateResult struct {
	DdosCustomPolicy
}

DdosCustomPoliciesClientCreateOrUpdateResult contains the result from method DdosCustomPoliciesClient.CreateOrUpdate.

type DdosCustomPoliciesClientDeletePoller added in v0.3.0 

type DdosCustomPoliciesClientDeletePoller struct {
	// contains filtered or unexported fields
}

DdosCustomPoliciesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*DdosCustomPoliciesClientDeletePoller) Done added in v0.3.0 

func (p *DdosCustomPoliciesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DdosCustomPoliciesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *DdosCustomPoliciesClientDeletePoller) FinalResponse(ctx context.Context) (DdosCustomPoliciesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DdosCustomPoliciesClientDeleteResponse will be returned.

func (*DdosCustomPoliciesClientDeletePoller) Poll added in v0.3.0 

func (p *DdosCustomPoliciesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DdosCustomPoliciesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *DdosCustomPoliciesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DdosCustomPoliciesClientDeletePollerResponse added in v0.3.0 

type DdosCustomPoliciesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DdosCustomPoliciesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosCustomPoliciesClientDeletePollerResponse contains the response from method DdosCustomPoliciesClient.Delete.

func (DdosCustomPoliciesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l DdosCustomPoliciesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DdosCustomPoliciesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DdosCustomPoliciesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *DdosCustomPoliciesClientDeletePollerResponse) Resume(ctx context.Context, client *DdosCustomPoliciesClient, token string) error

Resume rehydrates a DdosCustomPoliciesClientDeletePollerResponse from the provided client and resume token.

type DdosCustomPoliciesClientDeleteResponse added in v0.3.0 

type DdosCustomPoliciesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosCustomPoliciesClientDeleteResponse contains the response from method DdosCustomPoliciesClient.Delete.

type DdosCustomPoliciesClientGetOptions added in v0.3.0 

type DdosCustomPoliciesClientGetOptions struct {
}

DdosCustomPoliciesClientGetOptions contains the optional parameters for the DdosCustomPoliciesClient.Get method.

type DdosCustomPoliciesClientGetResponse added in v0.3.0 

type DdosCustomPoliciesClientGetResponse struct {
	DdosCustomPoliciesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosCustomPoliciesClientGetResponse contains the response from method DdosCustomPoliciesClient.Get.

type DdosCustomPoliciesClientGetResult added in v0.3.0 

type DdosCustomPoliciesClientGetResult struct {
	DdosCustomPolicy
}

DdosCustomPoliciesClientGetResult contains the result from method DdosCustomPoliciesClient.Get.

type DdosCustomPoliciesClientUpdateTagsOptions added in v0.3.0 

type DdosCustomPoliciesClientUpdateTagsOptions struct {
}

DdosCustomPoliciesClientUpdateTagsOptions contains the optional parameters for the DdosCustomPoliciesClient.UpdateTags method.

type DdosCustomPoliciesClientUpdateTagsResponse added in v0.3.0 

type DdosCustomPoliciesClientUpdateTagsResponse struct {
	DdosCustomPoliciesClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosCustomPoliciesClientUpdateTagsResponse contains the response from method DdosCustomPoliciesClient.UpdateTags.

type DdosCustomPoliciesClientUpdateTagsResult added in v0.3.0 

type DdosCustomPoliciesClientUpdateTagsResult struct {
	DdosCustomPolicy
}

DdosCustomPoliciesClientUpdateTagsResult contains the result from method DdosCustomPoliciesClient.UpdateTags.

type DdosCustomPolicy 

type DdosCustomPolicy struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the DDoS custom policy.
	Properties *DdosCustomPolicyPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DdosCustomPolicy - A DDoS custom policy in a resource group.

func (DdosCustomPolicy) MarshalJSON 

func (d DdosCustomPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DdosCustomPolicy.

type DdosCustomPolicyPropertiesFormat 

type DdosCustomPolicyPropertiesFormat struct {
	// The protocol-specific DDoS policy customization parameters.
	ProtocolCustomSettings []*ProtocolCustomSettingsFormat `json:"protocolCustomSettings,omitempty"`

	// READ-ONLY; The provisioning state of the DDoS custom policy resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The list of public IPs associated with the DDoS custom policy resource. This list is read-only.
	PublicIPAddresses []*SubResource `json:"publicIPAddresses,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if
	// the user changes its name or migrate the resource across subscriptions or resource groups.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

DdosCustomPolicyPropertiesFormat - DDoS custom policy properties.

func (DdosCustomPolicyPropertiesFormat) MarshalJSON 

func (d DdosCustomPolicyPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DdosCustomPolicyPropertiesFormat.

type DdosCustomPolicyProtocol 

type DdosCustomPolicyProtocol string

DdosCustomPolicyProtocol - The protocol for which the DDoS protection policy is being customized. 

const (
	DdosCustomPolicyProtocolSyn DdosCustomPolicyProtocol = "Syn"
	DdosCustomPolicyProtocolTCP DdosCustomPolicyProtocol = "Tcp"
	DdosCustomPolicyProtocolUDP DdosCustomPolicyProtocol = "Udp"
)

func PossibleDdosCustomPolicyProtocolValues 

func PossibleDdosCustomPolicyProtocolValues() []DdosCustomPolicyProtocol

PossibleDdosCustomPolicyProtocolValues returns the possible values for the DdosCustomPolicyProtocol const type.

func (DdosCustomPolicyProtocol) ToPtr 

func (c DdosCustomPolicyProtocol) ToPtr() *DdosCustomPolicyProtocol

ToPtr returns a *DdosCustomPolicyProtocol pointing to the current value.

type DdosCustomPolicyTriggerSensitivityOverride 

type DdosCustomPolicyTriggerSensitivityOverride string

DdosCustomPolicyTriggerSensitivityOverride - The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic. 

const (
	DdosCustomPolicyTriggerSensitivityOverrideDefault DdosCustomPolicyTriggerSensitivityOverride = "Default"
	DdosCustomPolicyTriggerSensitivityOverrideHigh    DdosCustomPolicyTriggerSensitivityOverride = "High"
	DdosCustomPolicyTriggerSensitivityOverrideLow     DdosCustomPolicyTriggerSensitivityOverride = "Low"
	DdosCustomPolicyTriggerSensitivityOverrideRelaxed DdosCustomPolicyTriggerSensitivityOverride = "Relaxed"
)

func PossibleDdosCustomPolicyTriggerSensitivityOverrideValues 

func PossibleDdosCustomPolicyTriggerSensitivityOverrideValues() []DdosCustomPolicyTriggerSensitivityOverride

PossibleDdosCustomPolicyTriggerSensitivityOverrideValues returns the possible values for the DdosCustomPolicyTriggerSensitivityOverride const type.

func (DdosCustomPolicyTriggerSensitivityOverride) ToPtr 

func (c DdosCustomPolicyTriggerSensitivityOverride) ToPtr() *DdosCustomPolicyTriggerSensitivityOverride

ToPtr returns a *DdosCustomPolicyTriggerSensitivityOverride pointing to the current value.

type DdosProtectionPlan 

type DdosProtectionPlan struct {
	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the DDoS protection plan.
	Properties *DdosProtectionPlanPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DdosProtectionPlan - A DDoS protection plan in a resource group.

func (DdosProtectionPlan) MarshalJSON 

func (d DdosProtectionPlan) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DdosProtectionPlan.

type DdosProtectionPlanListResult 

type DdosProtectionPlanListResult struct {
	// A list of DDoS protection plans.
	Value []*DdosProtectionPlan `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

DdosProtectionPlanListResult - A list of DDoS protection plans.

func (DdosProtectionPlanListResult) MarshalJSON 

func (d DdosProtectionPlanListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DdosProtectionPlanListResult.

type DdosProtectionPlanPropertiesFormat 

type DdosProtectionPlanPropertiesFormat struct {
	// READ-ONLY; The provisioning state of the DDoS protection plan resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if
	// the user changes its name or migrate the resource across subscriptions or resource groups.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`

	// READ-ONLY; The list of virtual networks associated with the DDoS protection plan resource. This list is read-only.
	VirtualNetworks []*SubResource `json:"virtualNetworks,omitempty" azure:"ro"`
}

DdosProtectionPlanPropertiesFormat - DDoS protection plan properties.

func (DdosProtectionPlanPropertiesFormat) MarshalJSON 

func (d DdosProtectionPlanPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DdosProtectionPlanPropertiesFormat.

type DdosProtectionPlansClient 

type DdosProtectionPlansClient struct {
	// contains filtered or unexported fields
}

DdosProtectionPlansClient contains the methods for the DdosProtectionPlans group. Don't use this type directly, use NewDdosProtectionPlansClient() instead.

func NewDdosProtectionPlansClient 

func NewDdosProtectionPlansClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DdosProtectionPlansClient

NewDdosProtectionPlansClient creates a new instance of DdosProtectionPlansClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DdosProtectionPlansClient) BeginCreateOrUpdate 

func (client *DdosProtectionPlansClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, ddosProtectionPlanName string, parameters DdosProtectionPlan, options *DdosProtectionPlansClientBeginCreateOrUpdateOptions) (DdosProtectionPlansClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a DDoS protection plan. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ddosProtectionPlanName - The name of the DDoS protection plan. parameters - Parameters supplied to the create or update operation. options - DdosProtectionPlansClientBeginCreateOrUpdateOptions contains the optional parameters for the DdosProtectionPlansClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DdosProtectionPlanCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDdosProtectionPlansClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<ddos-protection-plan-name>",
		armnetwork.DdosProtectionPlan{
			Location:   to.StringPtr("<location>"),
			Properties: &armnetwork.DdosProtectionPlanPropertiesFormat{},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DdosProtectionPlansClientCreateOrUpdateResult)
}

Output:

func (*DdosProtectionPlansClient) BeginDelete 

func (client *DdosProtectionPlansClient) BeginDelete(ctx context.Context, resourceGroupName string, ddosProtectionPlanName string, options *DdosProtectionPlansClientBeginDeleteOptions) (DdosProtectionPlansClientDeletePollerResponse, error)

BeginDelete - Deletes the specified DDoS protection plan. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ddosProtectionPlanName - The name of the DDoS protection plan. options - DdosProtectionPlansClientBeginDeleteOptions contains the optional parameters for the DdosProtectionPlansClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DdosProtectionPlanDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDdosProtectionPlansClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<ddos-protection-plan-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*DdosProtectionPlansClient) Get 

func (client *DdosProtectionPlansClient) Get(ctx context.Context, resourceGroupName string, ddosProtectionPlanName string, options *DdosProtectionPlansClientGetOptions) (DdosProtectionPlansClientGetResponse, error)

Get - Gets information about the specified DDoS protection plan. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ddosProtectionPlanName - The name of the DDoS protection plan. options - DdosProtectionPlansClientGetOptions contains the optional parameters for the DdosProtectionPlansClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DdosProtectionPlanGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDdosProtectionPlansClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<ddos-protection-plan-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DdosProtectionPlansClientGetResult)
}

Output:

func (*DdosProtectionPlansClient) List 

func (client *DdosProtectionPlansClient) List(options *DdosProtectionPlansClientListOptions) *DdosProtectionPlansClientListPager

List - Gets all DDoS protection plans in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - DdosProtectionPlansClientListOptions contains the optional parameters for the DdosProtectionPlansClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DdosProtectionPlanListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDdosProtectionPlansClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*DdosProtectionPlansClient) ListByResourceGroup 

func (client *DdosProtectionPlansClient) ListByResourceGroup(resourceGroupName string, options *DdosProtectionPlansClientListByResourceGroupOptions) *DdosProtectionPlansClientListByResourceGroupPager

ListByResourceGroup - Gets all the DDoS protection plans in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - DdosProtectionPlansClientListByResourceGroupOptions contains the optional parameters for the DdosProtectionPlansClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DdosProtectionPlanList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDdosProtectionPlansClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*DdosProtectionPlansClient) UpdateTags 

func (client *DdosProtectionPlansClient) UpdateTags(ctx context.Context, resourceGroupName string, ddosProtectionPlanName string, parameters TagsObject, options *DdosProtectionPlansClientUpdateTagsOptions) (DdosProtectionPlansClientUpdateTagsResponse, error)

UpdateTags - Update a DDoS protection plan tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ddosProtectionPlanName - The name of the DDoS protection plan. parameters - Parameters supplied to the update DDoS protection plan resource tags. options - DdosProtectionPlansClientUpdateTagsOptions contains the optional parameters for the DdosProtectionPlansClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DdosProtectionPlanUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDdosProtectionPlansClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<ddos-protection-plan-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DdosProtectionPlansClientUpdateTagsResult)
}

Output:

type DdosProtectionPlansClientBeginCreateOrUpdateOptions added in v0.3.0 

type DdosProtectionPlansClientBeginCreateOrUpdateOptions struct {
}

DdosProtectionPlansClientBeginCreateOrUpdateOptions contains the optional parameters for the DdosProtectionPlansClient.BeginCreateOrUpdate method.

type DdosProtectionPlansClientBeginDeleteOptions added in v0.3.0 

type DdosProtectionPlansClientBeginDeleteOptions struct {
}

DdosProtectionPlansClientBeginDeleteOptions contains the optional parameters for the DdosProtectionPlansClient.BeginDelete method.

type DdosProtectionPlansClientCreateOrUpdatePoller added in v0.3.0 

type DdosProtectionPlansClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

DdosProtectionPlansClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*DdosProtectionPlansClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *DdosProtectionPlansClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DdosProtectionPlansClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *DdosProtectionPlansClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (DdosProtectionPlansClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DdosProtectionPlansClientCreateOrUpdateResponse will be returned.

func (*DdosProtectionPlansClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *DdosProtectionPlansClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DdosProtectionPlansClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *DdosProtectionPlansClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DdosProtectionPlansClientCreateOrUpdatePollerResponse added in v0.3.0 

type DdosProtectionPlansClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DdosProtectionPlansClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosProtectionPlansClientCreateOrUpdatePollerResponse contains the response from method DdosProtectionPlansClient.CreateOrUpdate.

func (DdosProtectionPlansClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l DdosProtectionPlansClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DdosProtectionPlansClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DdosProtectionPlansClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *DdosProtectionPlansClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *DdosProtectionPlansClient, token string) error

Resume rehydrates a DdosProtectionPlansClientCreateOrUpdatePollerResponse from the provided client and resume token.

type DdosProtectionPlansClientCreateOrUpdateResponse added in v0.3.0 

type DdosProtectionPlansClientCreateOrUpdateResponse struct {
	DdosProtectionPlansClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosProtectionPlansClientCreateOrUpdateResponse contains the response from method DdosProtectionPlansClient.CreateOrUpdate.

type DdosProtectionPlansClientCreateOrUpdateResult added in v0.3.0 

type DdosProtectionPlansClientCreateOrUpdateResult struct {
	DdosProtectionPlan
}

DdosProtectionPlansClientCreateOrUpdateResult contains the result from method DdosProtectionPlansClient.CreateOrUpdate.

type DdosProtectionPlansClientDeletePoller added in v0.3.0 

type DdosProtectionPlansClientDeletePoller struct {
	// contains filtered or unexported fields
}

DdosProtectionPlansClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*DdosProtectionPlansClientDeletePoller) Done added in v0.3.0 

func (p *DdosProtectionPlansClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DdosProtectionPlansClientDeletePoller) FinalResponse added in v0.3.0 

func (p *DdosProtectionPlansClientDeletePoller) FinalResponse(ctx context.Context) (DdosProtectionPlansClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DdosProtectionPlansClientDeleteResponse will be returned.

func (*DdosProtectionPlansClientDeletePoller) Poll added in v0.3.0 

func (p *DdosProtectionPlansClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DdosProtectionPlansClientDeletePoller) ResumeToken added in v0.3.0 

func (p *DdosProtectionPlansClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DdosProtectionPlansClientDeletePollerResponse added in v0.3.0 

type DdosProtectionPlansClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DdosProtectionPlansClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosProtectionPlansClientDeletePollerResponse contains the response from method DdosProtectionPlansClient.Delete.

func (DdosProtectionPlansClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l DdosProtectionPlansClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DdosProtectionPlansClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DdosProtectionPlansClientDeletePollerResponse) Resume added in v0.3.0 

func (l *DdosProtectionPlansClientDeletePollerResponse) Resume(ctx context.Context, client *DdosProtectionPlansClient, token string) error

Resume rehydrates a DdosProtectionPlansClientDeletePollerResponse from the provided client and resume token.

type DdosProtectionPlansClientDeleteResponse added in v0.3.0 

type DdosProtectionPlansClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosProtectionPlansClientDeleteResponse contains the response from method DdosProtectionPlansClient.Delete.

type DdosProtectionPlansClientGetOptions added in v0.3.0 

type DdosProtectionPlansClientGetOptions struct {
}

DdosProtectionPlansClientGetOptions contains the optional parameters for the DdosProtectionPlansClient.Get method.

type DdosProtectionPlansClientGetResponse added in v0.3.0 

type DdosProtectionPlansClientGetResponse struct {
	DdosProtectionPlansClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosProtectionPlansClientGetResponse contains the response from method DdosProtectionPlansClient.Get.

type DdosProtectionPlansClientGetResult added in v0.3.0 

type DdosProtectionPlansClientGetResult struct {
	DdosProtectionPlan
}

DdosProtectionPlansClientGetResult contains the result from method DdosProtectionPlansClient.Get.

type DdosProtectionPlansClientListByResourceGroupOptions added in v0.3.0 

type DdosProtectionPlansClientListByResourceGroupOptions struct {
}

DdosProtectionPlansClientListByResourceGroupOptions contains the optional parameters for the DdosProtectionPlansClient.ListByResourceGroup method.

type DdosProtectionPlansClientListByResourceGroupPager added in v0.3.0 

type DdosProtectionPlansClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

DdosProtectionPlansClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*DdosProtectionPlansClientListByResourceGroupPager) Err added in v0.3.0 

func (p *DdosProtectionPlansClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*DdosProtectionPlansClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *DdosProtectionPlansClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DdosProtectionPlansClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *DdosProtectionPlansClientListByResourceGroupPager) PageResponse() DdosProtectionPlansClientListByResourceGroupResponse

PageResponse returns the current DdosProtectionPlansClientListByResourceGroupResponse page.

type DdosProtectionPlansClientListByResourceGroupResponse added in v0.3.0 

type DdosProtectionPlansClientListByResourceGroupResponse struct {
	DdosProtectionPlansClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosProtectionPlansClientListByResourceGroupResponse contains the response from method DdosProtectionPlansClient.ListByResourceGroup.

type DdosProtectionPlansClientListByResourceGroupResult added in v0.3.0 

type DdosProtectionPlansClientListByResourceGroupResult struct {
	DdosProtectionPlanListResult
}

DdosProtectionPlansClientListByResourceGroupResult contains the result from method DdosProtectionPlansClient.ListByResourceGroup.

type DdosProtectionPlansClientListOptions added in v0.3.0 

type DdosProtectionPlansClientListOptions struct {
}

DdosProtectionPlansClientListOptions contains the optional parameters for the DdosProtectionPlansClient.List method.

type DdosProtectionPlansClientListPager added in v0.3.0 

type DdosProtectionPlansClientListPager struct {
	// contains filtered or unexported fields
}

DdosProtectionPlansClientListPager provides operations for iterating over paged responses.

func (*DdosProtectionPlansClientListPager) Err added in v0.3.0 

func (p *DdosProtectionPlansClientListPager) Err() error

Err returns the last error encountered while paging.

func (*DdosProtectionPlansClientListPager) NextPage added in v0.3.0 

func (p *DdosProtectionPlansClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DdosProtectionPlansClientListPager) PageResponse added in v0.3.0 

func (p *DdosProtectionPlansClientListPager) PageResponse() DdosProtectionPlansClientListResponse

PageResponse returns the current DdosProtectionPlansClientListResponse page.

type DdosProtectionPlansClientListResponse added in v0.3.0 

type DdosProtectionPlansClientListResponse struct {
	DdosProtectionPlansClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosProtectionPlansClientListResponse contains the response from method DdosProtectionPlansClient.List.

type DdosProtectionPlansClientListResult added in v0.3.0 

type DdosProtectionPlansClientListResult struct {
	DdosProtectionPlanListResult
}

DdosProtectionPlansClientListResult contains the result from method DdosProtectionPlansClient.List.

type DdosProtectionPlansClientUpdateTagsOptions added in v0.3.0 

type DdosProtectionPlansClientUpdateTagsOptions struct {
}

DdosProtectionPlansClientUpdateTagsOptions contains the optional parameters for the DdosProtectionPlansClient.UpdateTags method.

type DdosProtectionPlansClientUpdateTagsResponse added in v0.3.0 

type DdosProtectionPlansClientUpdateTagsResponse struct {
	DdosProtectionPlansClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DdosProtectionPlansClientUpdateTagsResponse contains the response from method DdosProtectionPlansClient.UpdateTags.

type DdosProtectionPlansClientUpdateTagsResult added in v0.3.0 

type DdosProtectionPlansClientUpdateTagsResult struct {
	DdosProtectionPlan
}

DdosProtectionPlansClientUpdateTagsResult contains the result from method DdosProtectionPlansClient.UpdateTags.

type DdosSettings 

type DdosSettings struct {
	// The DDoS custom policy associated with the public IP.
	DdosCustomPolicy *SubResource `json:"ddosCustomPolicy,omitempty"`

	// Enables DDoS protection on the public IP.
	ProtectedIP *bool `json:"protectedIP,omitempty"`

	// The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.
	ProtectionCoverage *DdosSettingsProtectionCoverage `json:"protectionCoverage,omitempty"`
}

DdosSettings - Contains the DDoS protection settings of the public IP.

type DdosSettingsProtectionCoverage 

type DdosSettingsProtectionCoverage string

DdosSettingsProtectionCoverage - The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. 

const (
	DdosSettingsProtectionCoverageBasic    DdosSettingsProtectionCoverage = "Basic"
	DdosSettingsProtectionCoverageStandard DdosSettingsProtectionCoverage = "Standard"
)

func PossibleDdosSettingsProtectionCoverageValues 

func PossibleDdosSettingsProtectionCoverageValues() []DdosSettingsProtectionCoverage

PossibleDdosSettingsProtectionCoverageValues returns the possible values for the DdosSettingsProtectionCoverage const type.

func (DdosSettingsProtectionCoverage) ToPtr 

func (c DdosSettingsProtectionCoverage) ToPtr() *DdosSettingsProtectionCoverage

ToPtr returns a *DdosSettingsProtectionCoverage pointing to the current value.

type DefaultSecurityRulesClient 

type DefaultSecurityRulesClient struct {
	// contains filtered or unexported fields
}

DefaultSecurityRulesClient contains the methods for the DefaultSecurityRules group. Don't use this type directly, use NewDefaultSecurityRulesClient() instead.

func NewDefaultSecurityRulesClient 

func NewDefaultSecurityRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DefaultSecurityRulesClient

NewDefaultSecurityRulesClient creates a new instance of DefaultSecurityRulesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DefaultSecurityRulesClient) Get 

func (client *DefaultSecurityRulesClient) Get(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, defaultSecurityRuleName string, options *DefaultSecurityRulesClientGetOptions) (DefaultSecurityRulesClientGetResponse, error)

Get - Get the specified default network security rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkSecurityGroupName - The name of the network security group. defaultSecurityRuleName - The name of the default security rule. options - DefaultSecurityRulesClientGetOptions contains the optional parameters for the DefaultSecurityRulesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DefaultSecurityRuleGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDefaultSecurityRulesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-security-group-name>",
		"<default-security-rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DefaultSecurityRulesClientGetResult)
}

Output:

func (*DefaultSecurityRulesClient) List 

func (client *DefaultSecurityRulesClient) List(resourceGroupName string, networkSecurityGroupName string, options *DefaultSecurityRulesClientListOptions) *DefaultSecurityRulesClientListPager

List - Gets all default security rules in a network security group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkSecurityGroupName - The name of the network security group. options - DefaultSecurityRulesClientListOptions contains the optional parameters for the DefaultSecurityRulesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DefaultSecurityRuleList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDefaultSecurityRulesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<network-security-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type DefaultSecurityRulesClientGetOptions added in v0.3.0 

type DefaultSecurityRulesClientGetOptions struct {
}

DefaultSecurityRulesClientGetOptions contains the optional parameters for the DefaultSecurityRulesClient.Get method.

type DefaultSecurityRulesClientGetResponse added in v0.3.0 

type DefaultSecurityRulesClientGetResponse struct {
	DefaultSecurityRulesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DefaultSecurityRulesClientGetResponse contains the response from method DefaultSecurityRulesClient.Get.

type DefaultSecurityRulesClientGetResult added in v0.3.0 

type DefaultSecurityRulesClientGetResult struct {
	SecurityRule
}

DefaultSecurityRulesClientGetResult contains the result from method DefaultSecurityRulesClient.Get.

type DefaultSecurityRulesClientListOptions added in v0.3.0 

type DefaultSecurityRulesClientListOptions struct {
}

DefaultSecurityRulesClientListOptions contains the optional parameters for the DefaultSecurityRulesClient.List method.

type DefaultSecurityRulesClientListPager added in v0.3.0 

type DefaultSecurityRulesClientListPager struct {
	// contains filtered or unexported fields
}

DefaultSecurityRulesClientListPager provides operations for iterating over paged responses.

func (*DefaultSecurityRulesClientListPager) Err added in v0.3.0 

func (p *DefaultSecurityRulesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*DefaultSecurityRulesClientListPager) NextPage added in v0.3.0 

func (p *DefaultSecurityRulesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DefaultSecurityRulesClientListPager) PageResponse added in v0.3.0 

func (p *DefaultSecurityRulesClientListPager) PageResponse() DefaultSecurityRulesClientListResponse

PageResponse returns the current DefaultSecurityRulesClientListResponse page.

type DefaultSecurityRulesClientListResponse added in v0.3.0 

type DefaultSecurityRulesClientListResponse struct {
	DefaultSecurityRulesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DefaultSecurityRulesClientListResponse contains the response from method DefaultSecurityRulesClient.List.

type DefaultSecurityRulesClientListResult added in v0.3.0 

type DefaultSecurityRulesClientListResult struct {
	SecurityRuleListResult
}

DefaultSecurityRulesClientListResult contains the result from method DefaultSecurityRulesClient.List.

type Delegation 

type Delegation struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within a subnet. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of the subnet.
	Properties *ServiceDelegationPropertiesFormat `json:"properties,omitempty"`

	// Resource type.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

Delegation - Details the service to which the subnet is delegated.

type DeleteOptions 

type DeleteOptions string

DeleteOptions - Specify what happens to the public IP address when the VM using it is deleted 

const (
	DeleteOptionsDelete DeleteOptions = "Delete"
	DeleteOptionsDetach DeleteOptions = "Detach"
)

func PossibleDeleteOptionsValues 

func PossibleDeleteOptionsValues() []DeleteOptions

PossibleDeleteOptionsValues returns the possible values for the DeleteOptions const type.

func (DeleteOptions) ToPtr 

func (c DeleteOptions) ToPtr() *DeleteOptions

ToPtr returns a *DeleteOptions pointing to the current value.

type DestinationPortBehavior 

type DestinationPortBehavior string

DestinationPortBehavior - Destination port behavior. 

const (
	DestinationPortBehaviorListenIfAvailable DestinationPortBehavior = "ListenIfAvailable"
	DestinationPortBehaviorNone              DestinationPortBehavior = "None"
)

func PossibleDestinationPortBehaviorValues 

func PossibleDestinationPortBehaviorValues() []DestinationPortBehavior

PossibleDestinationPortBehaviorValues returns the possible values for the DestinationPortBehavior const type.

func (DestinationPortBehavior) ToPtr 

func (c DestinationPortBehavior) ToPtr() *DestinationPortBehavior

ToPtr returns a *DestinationPortBehavior pointing to the current value.

type DeviceProperties 

type DeviceProperties struct {
	// Model of the device.
	DeviceModel *string `json:"deviceModel,omitempty"`

	// Name of the device Vendor.
	DeviceVendor *string `json:"deviceVendor,omitempty"`

	// Link speed.
	LinkSpeedInMbps *int32 `json:"linkSpeedInMbps,omitempty"`
}

DeviceProperties - List of properties of the device.

type DhGroup 

type DhGroup string

DhGroup - The DH Groups used in IKE Phase 1 for initial SA. 

const (
	DhGroupDHGroup1    DhGroup = "DHGroup1"
	DhGroupDHGroup14   DhGroup = "DHGroup14"
	DhGroupDHGroup2    DhGroup = "DHGroup2"
	DhGroupDHGroup2048 DhGroup = "DHGroup2048"
	DhGroupDHGroup24   DhGroup = "DHGroup24"
	DhGroupECP256      DhGroup = "ECP256"
	DhGroupECP384      DhGroup = "ECP384"
	DhGroupNone        DhGroup = "None"
)

func PossibleDhGroupValues 

func PossibleDhGroupValues() []DhGroup

PossibleDhGroupValues returns the possible values for the DhGroup const type.

func (DhGroup) ToPtr 

func (c DhGroup) ToPtr() *DhGroup

ToPtr returns a *DhGroup pointing to the current value.

type DhcpOptions 

type DhcpOptions struct {
	// The list of DNS servers IP addresses.
	DNSServers []*string `json:"dnsServers,omitempty"`
}

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.

func (DhcpOptions) MarshalJSON 

func (d DhcpOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DhcpOptions.

type Dimension 

type Dimension struct {
	// The display name of the dimension.
	DisplayName *string `json:"displayName,omitempty"`

	// The internal name of the dimension.
	InternalName *string `json:"internalName,omitempty"`

	// The name of the dimension.
	Name *string `json:"name,omitempty"`
}

Dimension of the metric.

type Direction 

type Direction string

Direction - The direction of the traffic. 

const (
	DirectionInbound  Direction = "Inbound"
	DirectionOutbound Direction = "Outbound"
)

func PossibleDirectionValues 

func PossibleDirectionValues() []Direction

PossibleDirectionValues returns the possible values for the Direction const type.

func (Direction) ToPtr 

func (c Direction) ToPtr() *Direction

ToPtr returns a *Direction pointing to the current value.

type DscpConfiguration 

type DscpConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the network interface.
	Properties *DscpConfigurationPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DscpConfiguration - Differentiated Services Code Point configuration for any given network interface

func (DscpConfiguration) MarshalJSON 

func (d DscpConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscpConfiguration.

type DscpConfigurationClient 

type DscpConfigurationClient struct {
	// contains filtered or unexported fields
}

DscpConfigurationClient contains the methods for the DscpConfiguration group. Don't use this type directly, use NewDscpConfigurationClient() instead.

func NewDscpConfigurationClient 

func NewDscpConfigurationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DscpConfigurationClient

NewDscpConfigurationClient creates a new instance of DscpConfigurationClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DscpConfigurationClient) BeginCreateOrUpdate 

func (client *DscpConfigurationClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, dscpConfigurationName string, parameters DscpConfiguration, options *DscpConfigurationClientBeginCreateOrUpdateOptions) (DscpConfigurationClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a DSCP Configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. dscpConfigurationName - The name of the resource. parameters - Parameters supplied to the create or update dscp configuration operation. options - DscpConfigurationClientBeginCreateOrUpdateOptions contains the optional parameters for the DscpConfigurationClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DscpConfigurationCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDscpConfigurationClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<dscp-configuration-name>",
		armnetwork.DscpConfiguration{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.DscpConfigurationPropertiesFormat{
				QosDefinitionCollection: []*armnetwork.QosDefinition{
					{
						DestinationIPRanges: []*armnetwork.QosIPRange{
							{
								EndIP:   to.StringPtr("<end-ip>"),
								StartIP: to.StringPtr("<start-ip>"),
							}},
						DestinationPortRanges: []*armnetwork.QosPortRange{
							{
								End:   to.Int32Ptr(15),
								Start: to.Int32Ptr(15),
							}},
						Markings: []*int32{
							to.Int32Ptr(1)},
						SourceIPRanges: []*armnetwork.QosIPRange{
							{
								EndIP:   to.StringPtr("<end-ip>"),
								StartIP: to.StringPtr("<start-ip>"),
							}},
						SourcePortRanges: []*armnetwork.QosPortRange{
							{
								End:   to.Int32Ptr(11),
								Start: to.Int32Ptr(10),
							},
							{
								End:   to.Int32Ptr(21),
								Start: to.Int32Ptr(20),
							}},
						Protocol: armnetwork.ProtocolType("Tcp").ToPtr(),
					},
					{
						DestinationIPRanges: []*armnetwork.QosIPRange{
							{
								EndIP:   to.StringPtr("<end-ip>"),
								StartIP: to.StringPtr("<start-ip>"),
							}},
						DestinationPortRanges: []*armnetwork.QosPortRange{
							{
								End:   to.Int32Ptr(52),
								Start: to.Int32Ptr(51),
							}},
						Markings: []*int32{
							to.Int32Ptr(2)},
						SourceIPRanges: []*armnetwork.QosIPRange{
							{
								EndIP:   to.StringPtr("<end-ip>"),
								StartIP: to.StringPtr("<start-ip>"),
							}},
						SourcePortRanges: []*armnetwork.QosPortRange{
							{
								End:   to.Int32Ptr(12),
								Start: to.Int32Ptr(11),
							}},
						Protocol: armnetwork.ProtocolType("Udp").ToPtr(),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DscpConfigurationClientCreateOrUpdateResult)
}

Output:

func (*DscpConfigurationClient) BeginDelete 

func (client *DscpConfigurationClient) BeginDelete(ctx context.Context, resourceGroupName string, dscpConfigurationName string, options *DscpConfigurationClientBeginDeleteOptions) (DscpConfigurationClientDeletePollerResponse, error)

BeginDelete - Deletes a DSCP Configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. dscpConfigurationName - The name of the resource. options - DscpConfigurationClientBeginDeleteOptions contains the optional parameters for the DscpConfigurationClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DscpConfigurationDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDscpConfigurationClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<dscp-configuration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*DscpConfigurationClient) Get 

func (client *DscpConfigurationClient) Get(ctx context.Context, resourceGroupName string, dscpConfigurationName string, options *DscpConfigurationClientGetOptions) (DscpConfigurationClientGetResponse, error)

Get - Gets a DSCP Configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. dscpConfigurationName - The name of the resource. options - DscpConfigurationClientGetOptions contains the optional parameters for the DscpConfigurationClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DscpConfigurationGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDscpConfigurationClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<dscp-configuration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.DscpConfigurationClientGetResult)
}

Output:

func (*DscpConfigurationClient) List 

func (client *DscpConfigurationClient) List(resourceGroupName string, options *DscpConfigurationClientListOptions) *DscpConfigurationClientListPager

List - Gets a DSCP Configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - DscpConfigurationClientListOptions contains the optional parameters for the DscpConfigurationClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DscpConfigurationList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDscpConfigurationClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*DscpConfigurationClient) ListAll 

func (client *DscpConfigurationClient) ListAll(options *DscpConfigurationClientListAllOptions) *DscpConfigurationClientListAllPager

ListAll - Gets all dscp configurations in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - DscpConfigurationClientListAllOptions contains the optional parameters for the DscpConfigurationClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/DscpConfigurationListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewDscpConfigurationClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type DscpConfigurationClientBeginCreateOrUpdateOptions added in v0.3.0 

type DscpConfigurationClientBeginCreateOrUpdateOptions struct {
}

DscpConfigurationClientBeginCreateOrUpdateOptions contains the optional parameters for the DscpConfigurationClient.BeginCreateOrUpdate method.

type DscpConfigurationClientBeginDeleteOptions added in v0.3.0 

type DscpConfigurationClientBeginDeleteOptions struct {
}

DscpConfigurationClientBeginDeleteOptions contains the optional parameters for the DscpConfigurationClient.BeginDelete method.

type DscpConfigurationClientCreateOrUpdatePoller added in v0.3.0 

type DscpConfigurationClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

DscpConfigurationClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*DscpConfigurationClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *DscpConfigurationClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DscpConfigurationClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *DscpConfigurationClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (DscpConfigurationClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DscpConfigurationClientCreateOrUpdateResponse will be returned.

func (*DscpConfigurationClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *DscpConfigurationClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DscpConfigurationClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *DscpConfigurationClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DscpConfigurationClientCreateOrUpdatePollerResponse added in v0.3.0 

type DscpConfigurationClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DscpConfigurationClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DscpConfigurationClientCreateOrUpdatePollerResponse contains the response from method DscpConfigurationClient.CreateOrUpdate.

func (DscpConfigurationClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l DscpConfigurationClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DscpConfigurationClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DscpConfigurationClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *DscpConfigurationClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *DscpConfigurationClient, token string) error

Resume rehydrates a DscpConfigurationClientCreateOrUpdatePollerResponse from the provided client and resume token.

type DscpConfigurationClientCreateOrUpdateResponse added in v0.3.0 

type DscpConfigurationClientCreateOrUpdateResponse struct {
	DscpConfigurationClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DscpConfigurationClientCreateOrUpdateResponse contains the response from method DscpConfigurationClient.CreateOrUpdate.

type DscpConfigurationClientCreateOrUpdateResult added in v0.3.0 

type DscpConfigurationClientCreateOrUpdateResult struct {
	DscpConfiguration
}

DscpConfigurationClientCreateOrUpdateResult contains the result from method DscpConfigurationClient.CreateOrUpdate.

type DscpConfigurationClientDeletePoller added in v0.3.0 

type DscpConfigurationClientDeletePoller struct {
	// contains filtered or unexported fields
}

DscpConfigurationClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*DscpConfigurationClientDeletePoller) Done added in v0.3.0 

func (p *DscpConfigurationClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DscpConfigurationClientDeletePoller) FinalResponse added in v0.3.0 

func (p *DscpConfigurationClientDeletePoller) FinalResponse(ctx context.Context) (DscpConfigurationClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DscpConfigurationClientDeleteResponse will be returned.

func (*DscpConfigurationClientDeletePoller) Poll added in v0.3.0 

func (p *DscpConfigurationClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DscpConfigurationClientDeletePoller) ResumeToken added in v0.3.0 

func (p *DscpConfigurationClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DscpConfigurationClientDeletePollerResponse added in v0.3.0 

type DscpConfigurationClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DscpConfigurationClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DscpConfigurationClientDeletePollerResponse contains the response from method DscpConfigurationClient.Delete.

func (DscpConfigurationClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l DscpConfigurationClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DscpConfigurationClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DscpConfigurationClientDeletePollerResponse) Resume added in v0.3.0 

func (l *DscpConfigurationClientDeletePollerResponse) Resume(ctx context.Context, client *DscpConfigurationClient, token string) error

Resume rehydrates a DscpConfigurationClientDeletePollerResponse from the provided client and resume token.

type DscpConfigurationClientDeleteResponse added in v0.3.0 

type DscpConfigurationClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DscpConfigurationClientDeleteResponse contains the response from method DscpConfigurationClient.Delete.

type DscpConfigurationClientGetOptions added in v0.3.0 

type DscpConfigurationClientGetOptions struct {
}

DscpConfigurationClientGetOptions contains the optional parameters for the DscpConfigurationClient.Get method.

type DscpConfigurationClientGetResponse added in v0.3.0 

type DscpConfigurationClientGetResponse struct {
	DscpConfigurationClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DscpConfigurationClientGetResponse contains the response from method DscpConfigurationClient.Get.

type DscpConfigurationClientGetResult added in v0.3.0 

type DscpConfigurationClientGetResult struct {
	DscpConfiguration
}

DscpConfigurationClientGetResult contains the result from method DscpConfigurationClient.Get.

type DscpConfigurationClientListAllOptions added in v0.3.0 

type DscpConfigurationClientListAllOptions struct {
}

DscpConfigurationClientListAllOptions contains the optional parameters for the DscpConfigurationClient.ListAll method.

type DscpConfigurationClientListAllPager added in v0.3.0 

type DscpConfigurationClientListAllPager struct {
	// contains filtered or unexported fields
}

DscpConfigurationClientListAllPager provides operations for iterating over paged responses.

func (*DscpConfigurationClientListAllPager) Err added in v0.3.0 

func (p *DscpConfigurationClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*DscpConfigurationClientListAllPager) NextPage added in v0.3.0 

func (p *DscpConfigurationClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DscpConfigurationClientListAllPager) PageResponse added in v0.3.0 

func (p *DscpConfigurationClientListAllPager) PageResponse() DscpConfigurationClientListAllResponse

PageResponse returns the current DscpConfigurationClientListAllResponse page.

type DscpConfigurationClientListAllResponse added in v0.3.0 

type DscpConfigurationClientListAllResponse struct {
	DscpConfigurationClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DscpConfigurationClientListAllResponse contains the response from method DscpConfigurationClient.ListAll.

type DscpConfigurationClientListAllResult added in v0.3.0 

type DscpConfigurationClientListAllResult struct {
	DscpConfigurationListResult
}

DscpConfigurationClientListAllResult contains the result from method DscpConfigurationClient.ListAll.

type DscpConfigurationClientListOptions added in v0.3.0 

type DscpConfigurationClientListOptions struct {
}

DscpConfigurationClientListOptions contains the optional parameters for the DscpConfigurationClient.List method.

type DscpConfigurationClientListPager added in v0.3.0 

type DscpConfigurationClientListPager struct {
	// contains filtered or unexported fields
}

DscpConfigurationClientListPager provides operations for iterating over paged responses.

func (*DscpConfigurationClientListPager) Err added in v0.3.0 

func (p *DscpConfigurationClientListPager) Err() error

Err returns the last error encountered while paging.

func (*DscpConfigurationClientListPager) NextPage added in v0.3.0 

func (p *DscpConfigurationClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DscpConfigurationClientListPager) PageResponse added in v0.3.0 

func (p *DscpConfigurationClientListPager) PageResponse() DscpConfigurationClientListResponse

PageResponse returns the current DscpConfigurationClientListResponse page.

type DscpConfigurationClientListResponse added in v0.3.0 

type DscpConfigurationClientListResponse struct {
	DscpConfigurationClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DscpConfigurationClientListResponse contains the response from method DscpConfigurationClient.List.

type DscpConfigurationClientListResult added in v0.3.0 

type DscpConfigurationClientListResult struct {
	DscpConfigurationListResult
}

DscpConfigurationClientListResult contains the result from method DscpConfigurationClient.List.

type DscpConfigurationListResult 

type DscpConfigurationListResult struct {
	// A list of dscp configurations in a resource group.
	Value []*DscpConfiguration `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

DscpConfigurationListResult - Response for the DscpConfigurationList API service call.

func (DscpConfigurationListResult) MarshalJSON 

func (d DscpConfigurationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscpConfigurationListResult.

type DscpConfigurationPropertiesFormat 

type DscpConfigurationPropertiesFormat struct {
	// Destination IP ranges.
	DestinationIPRanges []*QosIPRange `json:"destinationIpRanges,omitempty"`

	// Destination port ranges.
	DestinationPortRanges []*QosPortRange `json:"destinationPortRanges,omitempty"`

	// List of markings to be used in the configuration.
	Markings []*int32 `json:"markings,omitempty"`

	// RNM supported protocol types.
	Protocol *ProtocolType `json:"protocol,omitempty"`

	// QoS object definitions
	QosDefinitionCollection []*QosDefinition `json:"qosDefinitionCollection,omitempty"`

	// Source IP ranges.
	SourceIPRanges []*QosIPRange `json:"sourceIpRanges,omitempty"`

	// Sources port ranges.
	SourcePortRanges []*QosPortRange `json:"sourcePortRanges,omitempty"`

	// READ-ONLY; Associated Network Interfaces to the DSCP Configuration.
	AssociatedNetworkInterfaces []*Interface `json:"associatedNetworkInterfaces,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the DSCP Configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Qos Collection ID generated by RNM.
	QosCollectionID *string `json:"qosCollectionId,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the DSCP Configuration resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

DscpConfigurationPropertiesFormat - Differentiated Services Code Point configuration properties.

func (DscpConfigurationPropertiesFormat) MarshalJSON 

func (d DscpConfigurationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DscpConfigurationPropertiesFormat.

type EffectiveNetworkSecurityGroup 

type EffectiveNetworkSecurityGroup struct {
	// Associated resources.
	Association *EffectiveNetworkSecurityGroupAssociation `json:"association,omitempty"`

	// A collection of effective security rules.
	EffectiveSecurityRules []*EffectiveNetworkSecurityRule `json:"effectiveSecurityRules,omitempty"`

	// The ID of network security group that is applied.
	NetworkSecurityGroup *SubResource `json:"networkSecurityGroup,omitempty"`

	// Mapping of tags to list of IP Addresses included within the tag.
	TagMap *string `json:"tagMap,omitempty"`
}

EffectiveNetworkSecurityGroup - Effective network security group.

func (EffectiveNetworkSecurityGroup) MarshalJSON 

func (e EffectiveNetworkSecurityGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveNetworkSecurityGroup.

type EffectiveNetworkSecurityGroupAssociation 

type EffectiveNetworkSecurityGroupAssociation struct {
	// The ID of the network interface if assigned.
	NetworkInterface *SubResource `json:"networkInterface,omitempty"`

	// The ID of the Azure network manager if assigned.
	NetworkManager *SubResource `json:"networkManager,omitempty"`

	// The ID of the subnet if assigned.
	Subnet *SubResource `json:"subnet,omitempty"`
}

EffectiveNetworkSecurityGroupAssociation - The effective network security group association.

type EffectiveNetworkSecurityGroupListResult 

type EffectiveNetworkSecurityGroupListResult struct {
	// A list of effective network security groups.
	Value []*EffectiveNetworkSecurityGroup `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

EffectiveNetworkSecurityGroupListResult - Response for list effective network security groups API service call.

func (EffectiveNetworkSecurityGroupListResult) MarshalJSON 

func (e EffectiveNetworkSecurityGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveNetworkSecurityGroupListResult.

type EffectiveNetworkSecurityRule 

type EffectiveNetworkSecurityRule struct {
	// Whether network traffic is allowed or denied.
	Access *SecurityRuleAccess `json:"access,omitempty"`

	// The destination address prefix.
	DestinationAddressPrefix *string `json:"destinationAddressPrefix,omitempty"`

	// The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer,
	// Internet), System Tags, and the asterisk (*).
	DestinationAddressPrefixes []*string `json:"destinationAddressPrefixes,omitempty"`

	// The destination port or range.
	DestinationPortRange *string `json:"destinationPortRange,omitempty"`

	// The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator
	// (e.g. 100-400), or an asterisk (*).
	DestinationPortRanges []*string `json:"destinationPortRanges,omitempty"`

	// The direction of the rule.
	Direction *SecurityRuleDirection `json:"direction,omitempty"`

	// Expanded destination address prefix.
	ExpandedDestinationAddressPrefix []*string `json:"expandedDestinationAddressPrefix,omitempty"`

	// The expanded source address prefix.
	ExpandedSourceAddressPrefix []*string `json:"expandedSourceAddressPrefix,omitempty"`

	// The name of the security rule specified by the user (if created by the user).
	Name *string `json:"name,omitempty"`

	// The priority of the rule.
	Priority *int32 `json:"priority,omitempty"`

	// The network protocol this rule applies to.
	Protocol *EffectiveSecurityRuleProtocol `json:"protocol,omitempty"`

	// The source address prefix.
	SourceAddressPrefix *string `json:"sourceAddressPrefix,omitempty"`

	// The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet),
	// System Tags, and the asterisk (*).
	SourceAddressPrefixes []*string `json:"sourceAddressPrefixes,omitempty"`

	// The source port or range.
	SourcePortRange *string `json:"sourcePortRange,omitempty"`

	// The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g.
	// 100-400), or an asterisk (*).
	SourcePortRanges []*string `json:"sourcePortRanges,omitempty"`
}

EffectiveNetworkSecurityRule - Effective network security rules.

func (EffectiveNetworkSecurityRule) MarshalJSON 

func (e EffectiveNetworkSecurityRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveNetworkSecurityRule.

type EffectiveRoute 

type EffectiveRoute struct {
	// The address prefixes of the effective routes in CIDR notation.
	AddressPrefix []*string `json:"addressPrefix,omitempty"`

	// If true, on-premises routes are not propagated to the network interfaces in the subnet.
	DisableBgpRoutePropagation *bool `json:"disableBgpRoutePropagation,omitempty"`

	// The name of the user defined route. This is optional.
	Name *string `json:"name,omitempty"`

	// The IP address of the next hop of the effective route.
	NextHopIPAddress []*string `json:"nextHopIpAddress,omitempty"`

	// The type of Azure hop the packet should be sent to.
	NextHopType *RouteNextHopType `json:"nextHopType,omitempty"`

	// Who created the route.
	Source *EffectiveRouteSource `json:"source,omitempty"`

	// The value of effective route.
	State *EffectiveRouteState `json:"state,omitempty"`
}

EffectiveRoute - Effective Route.

func (EffectiveRoute) MarshalJSON 

func (e EffectiveRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveRoute.

type EffectiveRouteListResult 

type EffectiveRouteListResult struct {
	// A list of effective routes.
	Value []*EffectiveRoute `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

EffectiveRouteListResult - Response for list effective route API service call.

func (EffectiveRouteListResult) MarshalJSON 

func (e EffectiveRouteListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveRouteListResult.

type EffectiveRouteSource 

type EffectiveRouteSource string

EffectiveRouteSource - Who created the route. 

const (
	EffectiveRouteSourceDefault               EffectiveRouteSource = "Default"
	EffectiveRouteSourceUnknown               EffectiveRouteSource = "Unknown"
	EffectiveRouteSourceUser                  EffectiveRouteSource = "User"
	EffectiveRouteSourceVirtualNetworkGateway EffectiveRouteSource = "VirtualNetworkGateway"
)

func PossibleEffectiveRouteSourceValues 

func PossibleEffectiveRouteSourceValues() []EffectiveRouteSource

PossibleEffectiveRouteSourceValues returns the possible values for the EffectiveRouteSource const type.

func (EffectiveRouteSource) ToPtr 

func (c EffectiveRouteSource) ToPtr() *EffectiveRouteSource

ToPtr returns a *EffectiveRouteSource pointing to the current value.

type EffectiveRouteState 

type EffectiveRouteState string

EffectiveRouteState - The value of effective route. 

const (
	EffectiveRouteStateActive  EffectiveRouteState = "Active"
	EffectiveRouteStateInvalid EffectiveRouteState = "Invalid"
)

func PossibleEffectiveRouteStateValues 

func PossibleEffectiveRouteStateValues() []EffectiveRouteState

PossibleEffectiveRouteStateValues returns the possible values for the EffectiveRouteState const type.

func (EffectiveRouteState) ToPtr 

func (c EffectiveRouteState) ToPtr() *EffectiveRouteState

ToPtr returns a *EffectiveRouteState pointing to the current value.

type EffectiveRoutesParameters 

type EffectiveRoutesParameters struct {
	// The resource whose effective routes are being requested.
	ResourceID *string `json:"resourceId,omitempty"`

	// The type of the specified resource like RouteTable, ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection
	// and P2SConnection.
	VirtualWanResourceType *string `json:"virtualWanResourceType,omitempty"`
}

EffectiveRoutesParameters - The parameters specifying the resource whose effective routes are being requested.

type EffectiveSecurityRuleProtocol 

type EffectiveSecurityRuleProtocol string

EffectiveSecurityRuleProtocol - The network protocol this rule applies to. 

const (
	EffectiveSecurityRuleProtocolAll EffectiveSecurityRuleProtocol = "All"
	EffectiveSecurityRuleProtocolTCP EffectiveSecurityRuleProtocol = "Tcp"
	EffectiveSecurityRuleProtocolUDP EffectiveSecurityRuleProtocol = "Udp"
)

func PossibleEffectiveSecurityRuleProtocolValues 

func PossibleEffectiveSecurityRuleProtocolValues() []EffectiveSecurityRuleProtocol

PossibleEffectiveSecurityRuleProtocolValues returns the possible values for the EffectiveSecurityRuleProtocol const type.

func (EffectiveSecurityRuleProtocol) ToPtr 

func (c EffectiveSecurityRuleProtocol) ToPtr() *EffectiveSecurityRuleProtocol

ToPtr returns a *EffectiveSecurityRuleProtocol pointing to the current value.

type EndpointServiceResult 

type EndpointServiceResult struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// READ-ONLY; Name of the endpoint service.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Type of the endpoint service.
	Type *string `json:"type,omitempty" azure:"ro"`
}

EndpointServiceResult - Endpoint service.

type EndpointServicesListResult 

type EndpointServicesListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of available endpoint services in a region.
	Value []*EndpointServiceResult `json:"value,omitempty"`
}

EndpointServicesListResult - Response for the ListAvailableEndpointServices API service call.

func (EndpointServicesListResult) MarshalJSON 

func (e EndpointServicesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointServicesListResult.

type EndpointType 

type EndpointType string

EndpointType - The endpoint type. 

const (
	EndpointTypeAzureSubnet         EndpointType = "AzureSubnet"
	EndpointTypeAzureVM             EndpointType = "AzureVM"
	EndpointTypeAzureVNet           EndpointType = "AzureVNet"
	EndpointTypeExternalAddress     EndpointType = "ExternalAddress"
	EndpointTypeMMAWorkspaceMachine EndpointType = "MMAWorkspaceMachine"
	EndpointTypeMMAWorkspaceNetwork EndpointType = "MMAWorkspaceNetwork"
)

func PossibleEndpointTypeValues 

func PossibleEndpointTypeValues() []EndpointType

PossibleEndpointTypeValues returns the possible values for the EndpointType const type.

func (EndpointType) ToPtr 

func (c EndpointType) ToPtr() *EndpointType

ToPtr returns a *EndpointType pointing to the current value.

type Error 

type Error struct {
	// Error code.
	Code *string `json:"code,omitempty"`

	// Error details.
	Details []*ErrorDetails `json:"details,omitempty"`

	// Inner error message.
	InnerError *string `json:"innerError,omitempty"`

	// Error message.
	Message *string `json:"message,omitempty"`

	// Error target.
	Target *string `json:"target,omitempty"`
}

Error - Common error representation.

func (Error) MarshalJSON added in v0.3.0 

func (e Error) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Error.

type ErrorDetails 

type ErrorDetails struct {
	// Error code.
	Code *string `json:"code,omitempty"`

	// Error message.
	Message *string `json:"message,omitempty"`

	// Error target.
	Target *string `json:"target,omitempty"`
}

ErrorDetails - Common error details representation.

type ErrorResponse 

type ErrorResponse struct {
	// The error details object.
	Error *ErrorDetails `json:"error,omitempty"`
}

ErrorResponse - The error object.

type EvaluatedNetworkSecurityGroup 

type EvaluatedNetworkSecurityGroup struct {
	// Resource ID of nic or subnet to which network security group is applied.
	AppliedTo *string `json:"appliedTo,omitempty"`

	// Matched network security rule.
	MatchedRule *MatchedRule `json:"matchedRule,omitempty"`

	// Network security group ID.
	NetworkSecurityGroupID *string `json:"networkSecurityGroupId,omitempty"`

	// READ-ONLY; List of network security rules evaluation results.
	RulesEvaluationResult []*SecurityRulesEvaluationResult `json:"rulesEvaluationResult,omitempty" azure:"ro"`
}

EvaluatedNetworkSecurityGroup - Results of network security group evaluation.

func (EvaluatedNetworkSecurityGroup) MarshalJSON 

func (e EvaluatedNetworkSecurityGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EvaluatedNetworkSecurityGroup.

type EvaluationState 

type EvaluationState string

EvaluationState - Connectivity analysis evaluation state. 

const (
	EvaluationStateCompleted  EvaluationState = "Completed"
	EvaluationStateInProgress EvaluationState = "InProgress"
	EvaluationStateNotStarted EvaluationState = "NotStarted"
)

func PossibleEvaluationStateValues 

func PossibleEvaluationStateValues() []EvaluationState

PossibleEvaluationStateValues returns the possible values for the EvaluationState const type.

func (EvaluationState) ToPtr 

func (c EvaluationState) ToPtr() *EvaluationState

ToPtr returns a *EvaluationState pointing to the current value.

type ExclusionManagedRule added in v0.2.0 

type ExclusionManagedRule struct {
	// REQUIRED; Identifier for the managed rule.
	RuleID *string `json:"ruleId,omitempty"`
}

ExclusionManagedRule - Defines a managed rule to use for exclusion.

type ExclusionManagedRuleGroup added in v0.2.0 

type ExclusionManagedRuleGroup struct {
	// REQUIRED; The managed rule group for exclusion.
	RuleGroupName *string `json:"ruleGroupName,omitempty"`

	// List of rules that will be excluded. If none specified, all rules in the group will be excluded.
	Rules []*ExclusionManagedRule `json:"rules,omitempty"`
}

ExclusionManagedRuleGroup - Defines a managed rule group to use for exclusion.

func (ExclusionManagedRuleGroup) MarshalJSON added in v0.2.0 

func (e ExclusionManagedRuleGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExclusionManagedRuleGroup.

type ExclusionManagedRuleSet added in v0.2.0 

type ExclusionManagedRuleSet struct {
	// REQUIRED; Defines the rule set type to use.
	RuleSetType *string `json:"ruleSetType,omitempty"`

	// REQUIRED; Defines the version of the rule set to use.
	RuleSetVersion *string `json:"ruleSetVersion,omitempty"`

	// Defines the rule groups to apply to the rule set.
	RuleGroups []*ExclusionManagedRuleGroup `json:"ruleGroups,omitempty"`
}

ExclusionManagedRuleSet - Defines a managed rule set for Exclusions.

func (ExclusionManagedRuleSet) MarshalJSON added in v0.2.0 

func (e ExclusionManagedRuleSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExclusionManagedRuleSet.

type ExplicitProxySettings 

type ExplicitProxySettings struct {
	// When set to true, explicit proxy mode is enabled.
	EnableExplicitProxy *bool `json:"enableExplicitProxy,omitempty"`

	// Port number for explicit proxy http protocol, cannot be greater than 64000.
	HTTPPort *int32 `json:"httpPort,omitempty"`

	// Port number for explicit proxy https protocol, cannot be greater than 64000.
	HTTPSPort *int32 `json:"httpsPort,omitempty"`

	// SAS URL for PAC file.
	PacFile *string `json:"pacFile,omitempty"`

	// Port number for firewall to serve PAC file.
	PacFilePort *int32 `json:"pacFilePort,omitempty"`
}

ExplicitProxySettings - Explicit Proxy Settings in Firewall Policy.

type ExpressRouteCircuit 

type ExpressRouteCircuit struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the express route circuit.
	Properties *ExpressRouteCircuitPropertiesFormat `json:"properties,omitempty"`

	// The SKU.
	SKU *ExpressRouteCircuitSKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ExpressRouteCircuit resource.

func (ExpressRouteCircuit) MarshalJSON 

func (e ExpressRouteCircuit) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuit.

type ExpressRouteCircuitArpTable 

type ExpressRouteCircuitArpTable struct {
	// Entry age in minutes.
	Age *int32 `json:"age,omitempty"`

	// The IP address.
	IPAddress *string `json:"ipAddress,omitempty"`

	// Interface address.
	Interface *string `json:"interface,omitempty"`

	// The MAC address.
	MacAddress *string `json:"macAddress,omitempty"`
}

ExpressRouteCircuitArpTable - The ARP table associated with the ExpressRouteCircuit.

type ExpressRouteCircuitAuthorization 

type ExpressRouteCircuitAuthorization struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the express route circuit authorization.
	Properties *AuthorizationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ExpressRouteCircuitAuthorization - Authorization in an ExpressRouteCircuit resource.

type ExpressRouteCircuitAuthorizationsClient 

type ExpressRouteCircuitAuthorizationsClient struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitAuthorizationsClient contains the methods for the ExpressRouteCircuitAuthorizations group. Don't use this type directly, use NewExpressRouteCircuitAuthorizationsClient() instead.

func NewExpressRouteCircuitAuthorizationsClient 

func NewExpressRouteCircuitAuthorizationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRouteCircuitAuthorizationsClient

NewExpressRouteCircuitAuthorizationsClient creates a new instance of ExpressRouteCircuitAuthorizationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRouteCircuitAuthorizationsClient) BeginCreateOrUpdate 

func (client *ExpressRouteCircuitAuthorizationsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, circuitName string, authorizationName string, authorizationParameters ExpressRouteCircuitAuthorization, options *ExpressRouteCircuitAuthorizationsClientBeginCreateOrUpdateOptions) (ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates an authorization in the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. 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. options - ExpressRouteCircuitAuthorizationsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitAuthorizationCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitAuthorizationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<authorization-name>",
		armnetwork.ExpressRouteCircuitAuthorization{
			Properties: &armnetwork.AuthorizationPropertiesFormat{},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResult)
}

Output:

func (*ExpressRouteCircuitAuthorizationsClient) BeginDelete 

func (client *ExpressRouteCircuitAuthorizationsClient) BeginDelete(ctx context.Context, resourceGroupName string, circuitName string, authorizationName string, options *ExpressRouteCircuitAuthorizationsClientBeginDeleteOptions) (ExpressRouteCircuitAuthorizationsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified authorization from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. authorizationName - The name of the authorization. options - ExpressRouteCircuitAuthorizationsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitAuthorizationDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitAuthorizationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<authorization-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ExpressRouteCircuitAuthorizationsClient) Get 

func (client *ExpressRouteCircuitAuthorizationsClient) Get(ctx context.Context, resourceGroupName string, circuitName string, authorizationName string, options *ExpressRouteCircuitAuthorizationsClientGetOptions) (ExpressRouteCircuitAuthorizationsClientGetResponse, error)

Get - Gets the specified authorization from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. authorizationName - The name of the authorization. options - ExpressRouteCircuitAuthorizationsClientGetOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitAuthorizationGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitAuthorizationsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<authorization-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitAuthorizationsClientGetResult)
}

Output:

func (*ExpressRouteCircuitAuthorizationsClient) List 

func (client *ExpressRouteCircuitAuthorizationsClient) List(resourceGroupName string, circuitName string, options *ExpressRouteCircuitAuthorizationsClientListOptions) *ExpressRouteCircuitAuthorizationsClientListPager

List - Gets all authorizations in an express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the circuit. options - ExpressRouteCircuitAuthorizationsClientListOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitAuthorizationList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitAuthorizationsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<circuit-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ExpressRouteCircuitAuthorizationsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientBeginCreateOrUpdateOptions struct {
}

ExpressRouteCircuitAuthorizationsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.BeginCreateOrUpdate method.

type ExpressRouteCircuitAuthorizationsClientBeginDeleteOptions added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientBeginDeleteOptions struct {
}

ExpressRouteCircuitAuthorizationsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.BeginDelete method.

type ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResponse will be returned.

func (*ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePollerResponse contains the response from method ExpressRouteCircuitAuthorizationsClient.CreateOrUpdate.

func (ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitAuthorizationsClient, token string) error

Resume rehydrates a ExpressRouteCircuitAuthorizationsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResponse added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResponse struct {
	ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResponse contains the response from method ExpressRouteCircuitAuthorizationsClient.CreateOrUpdate.

type ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResult added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResult struct {
	ExpressRouteCircuitAuthorization
}

ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResult contains the result from method ExpressRouteCircuitAuthorizationsClient.CreateOrUpdate.

type ExpressRouteCircuitAuthorizationsClientDeletePoller added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitAuthorizationsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitAuthorizationsClientDeletePoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitAuthorizationsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientDeletePoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitAuthorizationsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitAuthorizationsClientDeleteResponse will be returned.

func (*ExpressRouteCircuitAuthorizationsClientDeletePoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitAuthorizationsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitAuthorizationsClientDeletePollerResponse added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitAuthorizationsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitAuthorizationsClientDeletePollerResponse contains the response from method ExpressRouteCircuitAuthorizationsClient.Delete.

func (ExpressRouteCircuitAuthorizationsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitAuthorizationsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitAuthorizationsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitAuthorizationsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitAuthorizationsClientDeletePollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitAuthorizationsClient, token string) error

Resume rehydrates a ExpressRouteCircuitAuthorizationsClientDeletePollerResponse from the provided client and resume token.

type ExpressRouteCircuitAuthorizationsClientDeleteResponse added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitAuthorizationsClientDeleteResponse contains the response from method ExpressRouteCircuitAuthorizationsClient.Delete.

type ExpressRouteCircuitAuthorizationsClientGetOptions added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientGetOptions struct {
}

ExpressRouteCircuitAuthorizationsClientGetOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.Get method.

type ExpressRouteCircuitAuthorizationsClientGetResponse added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientGetResponse struct {
	ExpressRouteCircuitAuthorizationsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitAuthorizationsClientGetResponse contains the response from method ExpressRouteCircuitAuthorizationsClient.Get.

type ExpressRouteCircuitAuthorizationsClientGetResult added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientGetResult struct {
	ExpressRouteCircuitAuthorization
}

ExpressRouteCircuitAuthorizationsClientGetResult contains the result from method ExpressRouteCircuitAuthorizationsClient.Get.

type ExpressRouteCircuitAuthorizationsClientListOptions added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientListOptions struct {
}

ExpressRouteCircuitAuthorizationsClientListOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.List method.

type ExpressRouteCircuitAuthorizationsClientListPager added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientListPager struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitAuthorizationsClientListPager provides operations for iterating over paged responses.

func (*ExpressRouteCircuitAuthorizationsClientListPager) Err added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRouteCircuitAuthorizationsClientListPager) NextPage added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRouteCircuitAuthorizationsClientListPager) PageResponse added in v0.3.0 

func (p *ExpressRouteCircuitAuthorizationsClientListPager) PageResponse() ExpressRouteCircuitAuthorizationsClientListResponse

PageResponse returns the current ExpressRouteCircuitAuthorizationsClientListResponse page.

type ExpressRouteCircuitAuthorizationsClientListResponse added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientListResponse struct {
	ExpressRouteCircuitAuthorizationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitAuthorizationsClientListResponse contains the response from method ExpressRouteCircuitAuthorizationsClient.List.

type ExpressRouteCircuitAuthorizationsClientListResult added in v0.3.0 

type ExpressRouteCircuitAuthorizationsClientListResult struct {
	AuthorizationListResult
}

ExpressRouteCircuitAuthorizationsClientListResult contains the result from method ExpressRouteCircuitAuthorizationsClient.List.

type ExpressRouteCircuitConnection 

type ExpressRouteCircuitConnection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the express route circuit connection.
	Properties *ExpressRouteCircuitConnectionPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ExpressRouteCircuitConnection - Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.

type ExpressRouteCircuitConnectionListResult 

type ExpressRouteCircuitConnectionListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The global reach connection associated with Private Peering in an ExpressRoute Circuit.
	Value []*ExpressRouteCircuitConnection `json:"value,omitempty"`
}

ExpressRouteCircuitConnectionListResult - Response for ListConnections API service call retrieves all global reach connections that belongs to a Private Peering for an ExpressRouteCircuit.

func (ExpressRouteCircuitConnectionListResult) MarshalJSON 

func (e ExpressRouteCircuitConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitConnectionListResult.

type ExpressRouteCircuitConnectionPropertiesFormat 

type ExpressRouteCircuitConnectionPropertiesFormat struct {
	// /29 IP address space to carve out Customer addresses for tunnels.
	AddressPrefix *string `json:"addressPrefix,omitempty"`

	// The authorization key.
	AuthorizationKey *string `json:"authorizationKey,omitempty"`

	// Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
	ExpressRouteCircuitPeering *SubResource `json:"expressRouteCircuitPeering,omitempty"`

	// IPv6 Address PrefixProperties of the express route circuit connection.
	IPv6CircuitConnectionConfig *IPv6CircuitConnectionConfig `json:"ipv6CircuitConnectionConfig,omitempty"`

	// Reference to Express Route Circuit Private Peering Resource of the peered circuit.
	PeerExpressRouteCircuitPeering *SubResource `json:"peerExpressRouteCircuitPeering,omitempty"`

	// READ-ONLY; Express Route Circuit connection state.
	CircuitConnectionStatus *CircuitConnectionStatus `json:"circuitConnectionStatus,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the express route circuit connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ExpressRouteCircuitConnectionPropertiesFormat - Properties of the express route circuit connection.

type ExpressRouteCircuitConnectionsClient 

type ExpressRouteCircuitConnectionsClient struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitConnectionsClient contains the methods for the ExpressRouteCircuitConnections group. Don't use this type directly, use NewExpressRouteCircuitConnectionsClient() instead.

func NewExpressRouteCircuitConnectionsClient 

func NewExpressRouteCircuitConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRouteCircuitConnectionsClient

NewExpressRouteCircuitConnectionsClient creates a new instance of ExpressRouteCircuitConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRouteCircuitConnectionsClient) BeginCreateOrUpdate 

func (client *ExpressRouteCircuitConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, connectionName string, expressRouteCircuitConnectionParameters ExpressRouteCircuitConnection, options *ExpressRouteCircuitConnectionsClientBeginCreateOrUpdateOptions) (ExpressRouteCircuitConnectionsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a Express Route Circuit Connection in the specified express route circuits. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. peeringName - The name of the peering. connectionName - The name of the express route circuit connection. expressRouteCircuitConnectionParameters - Parameters supplied to the create or update express route circuit connection operation. options - ExpressRouteCircuitConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitConnectionCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		"<connection-name>",
		armnetwork.ExpressRouteCircuitConnection{
			Properties: &armnetwork.ExpressRouteCircuitConnectionPropertiesFormat{
				AddressPrefix:    to.StringPtr("<address-prefix>"),
				AuthorizationKey: to.StringPtr("<authorization-key>"),
				ExpressRouteCircuitPeering: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
				IPv6CircuitConnectionConfig: &armnetwork.IPv6CircuitConnectionConfig{
					AddressPrefix: to.StringPtr("<address-prefix>"),
				},
				PeerExpressRouteCircuitPeering: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitConnectionsClientCreateOrUpdateResult)
}

Output:

func (*ExpressRouteCircuitConnectionsClient) BeginDelete 

func (client *ExpressRouteCircuitConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, connectionName string, options *ExpressRouteCircuitConnectionsClientBeginDeleteOptions) (ExpressRouteCircuitConnectionsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified Express Route Circuit Connection from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. peeringName - The name of the peering. connectionName - The name of the express route circuit connection. options - ExpressRouteCircuitConnectionsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitConnectionDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ExpressRouteCircuitConnectionsClient) Get 

func (client *ExpressRouteCircuitConnectionsClient) Get(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, connectionName string, options *ExpressRouteCircuitConnectionsClientGetOptions) (ExpressRouteCircuitConnectionsClientGetResponse, error)

Get - Gets the specified Express Route Circuit Connection from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. peeringName - The name of the peering. connectionName - The name of the express route circuit connection. options - ExpressRouteCircuitConnectionsClientGetOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitConnectionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitConnectionsClientGetResult)
}

Output:

func (*ExpressRouteCircuitConnectionsClient) List 

func (client *ExpressRouteCircuitConnectionsClient) List(resourceGroupName string, circuitName string, peeringName string, options *ExpressRouteCircuitConnectionsClientListOptions) *ExpressRouteCircuitConnectionsClientListPager

List - Gets all global reach connections associated with a private peering in an express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the circuit. peeringName - The name of the peering. options - ExpressRouteCircuitConnectionsClientListOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitConnectionList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitConnectionsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ExpressRouteCircuitConnectionsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ExpressRouteCircuitConnectionsClientBeginCreateOrUpdateOptions struct {
}

ExpressRouteCircuitConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.BeginCreateOrUpdate method.

type ExpressRouteCircuitConnectionsClientBeginDeleteOptions added in v0.3.0 

type ExpressRouteCircuitConnectionsClientBeginDeleteOptions struct {
}

ExpressRouteCircuitConnectionsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.BeginDelete method.

type ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller added in v0.3.0 

type ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitConnectionsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitConnectionsClientCreateOrUpdateResponse will be returned.

func (*ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitConnectionsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ExpressRouteCircuitConnectionsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitConnectionsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitConnectionsClientCreateOrUpdatePollerResponse contains the response from method ExpressRouteCircuitConnectionsClient.CreateOrUpdate.

func (ExpressRouteCircuitConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitConnectionsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitConnectionsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitConnectionsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitConnectionsClient, token string) error

Resume rehydrates a ExpressRouteCircuitConnectionsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ExpressRouteCircuitConnectionsClientCreateOrUpdateResponse added in v0.3.0 

type ExpressRouteCircuitConnectionsClientCreateOrUpdateResponse struct {
	ExpressRouteCircuitConnectionsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitConnectionsClientCreateOrUpdateResponse contains the response from method ExpressRouteCircuitConnectionsClient.CreateOrUpdate.

type ExpressRouteCircuitConnectionsClientCreateOrUpdateResult added in v0.3.0 

type ExpressRouteCircuitConnectionsClientCreateOrUpdateResult struct {
	ExpressRouteCircuitConnection
}

ExpressRouteCircuitConnectionsClientCreateOrUpdateResult contains the result from method ExpressRouteCircuitConnectionsClient.CreateOrUpdate.

type ExpressRouteCircuitConnectionsClientDeletePoller added in v0.3.0 

type ExpressRouteCircuitConnectionsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitConnectionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitConnectionsClientDeletePoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitConnectionsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitConnectionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitConnectionsClientDeleteResponse will be returned.

func (*ExpressRouteCircuitConnectionsClientDeletePoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitConnectionsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitConnectionsClientDeletePollerResponse added in v0.3.0 

type ExpressRouteCircuitConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitConnectionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitConnectionsClientDeletePollerResponse contains the response from method ExpressRouteCircuitConnectionsClient.Delete.

func (ExpressRouteCircuitConnectionsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitConnectionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitConnectionsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitConnectionsClientDeletePollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitConnectionsClient, token string) error

Resume rehydrates a ExpressRouteCircuitConnectionsClientDeletePollerResponse from the provided client and resume token.

type ExpressRouteCircuitConnectionsClientDeleteResponse added in v0.3.0 

type ExpressRouteCircuitConnectionsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitConnectionsClientDeleteResponse contains the response from method ExpressRouteCircuitConnectionsClient.Delete.

type ExpressRouteCircuitConnectionsClientGetOptions added in v0.3.0 

type ExpressRouteCircuitConnectionsClientGetOptions struct {
}

ExpressRouteCircuitConnectionsClientGetOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.Get method.

type ExpressRouteCircuitConnectionsClientGetResponse added in v0.3.0 

type ExpressRouteCircuitConnectionsClientGetResponse struct {
	ExpressRouteCircuitConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitConnectionsClientGetResponse contains the response from method ExpressRouteCircuitConnectionsClient.Get.

type ExpressRouteCircuitConnectionsClientGetResult added in v0.3.0 

type ExpressRouteCircuitConnectionsClientGetResult struct {
	ExpressRouteCircuitConnection
}

ExpressRouteCircuitConnectionsClientGetResult contains the result from method ExpressRouteCircuitConnectionsClient.Get.

type ExpressRouteCircuitConnectionsClientListOptions added in v0.3.0 

type ExpressRouteCircuitConnectionsClientListOptions struct {
}

ExpressRouteCircuitConnectionsClientListOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.List method.

type ExpressRouteCircuitConnectionsClientListPager added in v0.3.0 

type ExpressRouteCircuitConnectionsClientListPager struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitConnectionsClientListPager provides operations for iterating over paged responses.

func (*ExpressRouteCircuitConnectionsClientListPager) Err added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRouteCircuitConnectionsClientListPager) NextPage added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRouteCircuitConnectionsClientListPager) PageResponse added in v0.3.0 

func (p *ExpressRouteCircuitConnectionsClientListPager) PageResponse() ExpressRouteCircuitConnectionsClientListResponse

PageResponse returns the current ExpressRouteCircuitConnectionsClientListResponse page.

type ExpressRouteCircuitConnectionsClientListResponse added in v0.3.0 

type ExpressRouteCircuitConnectionsClientListResponse struct {
	ExpressRouteCircuitConnectionsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitConnectionsClientListResponse contains the response from method ExpressRouteCircuitConnectionsClient.List.

type ExpressRouteCircuitConnectionsClientListResult added in v0.3.0 

type ExpressRouteCircuitConnectionsClientListResult struct {
	ExpressRouteCircuitConnectionListResult
}

ExpressRouteCircuitConnectionsClientListResult contains the result from method ExpressRouteCircuitConnectionsClient.List.

type ExpressRouteCircuitListResult 

type ExpressRouteCircuitListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of ExpressRouteCircuits in a resource group.
	Value []*ExpressRouteCircuit `json:"value,omitempty"`
}

ExpressRouteCircuitListResult - Response for ListExpressRouteCircuit API service call.

func (ExpressRouteCircuitListResult) MarshalJSON 

func (e ExpressRouteCircuitListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitListResult.

type ExpressRouteCircuitPeering 

type ExpressRouteCircuitPeering struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the express route circuit peering.
	Properties *ExpressRouteCircuitPeeringPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ExpressRouteCircuitPeering - Peering in an ExpressRouteCircuit resource.

type ExpressRouteCircuitPeeringAdvertisedPublicPrefixState 

type ExpressRouteCircuitPeeringAdvertisedPublicPrefixState string

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState - The advertised public prefix state of the Peering resource. 

const (
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateConfigured       ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "Configured"
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateConfiguring      ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "Configuring"
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateNotConfigured    ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "NotConfigured"
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValidationNeeded ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "ValidationNeeded"
)

func PossibleExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValues 

func PossibleExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValues() []ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

PossibleExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValues returns the possible values for the ExpressRouteCircuitPeeringAdvertisedPublicPrefixState const type.

func (ExpressRouteCircuitPeeringAdvertisedPublicPrefixState) ToPtr 

func (c ExpressRouteCircuitPeeringAdvertisedPublicPrefixState) ToPtr() *ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

ToPtr returns a *ExpressRouteCircuitPeeringAdvertisedPublicPrefixState pointing to the current value.

type ExpressRouteCircuitPeeringConfig 

type ExpressRouteCircuitPeeringConfig struct {
	// The communities of bgp peering. Specified for microsoft peering.
	AdvertisedCommunities []*string `json:"advertisedCommunities,omitempty"`

	// The reference to AdvertisedPublicPrefixes.
	AdvertisedPublicPrefixes []*string `json:"advertisedPublicPrefixes,omitempty"`

	// The CustomerASN of the peering.
	CustomerASN *int32 `json:"customerASN,omitempty"`

	// The legacy mode of the peering.
	LegacyMode *int32 `json:"legacyMode,omitempty"`

	// The RoutingRegistryName of the configuration.
	RoutingRegistryName *string `json:"routingRegistryName,omitempty"`

	// READ-ONLY; The advertised public prefix state of the Peering resource.
	AdvertisedPublicPrefixesState *ExpressRouteCircuitPeeringAdvertisedPublicPrefixState `json:"advertisedPublicPrefixesState,omitempty" azure:"ro"`
}

ExpressRouteCircuitPeeringConfig - Specifies the peering configuration.

func (ExpressRouteCircuitPeeringConfig) MarshalJSON 

func (e ExpressRouteCircuitPeeringConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitPeeringConfig.

type ExpressRouteCircuitPeeringID 

type ExpressRouteCircuitPeeringID struct {
	// The ID of the ExpressRoute circuit peering.
	ID *string `json:"id,omitempty"`
}

ExpressRouteCircuitPeeringID - ExpressRoute circuit peering identifier.

type ExpressRouteCircuitPeeringListResult 

type ExpressRouteCircuitPeeringListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The peerings in an express route circuit.
	Value []*ExpressRouteCircuitPeering `json:"value,omitempty"`
}

ExpressRouteCircuitPeeringListResult - Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCircuit.

func (ExpressRouteCircuitPeeringListResult) MarshalJSON 

func (e ExpressRouteCircuitPeeringListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitPeeringListResult.

type ExpressRouteCircuitPeeringPropertiesFormat 

type ExpressRouteCircuitPeeringPropertiesFormat struct {
	// The Azure ASN.
	AzureASN *int32 `json:"azureASN,omitempty"`

	// The list of circuit connections associated with Azure Private Peering for this circuit.
	Connections []*ExpressRouteCircuitConnection `json:"connections,omitempty"`

	// The ExpressRoute connection.
	ExpressRouteConnection *ExpressRouteConnectionID `json:"expressRouteConnection,omitempty"`

	// The GatewayManager Etag.
	GatewayManagerEtag *string `json:"gatewayManagerEtag,omitempty"`

	// The IPv6 peering configuration.
	IPv6PeeringConfig *IPv6ExpressRouteCircuitPeeringConfig `json:"ipv6PeeringConfig,omitempty"`

	// The Microsoft peering configuration.
	MicrosoftPeeringConfig *ExpressRouteCircuitPeeringConfig `json:"microsoftPeeringConfig,omitempty"`

	// The peer ASN.
	PeerASN *int64 `json:"peerASN,omitempty"`

	// The peering type.
	PeeringType *ExpressRoutePeeringType `json:"peeringType,omitempty"`

	// The primary port.
	PrimaryAzurePort *string `json:"primaryAzurePort,omitempty"`

	// The primary address prefix.
	PrimaryPeerAddressPrefix *string `json:"primaryPeerAddressPrefix,omitempty"`

	// The reference to the RouteFilter resource.
	RouteFilter *SubResource `json:"routeFilter,omitempty"`

	// The secondary port.
	SecondaryAzurePort *string `json:"secondaryAzurePort,omitempty"`

	// The secondary address prefix.
	SecondaryPeerAddressPrefix *string `json:"secondaryPeerAddressPrefix,omitempty"`

	// The shared key.
	SharedKey *string `json:"sharedKey,omitempty"`

	// The peering state.
	State *ExpressRoutePeeringState `json:"state,omitempty"`

	// The peering stats of express route circuit.
	Stats *ExpressRouteCircuitStats `json:"stats,omitempty"`

	// The VLAN ID.
	VlanID *int32 `json:"vlanId,omitempty"`

	// READ-ONLY; Who was the last to modify the peering.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty" azure:"ro"`

	// READ-ONLY; The list of peered circuit connections associated with Azure Private Peering for this circuit.
	PeeredConnections []*PeerExpressRouteCircuitConnection `json:"peeredConnections,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the express route circuit peering resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ExpressRouteCircuitPeeringPropertiesFormat - Properties of the express route circuit peering.

func (ExpressRouteCircuitPeeringPropertiesFormat) MarshalJSON 

func (e ExpressRouteCircuitPeeringPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitPeeringPropertiesFormat.

type ExpressRouteCircuitPeeringState 

type ExpressRouteCircuitPeeringState string

ExpressRouteCircuitPeeringState - The state of peering. 

const (
	ExpressRouteCircuitPeeringStateDisabled ExpressRouteCircuitPeeringState = "Disabled"
	ExpressRouteCircuitPeeringStateEnabled  ExpressRouteCircuitPeeringState = "Enabled"
)

func PossibleExpressRouteCircuitPeeringStateValues 

func PossibleExpressRouteCircuitPeeringStateValues() []ExpressRouteCircuitPeeringState

PossibleExpressRouteCircuitPeeringStateValues returns the possible values for the ExpressRouteCircuitPeeringState const type.

func (ExpressRouteCircuitPeeringState) ToPtr 

func (c ExpressRouteCircuitPeeringState) ToPtr() *ExpressRouteCircuitPeeringState

ToPtr returns a *ExpressRouteCircuitPeeringState pointing to the current value.

type ExpressRouteCircuitPeeringsClient 

type ExpressRouteCircuitPeeringsClient struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitPeeringsClient contains the methods for the ExpressRouteCircuitPeerings group. Don't use this type directly, use NewExpressRouteCircuitPeeringsClient() instead.

func NewExpressRouteCircuitPeeringsClient 

func NewExpressRouteCircuitPeeringsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRouteCircuitPeeringsClient

NewExpressRouteCircuitPeeringsClient creates a new instance of ExpressRouteCircuitPeeringsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRouteCircuitPeeringsClient) BeginCreateOrUpdate 

func (client *ExpressRouteCircuitPeeringsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, peeringParameters ExpressRouteCircuitPeering, options *ExpressRouteCircuitPeeringsClientBeginCreateOrUpdateOptions) (ExpressRouteCircuitPeeringsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a peering in the specified express route circuits. If the operation fails it returns an *azcore.ResponseError type. 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. options - ExpressRouteCircuitPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitPeeringCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitPeeringsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		armnetwork.ExpressRouteCircuitPeering{
			Properties: &armnetwork.ExpressRouteCircuitPeeringPropertiesFormat{
				PeerASN:                    to.Int64Ptr(200),
				PrimaryPeerAddressPrefix:   to.StringPtr("<primary-peer-address-prefix>"),
				SecondaryPeerAddressPrefix: to.StringPtr("<secondary-peer-address-prefix>"),
				VlanID:                     to.Int32Ptr(200),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitPeeringsClientCreateOrUpdateResult)
}

Output:

func (*ExpressRouteCircuitPeeringsClient) BeginDelete 

func (client *ExpressRouteCircuitPeeringsClient) BeginDelete(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, options *ExpressRouteCircuitPeeringsClientBeginDeleteOptions) (ExpressRouteCircuitPeeringsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified peering from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. peeringName - The name of the peering. options - ExpressRouteCircuitPeeringsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitPeeringDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitPeeringsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ExpressRouteCircuitPeeringsClient) Get 

func (client *ExpressRouteCircuitPeeringsClient) Get(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, options *ExpressRouteCircuitPeeringsClientGetOptions) (ExpressRouteCircuitPeeringsClientGetResponse, error)

Get - Gets the specified peering for the express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. peeringName - The name of the peering. options - ExpressRouteCircuitPeeringsClientGetOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitPeeringGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitPeeringsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitPeeringsClientGetResult)
}

Output:

func (*ExpressRouteCircuitPeeringsClient) List 

func (client *ExpressRouteCircuitPeeringsClient) List(resourceGroupName string, circuitName string, options *ExpressRouteCircuitPeeringsClientListOptions) *ExpressRouteCircuitPeeringsClientListPager

List - Gets all peerings in a specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. options - ExpressRouteCircuitPeeringsClientListOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitPeeringList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitPeeringsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<circuit-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ExpressRouteCircuitPeeringsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ExpressRouteCircuitPeeringsClientBeginCreateOrUpdateOptions struct {
}

ExpressRouteCircuitPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.BeginCreateOrUpdate method.

type ExpressRouteCircuitPeeringsClientBeginDeleteOptions added in v0.3.0 

type ExpressRouteCircuitPeeringsClientBeginDeleteOptions struct {
}

ExpressRouteCircuitPeeringsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.BeginDelete method.

type ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller added in v0.3.0 

type ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitPeeringsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitPeeringsClientCreateOrUpdateResponse will be returned.

func (*ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitPeeringsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ExpressRouteCircuitPeeringsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitPeeringsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitPeeringsClientCreateOrUpdatePollerResponse contains the response from method ExpressRouteCircuitPeeringsClient.CreateOrUpdate.

func (ExpressRouteCircuitPeeringsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitPeeringsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitPeeringsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitPeeringsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitPeeringsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitPeeringsClient, token string) error

Resume rehydrates a ExpressRouteCircuitPeeringsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ExpressRouteCircuitPeeringsClientCreateOrUpdateResponse added in v0.3.0 

type ExpressRouteCircuitPeeringsClientCreateOrUpdateResponse struct {
	ExpressRouteCircuitPeeringsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitPeeringsClientCreateOrUpdateResponse contains the response from method ExpressRouteCircuitPeeringsClient.CreateOrUpdate.

type ExpressRouteCircuitPeeringsClientCreateOrUpdateResult added in v0.3.0 

type ExpressRouteCircuitPeeringsClientCreateOrUpdateResult struct {
	ExpressRouteCircuitPeering
}

ExpressRouteCircuitPeeringsClientCreateOrUpdateResult contains the result from method ExpressRouteCircuitPeeringsClient.CreateOrUpdate.

type ExpressRouteCircuitPeeringsClientDeletePoller added in v0.3.0 

type ExpressRouteCircuitPeeringsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitPeeringsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitPeeringsClientDeletePoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitPeeringsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientDeletePoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitPeeringsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitPeeringsClientDeleteResponse will be returned.

func (*ExpressRouteCircuitPeeringsClientDeletePoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitPeeringsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitPeeringsClientDeletePollerResponse added in v0.3.0 

type ExpressRouteCircuitPeeringsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitPeeringsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitPeeringsClientDeletePollerResponse contains the response from method ExpressRouteCircuitPeeringsClient.Delete.

func (ExpressRouteCircuitPeeringsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitPeeringsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitPeeringsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitPeeringsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitPeeringsClientDeletePollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitPeeringsClient, token string) error

Resume rehydrates a ExpressRouteCircuitPeeringsClientDeletePollerResponse from the provided client and resume token.

type ExpressRouteCircuitPeeringsClientDeleteResponse added in v0.3.0 

type ExpressRouteCircuitPeeringsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitPeeringsClientDeleteResponse contains the response from method ExpressRouteCircuitPeeringsClient.Delete.

type ExpressRouteCircuitPeeringsClientGetOptions added in v0.3.0 

type ExpressRouteCircuitPeeringsClientGetOptions struct {
}

ExpressRouteCircuitPeeringsClientGetOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.Get method.

type ExpressRouteCircuitPeeringsClientGetResponse added in v0.3.0 

type ExpressRouteCircuitPeeringsClientGetResponse struct {
	ExpressRouteCircuitPeeringsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitPeeringsClientGetResponse contains the response from method ExpressRouteCircuitPeeringsClient.Get.

type ExpressRouteCircuitPeeringsClientGetResult added in v0.3.0 

type ExpressRouteCircuitPeeringsClientGetResult struct {
	ExpressRouteCircuitPeering
}

ExpressRouteCircuitPeeringsClientGetResult contains the result from method ExpressRouteCircuitPeeringsClient.Get.

type ExpressRouteCircuitPeeringsClientListOptions added in v0.3.0 

type ExpressRouteCircuitPeeringsClientListOptions struct {
}

ExpressRouteCircuitPeeringsClientListOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.List method.

type ExpressRouteCircuitPeeringsClientListPager added in v0.3.0 

type ExpressRouteCircuitPeeringsClientListPager struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitPeeringsClientListPager provides operations for iterating over paged responses.

func (*ExpressRouteCircuitPeeringsClientListPager) Err added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRouteCircuitPeeringsClientListPager) NextPage added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRouteCircuitPeeringsClientListPager) PageResponse added in v0.3.0 

func (p *ExpressRouteCircuitPeeringsClientListPager) PageResponse() ExpressRouteCircuitPeeringsClientListResponse

PageResponse returns the current ExpressRouteCircuitPeeringsClientListResponse page.

type ExpressRouteCircuitPeeringsClientListResponse added in v0.3.0 

type ExpressRouteCircuitPeeringsClientListResponse struct {
	ExpressRouteCircuitPeeringsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitPeeringsClientListResponse contains the response from method ExpressRouteCircuitPeeringsClient.List.

type ExpressRouteCircuitPeeringsClientListResult added in v0.3.0 

type ExpressRouteCircuitPeeringsClientListResult struct {
	ExpressRouteCircuitPeeringListResult
}

ExpressRouteCircuitPeeringsClientListResult contains the result from method ExpressRouteCircuitPeeringsClient.List.

type ExpressRouteCircuitPropertiesFormat 

type ExpressRouteCircuitPropertiesFormat struct {
	// Allow classic operations.
	AllowClassicOperations *bool `json:"allowClassicOperations,omitempty"`

	// The list of authorizations.
	Authorizations []*ExpressRouteCircuitAuthorization `json:"authorizations,omitempty"`

	// The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
	BandwidthInGbps *float32 `json:"bandwidthInGbps,omitempty"`

	// The CircuitProvisioningState state of the resource.
	CircuitProvisioningState *string `json:"circuitProvisioningState,omitempty"`

	// The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
	ExpressRoutePort *SubResource `json:"expressRoutePort,omitempty"`

	// The GatewayManager Etag.
	GatewayManagerEtag *string `json:"gatewayManagerEtag,omitempty"`

	// Flag denoting global reach status.
	GlobalReachEnabled *bool `json:"globalReachEnabled,omitempty"`

	// The list of peerings.
	Peerings []*ExpressRouteCircuitPeering `json:"peerings,omitempty"`

	// The ServiceKey.
	ServiceKey *string `json:"serviceKey,omitempty"`

	// The ServiceProviderNotes.
	ServiceProviderNotes *string `json:"serviceProviderNotes,omitempty"`

	// The ServiceProviderProperties.
	ServiceProviderProperties *ExpressRouteCircuitServiceProviderProperties `json:"serviceProviderProperties,omitempty"`

	// The ServiceProviderProvisioningState state of the resource.
	ServiceProviderProvisioningState *ServiceProviderProvisioningState `json:"serviceProviderProvisioningState,omitempty"`

	// READ-ONLY; The provisioning state of the express route circuit resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
	Stag *int32 `json:"stag,omitempty" azure:"ro"`
}

ExpressRouteCircuitPropertiesFormat - Properties of ExpressRouteCircuit.

func (ExpressRouteCircuitPropertiesFormat) MarshalJSON 

func (e ExpressRouteCircuitPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitPropertiesFormat.

type ExpressRouteCircuitReference 

type ExpressRouteCircuitReference struct {
	// Corresponding Express Route Circuit Id.
	ID *string `json:"id,omitempty"`
}

ExpressRouteCircuitReference - Reference to an express route circuit.

type ExpressRouteCircuitRoutesTable 

type ExpressRouteCircuitRoutesTable struct {
	// Local preference value as set with the set local-preference route-map configuration command.
	LocPrf *string `json:"locPrf,omitempty"`

	// IP address of a network entity.
	Network *string `json:"network,omitempty"`

	// NextHop address.
	NextHop *string `json:"nextHop,omitempty"`

	// Autonomous system paths to the destination network.
	Path *string `json:"path,omitempty"`

	// Route Weight.
	Weight *int32 `json:"weight,omitempty"`
}

ExpressRouteCircuitRoutesTable - The routes table associated with the ExpressRouteCircuit.

type ExpressRouteCircuitRoutesTableSummary 

type ExpressRouteCircuitRoutesTableSummary struct {
	// Autonomous system number.
	As *int32 `json:"as,omitempty"`

	// IP address of the neighbor.
	Neighbor *string `json:"neighbor,omitempty"`

	// Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group.
	StatePfxRcd *string `json:"statePfxRcd,omitempty"`

	// The length of time that the BGP session has been in the Established state, or the current status if not in the Established
	// state.
	UpDown *string `json:"upDown,omitempty"`

	// BGP version number spoken to the neighbor.
	V *int32 `json:"v,omitempty"`
}

ExpressRouteCircuitRoutesTableSummary - The routes table associated with the ExpressRouteCircuit.

type ExpressRouteCircuitSKU 

type ExpressRouteCircuitSKU struct {
	// The family of the SKU.
	Family *ExpressRouteCircuitSKUFamily `json:"family,omitempty"`

	// The name of the SKU.
	Name *string `json:"name,omitempty"`

	// The tier of the SKU.
	Tier *ExpressRouteCircuitSKUTier `json:"tier,omitempty"`
}

ExpressRouteCircuitSKU - Contains SKU in an ExpressRouteCircuit.

type ExpressRouteCircuitSKUFamily 

type ExpressRouteCircuitSKUFamily string

ExpressRouteCircuitSKUFamily - The family of the SKU. 

const (
	ExpressRouteCircuitSKUFamilyMeteredData   ExpressRouteCircuitSKUFamily = "MeteredData"
	ExpressRouteCircuitSKUFamilyUnlimitedData ExpressRouteCircuitSKUFamily = "UnlimitedData"
)

func PossibleExpressRouteCircuitSKUFamilyValues 

func PossibleExpressRouteCircuitSKUFamilyValues() []ExpressRouteCircuitSKUFamily

PossibleExpressRouteCircuitSKUFamilyValues returns the possible values for the ExpressRouteCircuitSKUFamily const type.

func (ExpressRouteCircuitSKUFamily) ToPtr 

func (c ExpressRouteCircuitSKUFamily) ToPtr() *ExpressRouteCircuitSKUFamily

ToPtr returns a *ExpressRouteCircuitSKUFamily pointing to the current value.

type ExpressRouteCircuitSKUTier 

type ExpressRouteCircuitSKUTier string

ExpressRouteCircuitSKUTier - The tier of the SKU. 

const (
	ExpressRouteCircuitSKUTierBasic    ExpressRouteCircuitSKUTier = "Basic"
	ExpressRouteCircuitSKUTierLocal    ExpressRouteCircuitSKUTier = "Local"
	ExpressRouteCircuitSKUTierPremium  ExpressRouteCircuitSKUTier = "Premium"
	ExpressRouteCircuitSKUTierStandard ExpressRouteCircuitSKUTier = "Standard"
)

func PossibleExpressRouteCircuitSKUTierValues 

func PossibleExpressRouteCircuitSKUTierValues() []ExpressRouteCircuitSKUTier

PossibleExpressRouteCircuitSKUTierValues returns the possible values for the ExpressRouteCircuitSKUTier const type.

func (ExpressRouteCircuitSKUTier) ToPtr 

func (c ExpressRouteCircuitSKUTier) ToPtr() *ExpressRouteCircuitSKUTier

ToPtr returns a *ExpressRouteCircuitSKUTier pointing to the current value.

type ExpressRouteCircuitServiceProviderProperties 

type ExpressRouteCircuitServiceProviderProperties struct {
	// The BandwidthInMbps.
	BandwidthInMbps *int32 `json:"bandwidthInMbps,omitempty"`

	// The peering location.
	PeeringLocation *string `json:"peeringLocation,omitempty"`

	// The serviceProviderName.
	ServiceProviderName *string `json:"serviceProviderName,omitempty"`
}

ExpressRouteCircuitServiceProviderProperties - Contains ServiceProviderProperties in an ExpressRouteCircuit.

type ExpressRouteCircuitStats 

type ExpressRouteCircuitStats struct {
	// The Primary BytesIn of the peering.
	PrimarybytesIn *int64 `json:"primarybytesIn,omitempty"`

	// The primary BytesOut of the peering.
	PrimarybytesOut *int64 `json:"primarybytesOut,omitempty"`

	// The secondary BytesIn of the peering.
	SecondarybytesIn *int64 `json:"secondarybytesIn,omitempty"`

	// The secondary BytesOut of the peering.
	SecondarybytesOut *int64 `json:"secondarybytesOut,omitempty"`
}

ExpressRouteCircuitStats - Contains stats associated with the peering.

type ExpressRouteCircuitsArpTableListResult 

type ExpressRouteCircuitsArpTableListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of the ARP tables.
	Value []*ExpressRouteCircuitArpTable `json:"value,omitempty"`
}

ExpressRouteCircuitsArpTableListResult - Response for ListArpTable associated with the Express Route Circuits API.

func (ExpressRouteCircuitsArpTableListResult) MarshalJSON 

func (e ExpressRouteCircuitsArpTableListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitsArpTableListResult.

type ExpressRouteCircuitsClient 

type ExpressRouteCircuitsClient struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitsClient contains the methods for the ExpressRouteCircuits group. Don't use this type directly, use NewExpressRouteCircuitsClient() instead.

func NewExpressRouteCircuitsClient 

func NewExpressRouteCircuitsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRouteCircuitsClient

NewExpressRouteCircuitsClient creates a new instance of ExpressRouteCircuitsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRouteCircuitsClient) BeginCreateOrUpdate 

func (client *ExpressRouteCircuitsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, circuitName string, parameters ExpressRouteCircuit, options *ExpressRouteCircuitsClientBeginCreateOrUpdateOptions) (ExpressRouteCircuitsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates an express route circuit. If the operation fails it returns an *azcore.ResponseError type. 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. options - ExpressRouteCircuitsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		armnetwork.ExpressRouteCircuit{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.ExpressRouteCircuitPropertiesFormat{
				AllowClassicOperations: to.BoolPtr(false),
				Authorizations:         []*armnetwork.ExpressRouteCircuitAuthorization{},
				Peerings:               []*armnetwork.ExpressRouteCircuitPeering{},
				ServiceProviderProperties: &armnetwork.ExpressRouteCircuitServiceProviderProperties{
					BandwidthInMbps:     to.Int32Ptr(200),
					PeeringLocation:     to.StringPtr("<peering-location>"),
					ServiceProviderName: to.StringPtr("<service-provider-name>"),
				},
			},
			SKU: &armnetwork.ExpressRouteCircuitSKU{
				Name:   to.StringPtr("<name>"),
				Family: armnetwork.ExpressRouteCircuitSKUFamily("MeteredData").ToPtr(),
				Tier:   armnetwork.ExpressRouteCircuitSKUTier("Standard").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitsClientCreateOrUpdateResult)
}

Output:

func (*ExpressRouteCircuitsClient) BeginDelete 

func (client *ExpressRouteCircuitsClient) BeginDelete(ctx context.Context, resourceGroupName string, circuitName string, options *ExpressRouteCircuitsClientBeginDeleteOptions) (ExpressRouteCircuitsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. options - ExpressRouteCircuitsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ExpressRouteCircuitsClient) BeginListArpTable 

func (client *ExpressRouteCircuitsClient) BeginListArpTable(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string, options *ExpressRouteCircuitsClientBeginListArpTableOptions) (ExpressRouteCircuitsClientListArpTablePollerResponse, error)

BeginListArpTable - Gets the currently advertised ARP table associated with the express route circuit in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. peeringName - The name of the peering. devicePath - The path of the device. options - ExpressRouteCircuitsClientBeginListArpTableOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginListArpTable method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitARPTableList.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListArpTable(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		"<device-path>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitsClientListArpTableResult)
}

Output:

func (*ExpressRouteCircuitsClient) BeginListRoutesTable 

func (client *ExpressRouteCircuitsClient) BeginListRoutesTable(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string, options *ExpressRouteCircuitsClientBeginListRoutesTableOptions) (ExpressRouteCircuitsClientListRoutesTablePollerResponse, error)

BeginListRoutesTable - Gets the currently advertised routes table associated with the express route circuit in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. peeringName - The name of the peering. devicePath - The path of the device. options - ExpressRouteCircuitsClientBeginListRoutesTableOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginListRoutesTable method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitRouteTableList.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListRoutesTable(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		"<device-path>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitsClientListRoutesTableResult)
}

Output:

func (*ExpressRouteCircuitsClient) BeginListRoutesTableSummary 

func (client *ExpressRouteCircuitsClient) BeginListRoutesTableSummary(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string, options *ExpressRouteCircuitsClientBeginListRoutesTableSummaryOptions) (ExpressRouteCircuitsClientListRoutesTableSummaryPollerResponse, error)

BeginListRoutesTableSummary - Gets the currently advertised routes table summary associated with the express route circuit in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. peeringName - The name of the peering. devicePath - The path of the device. options - ExpressRouteCircuitsClientBeginListRoutesTableSummaryOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginListRoutesTableSummary method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitRouteTableSummaryList.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListRoutesTableSummary(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		"<device-path>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitsClientListRoutesTableSummaryResult)
}

Output:

func (*ExpressRouteCircuitsClient) Get 

func (client *ExpressRouteCircuitsClient) Get(ctx context.Context, resourceGroupName string, circuitName string, options *ExpressRouteCircuitsClientGetOptions) (ExpressRouteCircuitsClientGetResponse, error)

Get - Gets information about the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of express route circuit. options - ExpressRouteCircuitsClientGetOptions contains the optional parameters for the ExpressRouteCircuitsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitsClientGetResult)
}

Output:

func (*ExpressRouteCircuitsClient) GetPeeringStats 

func (client *ExpressRouteCircuitsClient) GetPeeringStats(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, options *ExpressRouteCircuitsClientGetPeeringStatsOptions) (ExpressRouteCircuitsClientGetPeeringStatsResponse, error)

GetPeeringStats - Gets all stats from an express route circuit in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. peeringName - The name of the peering. options - ExpressRouteCircuitsClientGetPeeringStatsOptions contains the optional parameters for the ExpressRouteCircuitsClient.GetPeeringStats method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitPeeringStats.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	res, err := client.GetPeeringStats(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitsClientGetPeeringStatsResult)
}

Output:

func (*ExpressRouteCircuitsClient) GetStats 

func (client *ExpressRouteCircuitsClient) GetStats(ctx context.Context, resourceGroupName string, circuitName string, options *ExpressRouteCircuitsClientGetStatsOptions) (ExpressRouteCircuitsClientGetStatsResponse, error)

GetStats - Gets all the stats from an express route circuit in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. options - ExpressRouteCircuitsClientGetStatsOptions contains the optional parameters for the ExpressRouteCircuitsClient.GetStats method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitStats.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	res, err := client.GetStats(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitsClientGetStatsResult)
}

Output:

func (*ExpressRouteCircuitsClient) List 

func (client *ExpressRouteCircuitsClient) List(resourceGroupName string, options *ExpressRouteCircuitsClientListOptions) *ExpressRouteCircuitsClientListPager

List - Gets all the express route circuits in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - ExpressRouteCircuitsClientListOptions contains the optional parameters for the ExpressRouteCircuitsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ExpressRouteCircuitsClient) ListAll 

func (client *ExpressRouteCircuitsClient) ListAll(options *ExpressRouteCircuitsClientListAllOptions) *ExpressRouteCircuitsClientListAllPager

ListAll - Gets all the express route circuits in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ExpressRouteCircuitsClientListAllOptions contains the optional parameters for the ExpressRouteCircuitsClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ExpressRouteCircuitsClient) UpdateTags 

func (client *ExpressRouteCircuitsClient) UpdateTags(ctx context.Context, resourceGroupName string, circuitName string, parameters TagsObject, options *ExpressRouteCircuitsClientUpdateTagsOptions) (ExpressRouteCircuitsClientUpdateTagsResponse, error)

UpdateTags - Updates an express route circuit tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the circuit. parameters - Parameters supplied to update express route circuit tags. options - ExpressRouteCircuitsClientUpdateTagsOptions contains the optional parameters for the ExpressRouteCircuitsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCircuitUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCircuitsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCircuitsClientUpdateTagsResult)
}

Output:

type ExpressRouteCircuitsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ExpressRouteCircuitsClientBeginCreateOrUpdateOptions struct {
}

ExpressRouteCircuitsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginCreateOrUpdate method.

type ExpressRouteCircuitsClientBeginDeleteOptions added in v0.3.0 

type ExpressRouteCircuitsClientBeginDeleteOptions struct {
}

ExpressRouteCircuitsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginDelete method.

type ExpressRouteCircuitsClientBeginListArpTableOptions added in v0.3.0 

type ExpressRouteCircuitsClientBeginListArpTableOptions struct {
}

ExpressRouteCircuitsClientBeginListArpTableOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginListArpTable method.

type ExpressRouteCircuitsClientBeginListRoutesTableOptions added in v0.3.0 

type ExpressRouteCircuitsClientBeginListRoutesTableOptions struct {
}

ExpressRouteCircuitsClientBeginListRoutesTableOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginListRoutesTable method.

type ExpressRouteCircuitsClientBeginListRoutesTableSummaryOptions added in v0.3.0 

type ExpressRouteCircuitsClientBeginListRoutesTableSummaryOptions struct {
}

ExpressRouteCircuitsClientBeginListRoutesTableSummaryOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginListRoutesTableSummary method.

type ExpressRouteCircuitsClientCreateOrUpdatePoller added in v0.3.0 

type ExpressRouteCircuitsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitsClientCreateOrUpdateResponse will be returned.

func (*ExpressRouteCircuitsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ExpressRouteCircuitsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientCreateOrUpdatePollerResponse contains the response from method ExpressRouteCircuitsClient.CreateOrUpdate.

func (ExpressRouteCircuitsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitsClient, token string) error

Resume rehydrates a ExpressRouteCircuitsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ExpressRouteCircuitsClientCreateOrUpdateResponse added in v0.3.0 

type ExpressRouteCircuitsClientCreateOrUpdateResponse struct {
	ExpressRouteCircuitsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientCreateOrUpdateResponse contains the response from method ExpressRouteCircuitsClient.CreateOrUpdate.

type ExpressRouteCircuitsClientCreateOrUpdateResult added in v0.3.0 

type ExpressRouteCircuitsClientCreateOrUpdateResult struct {
	ExpressRouteCircuit
}

ExpressRouteCircuitsClientCreateOrUpdateResult contains the result from method ExpressRouteCircuitsClient.CreateOrUpdate.

type ExpressRouteCircuitsClientDeletePoller added in v0.3.0 

type ExpressRouteCircuitsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitsClientDeletePoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitsClientDeletePoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitsClientDeleteResponse will be returned.

func (*ExpressRouteCircuitsClientDeletePoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitsClientDeletePollerResponse added in v0.3.0 

type ExpressRouteCircuitsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientDeletePollerResponse contains the response from method ExpressRouteCircuitsClient.Delete.

func (ExpressRouteCircuitsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitsClientDeletePollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitsClient, token string) error

Resume rehydrates a ExpressRouteCircuitsClientDeletePollerResponse from the provided client and resume token.

type ExpressRouteCircuitsClientDeleteResponse added in v0.3.0 

type ExpressRouteCircuitsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientDeleteResponse contains the response from method ExpressRouteCircuitsClient.Delete.

type ExpressRouteCircuitsClientGetOptions added in v0.3.0 

type ExpressRouteCircuitsClientGetOptions struct {
}

ExpressRouteCircuitsClientGetOptions contains the optional parameters for the ExpressRouteCircuitsClient.Get method.

type ExpressRouteCircuitsClientGetPeeringStatsOptions added in v0.3.0 

type ExpressRouteCircuitsClientGetPeeringStatsOptions struct {
}

ExpressRouteCircuitsClientGetPeeringStatsOptions contains the optional parameters for the ExpressRouteCircuitsClient.GetPeeringStats method.

type ExpressRouteCircuitsClientGetPeeringStatsResponse added in v0.3.0 

type ExpressRouteCircuitsClientGetPeeringStatsResponse struct {
	ExpressRouteCircuitsClientGetPeeringStatsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientGetPeeringStatsResponse contains the response from method ExpressRouteCircuitsClient.GetPeeringStats.

type ExpressRouteCircuitsClientGetPeeringStatsResult added in v0.3.0 

type ExpressRouteCircuitsClientGetPeeringStatsResult struct {
	ExpressRouteCircuitStats
}

ExpressRouteCircuitsClientGetPeeringStatsResult contains the result from method ExpressRouteCircuitsClient.GetPeeringStats.

type ExpressRouteCircuitsClientGetResponse added in v0.3.0 

type ExpressRouteCircuitsClientGetResponse struct {
	ExpressRouteCircuitsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientGetResponse contains the response from method ExpressRouteCircuitsClient.Get.

type ExpressRouteCircuitsClientGetResult added in v0.3.0 

type ExpressRouteCircuitsClientGetResult struct {
	ExpressRouteCircuit
}

ExpressRouteCircuitsClientGetResult contains the result from method ExpressRouteCircuitsClient.Get.

type ExpressRouteCircuitsClientGetStatsOptions added in v0.3.0 

type ExpressRouteCircuitsClientGetStatsOptions struct {
}

ExpressRouteCircuitsClientGetStatsOptions contains the optional parameters for the ExpressRouteCircuitsClient.GetStats method.

type ExpressRouteCircuitsClientGetStatsResponse added in v0.3.0 

type ExpressRouteCircuitsClientGetStatsResponse struct {
	ExpressRouteCircuitsClientGetStatsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientGetStatsResponse contains the response from method ExpressRouteCircuitsClient.GetStats.

type ExpressRouteCircuitsClientGetStatsResult added in v0.3.0 

type ExpressRouteCircuitsClientGetStatsResult struct {
	ExpressRouteCircuitStats
}

ExpressRouteCircuitsClientGetStatsResult contains the result from method ExpressRouteCircuitsClient.GetStats.

type ExpressRouteCircuitsClientListAllOptions added in v0.3.0 

type ExpressRouteCircuitsClientListAllOptions struct {
}

ExpressRouteCircuitsClientListAllOptions contains the optional parameters for the ExpressRouteCircuitsClient.ListAll method.

type ExpressRouteCircuitsClientListAllPager added in v0.3.0 

type ExpressRouteCircuitsClientListAllPager struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitsClientListAllPager provides operations for iterating over paged responses.

func (*ExpressRouteCircuitsClientListAllPager) Err added in v0.3.0 

func (p *ExpressRouteCircuitsClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRouteCircuitsClientListAllPager) NextPage added in v0.3.0 

func (p *ExpressRouteCircuitsClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRouteCircuitsClientListAllPager) PageResponse added in v0.3.0 

func (p *ExpressRouteCircuitsClientListAllPager) PageResponse() ExpressRouteCircuitsClientListAllResponse

PageResponse returns the current ExpressRouteCircuitsClientListAllResponse page.

type ExpressRouteCircuitsClientListAllResponse added in v0.3.0 

type ExpressRouteCircuitsClientListAllResponse struct {
	ExpressRouteCircuitsClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientListAllResponse contains the response from method ExpressRouteCircuitsClient.ListAll.

type ExpressRouteCircuitsClientListAllResult added in v0.3.0 

type ExpressRouteCircuitsClientListAllResult struct {
	ExpressRouteCircuitListResult
}

ExpressRouteCircuitsClientListAllResult contains the result from method ExpressRouteCircuitsClient.ListAll.

type ExpressRouteCircuitsClientListArpTablePoller added in v0.3.0 

type ExpressRouteCircuitsClientListArpTablePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitsClientListArpTablePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitsClientListArpTablePoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitsClientListArpTablePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitsClientListArpTablePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitsClientListArpTablePoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitsClientListArpTableResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitsClientListArpTableResponse will be returned.

func (*ExpressRouteCircuitsClientListArpTablePoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitsClientListArpTablePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitsClientListArpTablePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitsClientListArpTablePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitsClientListArpTablePollerResponse added in v0.3.0 

type ExpressRouteCircuitsClientListArpTablePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitsClientListArpTablePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientListArpTablePollerResponse contains the response from method ExpressRouteCircuitsClient.ListArpTable.

func (ExpressRouteCircuitsClientListArpTablePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitsClientListArpTablePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitsClientListArpTableResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitsClientListArpTablePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitsClientListArpTablePollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitsClient, token string) error

Resume rehydrates a ExpressRouteCircuitsClientListArpTablePollerResponse from the provided client and resume token.

type ExpressRouteCircuitsClientListArpTableResponse added in v0.3.0 

type ExpressRouteCircuitsClientListArpTableResponse struct {
	ExpressRouteCircuitsClientListArpTableResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientListArpTableResponse contains the response from method ExpressRouteCircuitsClient.ListArpTable.

type ExpressRouteCircuitsClientListArpTableResult added in v0.3.0 

type ExpressRouteCircuitsClientListArpTableResult struct {
	ExpressRouteCircuitsArpTableListResult
}

ExpressRouteCircuitsClientListArpTableResult contains the result from method ExpressRouteCircuitsClient.ListArpTable.

type ExpressRouteCircuitsClientListOptions added in v0.3.0 

type ExpressRouteCircuitsClientListOptions struct {
}

ExpressRouteCircuitsClientListOptions contains the optional parameters for the ExpressRouteCircuitsClient.List method.

type ExpressRouteCircuitsClientListPager added in v0.3.0 

type ExpressRouteCircuitsClientListPager struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitsClientListPager provides operations for iterating over paged responses.

func (*ExpressRouteCircuitsClientListPager) Err added in v0.3.0 

func (p *ExpressRouteCircuitsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRouteCircuitsClientListPager) NextPage added in v0.3.0 

func (p *ExpressRouteCircuitsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRouteCircuitsClientListPager) PageResponse added in v0.3.0 

func (p *ExpressRouteCircuitsClientListPager) PageResponse() ExpressRouteCircuitsClientListResponse

PageResponse returns the current ExpressRouteCircuitsClientListResponse page.

type ExpressRouteCircuitsClientListResponse added in v0.3.0 

type ExpressRouteCircuitsClientListResponse struct {
	ExpressRouteCircuitsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientListResponse contains the response from method ExpressRouteCircuitsClient.List.

type ExpressRouteCircuitsClientListResult added in v0.3.0 

type ExpressRouteCircuitsClientListResult struct {
	ExpressRouteCircuitListResult
}

ExpressRouteCircuitsClientListResult contains the result from method ExpressRouteCircuitsClient.List.

type ExpressRouteCircuitsClientListRoutesTablePoller added in v0.3.0 

type ExpressRouteCircuitsClientListRoutesTablePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitsClientListRoutesTablePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitsClientListRoutesTablePoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitsClientListRoutesTablePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitsClientListRoutesTablePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitsClientListRoutesTablePoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitsClientListRoutesTableResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitsClientListRoutesTableResponse will be returned.

func (*ExpressRouteCircuitsClientListRoutesTablePoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitsClientListRoutesTablePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitsClientListRoutesTablePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitsClientListRoutesTablePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitsClientListRoutesTablePollerResponse added in v0.3.0 

type ExpressRouteCircuitsClientListRoutesTablePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitsClientListRoutesTablePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientListRoutesTablePollerResponse contains the response from method ExpressRouteCircuitsClient.ListRoutesTable.

func (ExpressRouteCircuitsClientListRoutesTablePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitsClientListRoutesTablePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitsClientListRoutesTableResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitsClientListRoutesTablePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitsClientListRoutesTablePollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitsClient, token string) error

Resume rehydrates a ExpressRouteCircuitsClientListRoutesTablePollerResponse from the provided client and resume token.

type ExpressRouteCircuitsClientListRoutesTableResponse added in v0.3.0 

type ExpressRouteCircuitsClientListRoutesTableResponse struct {
	ExpressRouteCircuitsClientListRoutesTableResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientListRoutesTableResponse contains the response from method ExpressRouteCircuitsClient.ListRoutesTable.

type ExpressRouteCircuitsClientListRoutesTableResult added in v0.3.0 

type ExpressRouteCircuitsClientListRoutesTableResult struct {
	ExpressRouteCircuitsRoutesTableListResult
}

ExpressRouteCircuitsClientListRoutesTableResult contains the result from method ExpressRouteCircuitsClient.ListRoutesTable.

type ExpressRouteCircuitsClientListRoutesTableSummaryPoller added in v0.3.0 

type ExpressRouteCircuitsClientListRoutesTableSummaryPoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCircuitsClientListRoutesTableSummaryPoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCircuitsClientListRoutesTableSummaryPoller) Done added in v0.3.0 

func (p *ExpressRouteCircuitsClientListRoutesTableSummaryPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCircuitsClientListRoutesTableSummaryPoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCircuitsClientListRoutesTableSummaryPoller) FinalResponse(ctx context.Context) (ExpressRouteCircuitsClientListRoutesTableSummaryResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCircuitsClientListRoutesTableSummaryResponse will be returned.

func (*ExpressRouteCircuitsClientListRoutesTableSummaryPoller) Poll added in v0.3.0 

func (p *ExpressRouteCircuitsClientListRoutesTableSummaryPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCircuitsClientListRoutesTableSummaryPoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCircuitsClientListRoutesTableSummaryPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCircuitsClientListRoutesTableSummaryPollerResponse added in v0.3.0 

type ExpressRouteCircuitsClientListRoutesTableSummaryPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCircuitsClientListRoutesTableSummaryPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientListRoutesTableSummaryPollerResponse contains the response from method ExpressRouteCircuitsClient.ListRoutesTableSummary.

func (ExpressRouteCircuitsClientListRoutesTableSummaryPollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCircuitsClientListRoutesTableSummaryPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCircuitsClientListRoutesTableSummaryResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCircuitsClientListRoutesTableSummaryPollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCircuitsClientListRoutesTableSummaryPollerResponse) Resume(ctx context.Context, client *ExpressRouteCircuitsClient, token string) error

Resume rehydrates a ExpressRouteCircuitsClientListRoutesTableSummaryPollerResponse from the provided client and resume token.

type ExpressRouteCircuitsClientListRoutesTableSummaryResponse added in v0.3.0 

type ExpressRouteCircuitsClientListRoutesTableSummaryResponse struct {
	ExpressRouteCircuitsClientListRoutesTableSummaryResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientListRoutesTableSummaryResponse contains the response from method ExpressRouteCircuitsClient.ListRoutesTableSummary.

type ExpressRouteCircuitsClientListRoutesTableSummaryResult added in v0.3.0 

type ExpressRouteCircuitsClientListRoutesTableSummaryResult struct {
	ExpressRouteCircuitsRoutesTableSummaryListResult
}

ExpressRouteCircuitsClientListRoutesTableSummaryResult contains the result from method ExpressRouteCircuitsClient.ListRoutesTableSummary.

type ExpressRouteCircuitsClientUpdateTagsOptions added in v0.3.0 

type ExpressRouteCircuitsClientUpdateTagsOptions struct {
}

ExpressRouteCircuitsClientUpdateTagsOptions contains the optional parameters for the ExpressRouteCircuitsClient.UpdateTags method.

type ExpressRouteCircuitsClientUpdateTagsResponse added in v0.3.0 

type ExpressRouteCircuitsClientUpdateTagsResponse struct {
	ExpressRouteCircuitsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCircuitsClientUpdateTagsResponse contains the response from method ExpressRouteCircuitsClient.UpdateTags.

type ExpressRouteCircuitsClientUpdateTagsResult added in v0.3.0 

type ExpressRouteCircuitsClientUpdateTagsResult struct {
	ExpressRouteCircuit
}

ExpressRouteCircuitsClientUpdateTagsResult contains the result from method ExpressRouteCircuitsClient.UpdateTags.

type ExpressRouteCircuitsRoutesTableListResult 

type ExpressRouteCircuitsRoutesTableListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of routes table.
	Value []*ExpressRouteCircuitRoutesTable `json:"value,omitempty"`
}

ExpressRouteCircuitsRoutesTableListResult - Response for ListRoutesTable associated with the Express Route Circuits API.

func (ExpressRouteCircuitsRoutesTableListResult) MarshalJSON 

func (e ExpressRouteCircuitsRoutesTableListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitsRoutesTableListResult.

type ExpressRouteCircuitsRoutesTableSummaryListResult 

type ExpressRouteCircuitsRoutesTableSummaryListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of the routes table.
	Value []*ExpressRouteCircuitRoutesTableSummary `json:"value,omitempty"`
}

ExpressRouteCircuitsRoutesTableSummaryListResult - Response for ListRoutesTable associated with the Express Route Circuits API.

func (ExpressRouteCircuitsRoutesTableSummaryListResult) MarshalJSON 

func (e ExpressRouteCircuitsRoutesTableSummaryListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitsRoutesTableSummaryListResult.

type ExpressRouteConnection 

type ExpressRouteConnection struct {
	// REQUIRED; The name of the resource.
	Name *string `json:"name,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Properties of the express route connection.
	Properties *ExpressRouteConnectionProperties `json:"properties,omitempty"`
}

ExpressRouteConnection resource.

type ExpressRouteConnectionID 

type ExpressRouteConnectionID struct {
	// READ-ONLY; The ID of the ExpressRouteConnection.
	ID *string `json:"id,omitempty" azure:"ro"`
}

ExpressRouteConnectionID - The ID of the ExpressRouteConnection.

type ExpressRouteConnectionList 

type ExpressRouteConnectionList struct {
	// The list of ExpressRoute connections.
	Value []*ExpressRouteConnection `json:"value,omitempty"`
}

ExpressRouteConnectionList - ExpressRouteConnection list.

func (ExpressRouteConnectionList) MarshalJSON 

func (e ExpressRouteConnectionList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteConnectionList.

type ExpressRouteConnectionProperties 

type ExpressRouteConnectionProperties struct {
	// REQUIRED; The ExpressRoute circuit peering.
	ExpressRouteCircuitPeering *ExpressRouteCircuitPeeringID `json:"expressRouteCircuitPeering,omitempty"`

	// Authorization key to establish the connection.
	AuthorizationKey *string `json:"authorizationKey,omitempty"`

	// Enable internet security.
	EnableInternetSecurity *bool `json:"enableInternetSecurity,omitempty"`

	// Enable FastPath to vWan Firewall hub.
	ExpressRouteGatewayBypass *bool `json:"expressRouteGatewayBypass,omitempty"`

	// The Routing Configuration indicating the associated and propagated route tables on this connection.
	RoutingConfiguration *RoutingConfiguration `json:"routingConfiguration,omitempty"`

	// The routing weight associated to the connection.
	RoutingWeight *int32 `json:"routingWeight,omitempty"`

	// READ-ONLY; The provisioning state of the express route connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ExpressRouteConnectionProperties - Properties of the ExpressRouteConnection subresource.

type ExpressRouteConnectionsClient 

type ExpressRouteConnectionsClient struct {
	// contains filtered or unexported fields
}

ExpressRouteConnectionsClient contains the methods for the ExpressRouteConnections group. Don't use this type directly, use NewExpressRouteConnectionsClient() instead.

func NewExpressRouteConnectionsClient 

func NewExpressRouteConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRouteConnectionsClient

NewExpressRouteConnectionsClient creates a new instance of ExpressRouteConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRouteConnectionsClient) BeginCreateOrUpdate 

func (client *ExpressRouteConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, expressRouteGatewayName string, connectionName string, putExpressRouteConnectionParameters ExpressRouteConnection, options *ExpressRouteConnectionsClientBeginCreateOrUpdateOptions) (ExpressRouteConnectionsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRouteGatewayName - The name of the ExpressRoute gateway. connectionName - The name of the connection subresource. putExpressRouteConnectionParameters - Parameters required in an ExpressRouteConnection PUT operation. options - ExpressRouteConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteConnectionsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteConnectionCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<express-route-gateway-name>",
		"<connection-name>",
		armnetwork.ExpressRouteConnection{
			ID:   to.StringPtr("<id>"),
			Name: to.StringPtr("<name>"),
			Properties: &armnetwork.ExpressRouteConnectionProperties{
				AuthorizationKey: to.StringPtr("<authorization-key>"),
				ExpressRouteCircuitPeering: &armnetwork.ExpressRouteCircuitPeeringID{
					ID: to.StringPtr("<id>"),
				},
				RoutingWeight: to.Int32Ptr(2),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteConnectionsClientCreateOrUpdateResult)
}

Output:

func (*ExpressRouteConnectionsClient) BeginDelete 

func (client *ExpressRouteConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, expressRouteGatewayName string, connectionName string, options *ExpressRouteConnectionsClientBeginDeleteOptions) (ExpressRouteConnectionsClientDeletePollerResponse, error)

BeginDelete - Deletes a connection to a ExpressRoute circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRouteGatewayName - The name of the ExpressRoute gateway. connectionName - The name of the connection subresource. options - ExpressRouteConnectionsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteConnectionsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteConnectionDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<express-route-gateway-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ExpressRouteConnectionsClient) Get 

func (client *ExpressRouteConnectionsClient) Get(ctx context.Context, resourceGroupName string, expressRouteGatewayName string, connectionName string, options *ExpressRouteConnectionsClientGetOptions) (ExpressRouteConnectionsClientGetResponse, error)

Get - Gets the specified ExpressRouteConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRouteGatewayName - The name of the ExpressRoute gateway. connectionName - The name of the ExpressRoute connection. options - ExpressRouteConnectionsClientGetOptions contains the optional parameters for the ExpressRouteConnectionsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteConnectionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<express-route-gateway-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteConnectionsClientGetResult)
}

Output:

func (*ExpressRouteConnectionsClient) List 

func (client *ExpressRouteConnectionsClient) List(ctx context.Context, resourceGroupName string, expressRouteGatewayName string, options *ExpressRouteConnectionsClientListOptions) (ExpressRouteConnectionsClientListResponse, error)

List - Lists ExpressRouteConnections. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRouteGatewayName - The name of the ExpressRoute gateway. options - ExpressRouteConnectionsClientListOptions contains the optional parameters for the ExpressRouteConnectionsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteConnectionList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<express-route-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteConnectionsClientListResult)
}

Output:

type ExpressRouteConnectionsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ExpressRouteConnectionsClientBeginCreateOrUpdateOptions struct {
}

ExpressRouteConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteConnectionsClient.BeginCreateOrUpdate method.

type ExpressRouteConnectionsClientBeginDeleteOptions added in v0.3.0 

type ExpressRouteConnectionsClientBeginDeleteOptions struct {
}

ExpressRouteConnectionsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteConnectionsClient.BeginDelete method.

type ExpressRouteConnectionsClientCreateOrUpdatePoller added in v0.3.0 

type ExpressRouteConnectionsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteConnectionsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteConnectionsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ExpressRouteConnectionsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteConnectionsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteConnectionsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ExpressRouteConnectionsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteConnectionsClientCreateOrUpdateResponse will be returned.

func (*ExpressRouteConnectionsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ExpressRouteConnectionsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteConnectionsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteConnectionsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteConnectionsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ExpressRouteConnectionsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteConnectionsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteConnectionsClientCreateOrUpdatePollerResponse contains the response from method ExpressRouteConnectionsClient.CreateOrUpdate.

func (ExpressRouteConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteConnectionsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteConnectionsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteConnectionsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ExpressRouteConnectionsClient, token string) error

Resume rehydrates a ExpressRouteConnectionsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ExpressRouteConnectionsClientCreateOrUpdateResponse added in v0.3.0 

type ExpressRouteConnectionsClientCreateOrUpdateResponse struct {
	ExpressRouteConnectionsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteConnectionsClientCreateOrUpdateResponse contains the response from method ExpressRouteConnectionsClient.CreateOrUpdate.

type ExpressRouteConnectionsClientCreateOrUpdateResult added in v0.3.0 

type ExpressRouteConnectionsClientCreateOrUpdateResult struct {
	ExpressRouteConnection
}

ExpressRouteConnectionsClientCreateOrUpdateResult contains the result from method ExpressRouteConnectionsClient.CreateOrUpdate.

type ExpressRouteConnectionsClientDeletePoller added in v0.3.0 

type ExpressRouteConnectionsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteConnectionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteConnectionsClientDeletePoller) Done added in v0.3.0 

func (p *ExpressRouteConnectionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteConnectionsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (ExpressRouteConnectionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteConnectionsClientDeleteResponse will be returned.

func (*ExpressRouteConnectionsClientDeletePoller) Poll added in v0.3.0 

func (p *ExpressRouteConnectionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteConnectionsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteConnectionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteConnectionsClientDeletePollerResponse added in v0.3.0 

type ExpressRouteConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteConnectionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteConnectionsClientDeletePollerResponse contains the response from method ExpressRouteConnectionsClient.Delete.

func (ExpressRouteConnectionsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteConnectionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteConnectionsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteConnectionsClientDeletePollerResponse) Resume(ctx context.Context, client *ExpressRouteConnectionsClient, token string) error

Resume rehydrates a ExpressRouteConnectionsClientDeletePollerResponse from the provided client and resume token.

type ExpressRouteConnectionsClientDeleteResponse added in v0.3.0 

type ExpressRouteConnectionsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteConnectionsClientDeleteResponse contains the response from method ExpressRouteConnectionsClient.Delete.

type ExpressRouteConnectionsClientGetOptions added in v0.3.0 

type ExpressRouteConnectionsClientGetOptions struct {
}

ExpressRouteConnectionsClientGetOptions contains the optional parameters for the ExpressRouteConnectionsClient.Get method.

type ExpressRouteConnectionsClientGetResponse added in v0.3.0 

type ExpressRouteConnectionsClientGetResponse struct {
	ExpressRouteConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteConnectionsClientGetResponse contains the response from method ExpressRouteConnectionsClient.Get.

type ExpressRouteConnectionsClientGetResult added in v0.3.0 

type ExpressRouteConnectionsClientGetResult struct {
	ExpressRouteConnection
}

ExpressRouteConnectionsClientGetResult contains the result from method ExpressRouteConnectionsClient.Get.

type ExpressRouteConnectionsClientListOptions added in v0.3.0 

type ExpressRouteConnectionsClientListOptions struct {
}

ExpressRouteConnectionsClientListOptions contains the optional parameters for the ExpressRouteConnectionsClient.List method.

type ExpressRouteConnectionsClientListResponse added in v0.3.0 

type ExpressRouteConnectionsClientListResponse struct {
	ExpressRouteConnectionsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteConnectionsClientListResponse contains the response from method ExpressRouteConnectionsClient.List.

type ExpressRouteConnectionsClientListResult added in v0.3.0 

type ExpressRouteConnectionsClientListResult struct {
	ExpressRouteConnectionList
}

ExpressRouteConnectionsClientListResult contains the result from method ExpressRouteConnectionsClient.List.

type ExpressRouteCrossConnection 

type ExpressRouteCrossConnection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the express route cross connection.
	Properties *ExpressRouteCrossConnectionProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ExpressRouteCrossConnection resource.

func (ExpressRouteCrossConnection) MarshalJSON 

func (e ExpressRouteCrossConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCrossConnection.

type ExpressRouteCrossConnectionListResult 

type ExpressRouteCrossConnectionListResult struct {
	// A list of ExpressRouteCrossConnection resources.
	Value []*ExpressRouteCrossConnection `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ExpressRouteCrossConnectionListResult - Response for ListExpressRouteCrossConnection API service call.

func (ExpressRouteCrossConnectionListResult) MarshalJSON 

func (e ExpressRouteCrossConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCrossConnectionListResult.

type ExpressRouteCrossConnectionPeering 

type ExpressRouteCrossConnectionPeering struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the express route cross connection peering.
	Properties *ExpressRouteCrossConnectionPeeringProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

ExpressRouteCrossConnectionPeering - Peering in an ExpressRoute Cross Connection resource.

type ExpressRouteCrossConnectionPeeringList 

type ExpressRouteCrossConnectionPeeringList struct {
	// The peerings in an express route cross connection.
	Value []*ExpressRouteCrossConnectionPeering `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ExpressRouteCrossConnectionPeeringList - Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection.

func (ExpressRouteCrossConnectionPeeringList) MarshalJSON 

func (e ExpressRouteCrossConnectionPeeringList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCrossConnectionPeeringList.

type ExpressRouteCrossConnectionPeeringProperties 

type ExpressRouteCrossConnectionPeeringProperties struct {
	// The GatewayManager Etag.
	GatewayManagerEtag *string `json:"gatewayManagerEtag,omitempty"`

	// The IPv6 peering configuration.
	IPv6PeeringConfig *IPv6ExpressRouteCircuitPeeringConfig `json:"ipv6PeeringConfig,omitempty"`

	// The Microsoft peering configuration.
	MicrosoftPeeringConfig *ExpressRouteCircuitPeeringConfig `json:"microsoftPeeringConfig,omitempty"`

	// The peer ASN.
	PeerASN *int64 `json:"peerASN,omitempty"`

	// The peering type.
	PeeringType *ExpressRoutePeeringType `json:"peeringType,omitempty"`

	// The primary address prefix.
	PrimaryPeerAddressPrefix *string `json:"primaryPeerAddressPrefix,omitempty"`

	// The secondary address prefix.
	SecondaryPeerAddressPrefix *string `json:"secondaryPeerAddressPrefix,omitempty"`

	// The shared key.
	SharedKey *string `json:"sharedKey,omitempty"`

	// The peering state.
	State *ExpressRoutePeeringState `json:"state,omitempty"`

	// The VLAN ID.
	VlanID *int32 `json:"vlanId,omitempty"`

	// READ-ONLY; The Azure ASN.
	AzureASN *int32 `json:"azureASN,omitempty" azure:"ro"`

	// READ-ONLY; Who was the last to modify the peering.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty" azure:"ro"`

	// READ-ONLY; The primary port.
	PrimaryAzurePort *string `json:"primaryAzurePort,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the express route cross connection peering resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The secondary port.
	SecondaryAzurePort *string `json:"secondaryAzurePort,omitempty" azure:"ro"`
}

ExpressRouteCrossConnectionPeeringProperties - Properties of express route cross connection peering.

type ExpressRouteCrossConnectionPeeringsClient 

type ExpressRouteCrossConnectionPeeringsClient struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionPeeringsClient contains the methods for the ExpressRouteCrossConnectionPeerings group. Don't use this type directly, use NewExpressRouteCrossConnectionPeeringsClient() instead.

func NewExpressRouteCrossConnectionPeeringsClient 

func NewExpressRouteCrossConnectionPeeringsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRouteCrossConnectionPeeringsClient

NewExpressRouteCrossConnectionPeeringsClient creates a new instance of ExpressRouteCrossConnectionPeeringsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRouteCrossConnectionPeeringsClient) BeginCreateOrUpdate 

func (client *ExpressRouteCrossConnectionPeeringsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, crossConnectionName string, peeringName string, peeringParameters ExpressRouteCrossConnectionPeering, options *ExpressRouteCrossConnectionPeeringsClientBeginCreateOrUpdateOptions) (ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a peering in the specified ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. crossConnectionName - The name of the ExpressRouteCrossConnection. peeringName - The name of the peering. peeringParameters - Parameters supplied to the create or update ExpressRouteCrossConnection peering operation. options - ExpressRouteCrossConnectionPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionPeeringsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<cross-connection-name>",
		"<peering-name>",
		armnetwork.ExpressRouteCrossConnectionPeering{
			Properties: &armnetwork.ExpressRouteCrossConnectionPeeringProperties{
				IPv6PeeringConfig: &armnetwork.IPv6ExpressRouteCircuitPeeringConfig{
					PrimaryPeerAddressPrefix:   to.StringPtr("<primary-peer-address-prefix>"),
					SecondaryPeerAddressPrefix: to.StringPtr("<secondary-peer-address-prefix>"),
				},
				PeerASN:                    to.Int64Ptr(200),
				PrimaryPeerAddressPrefix:   to.StringPtr("<primary-peer-address-prefix>"),
				SecondaryPeerAddressPrefix: to.StringPtr("<secondary-peer-address-prefix>"),
				VlanID:                     to.Int32Ptr(200),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResult)
}

Output:

func (*ExpressRouteCrossConnectionPeeringsClient) BeginDelete 

func (client *ExpressRouteCrossConnectionPeeringsClient) BeginDelete(ctx context.Context, resourceGroupName string, crossConnectionName string, peeringName string, options *ExpressRouteCrossConnectionPeeringsClientBeginDeleteOptions) (ExpressRouteCrossConnectionPeeringsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified peering from the ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. crossConnectionName - The name of the ExpressRouteCrossConnection. peeringName - The name of the peering. options - ExpressRouteCrossConnectionPeeringsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionPeeringsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<cross-connection-name>",
		"<peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ExpressRouteCrossConnectionPeeringsClient) Get 

func (client *ExpressRouteCrossConnectionPeeringsClient) Get(ctx context.Context, resourceGroupName string, crossConnectionName string, peeringName string, options *ExpressRouteCrossConnectionPeeringsClientGetOptions) (ExpressRouteCrossConnectionPeeringsClientGetResponse, error)

Get - Gets the specified peering for the ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. crossConnectionName - The name of the ExpressRouteCrossConnection. peeringName - The name of the peering. options - ExpressRouteCrossConnectionPeeringsClientGetOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionPeeringsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<cross-connection-name>",
		"<peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCrossConnectionPeeringsClientGetResult)
}

Output:

func (*ExpressRouteCrossConnectionPeeringsClient) List 

func (client *ExpressRouteCrossConnectionPeeringsClient) List(resourceGroupName string, crossConnectionName string, options *ExpressRouteCrossConnectionPeeringsClientListOptions) *ExpressRouteCrossConnectionPeeringsClientListPager

List - Gets all peerings in a specified ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. crossConnectionName - The name of the ExpressRouteCrossConnection. options - ExpressRouteCrossConnectionPeeringsClientListOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionPeeringsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<cross-connection-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ExpressRouteCrossConnectionPeeringsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientBeginCreateOrUpdateOptions struct {
}

ExpressRouteCrossConnectionPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.BeginCreateOrUpdate method.

type ExpressRouteCrossConnectionPeeringsClientBeginDeleteOptions added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientBeginDeleteOptions struct {
}

ExpressRouteCrossConnectionPeeringsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.BeginDelete method.

type ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResponse will be returned.

func (*ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePollerResponse contains the response from method ExpressRouteCrossConnectionPeeringsClient.CreateOrUpdate.

func (ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ExpressRouteCrossConnectionPeeringsClient, token string) error

Resume rehydrates a ExpressRouteCrossConnectionPeeringsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResponse added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResponse struct {
	ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResponse contains the response from method ExpressRouteCrossConnectionPeeringsClient.CreateOrUpdate.

type ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResult added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResult struct {
	ExpressRouteCrossConnectionPeering
}

ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResult contains the result from method ExpressRouteCrossConnectionPeeringsClient.CreateOrUpdate.

type ExpressRouteCrossConnectionPeeringsClientDeletePoller added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionPeeringsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCrossConnectionPeeringsClientDeletePoller) Done added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCrossConnectionPeeringsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientDeletePoller) FinalResponse(ctx context.Context) (ExpressRouteCrossConnectionPeeringsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCrossConnectionPeeringsClientDeleteResponse will be returned.

func (*ExpressRouteCrossConnectionPeeringsClientDeletePoller) Poll added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCrossConnectionPeeringsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCrossConnectionPeeringsClientDeletePollerResponse added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCrossConnectionPeeringsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionPeeringsClientDeletePollerResponse contains the response from method ExpressRouteCrossConnectionPeeringsClient.Delete.

func (ExpressRouteCrossConnectionPeeringsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCrossConnectionPeeringsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCrossConnectionPeeringsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCrossConnectionPeeringsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCrossConnectionPeeringsClientDeletePollerResponse) Resume(ctx context.Context, client *ExpressRouteCrossConnectionPeeringsClient, token string) error

Resume rehydrates a ExpressRouteCrossConnectionPeeringsClientDeletePollerResponse from the provided client and resume token.

type ExpressRouteCrossConnectionPeeringsClientDeleteResponse added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionPeeringsClientDeleteResponse contains the response from method ExpressRouteCrossConnectionPeeringsClient.Delete.

type ExpressRouteCrossConnectionPeeringsClientGetOptions added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientGetOptions struct {
}

ExpressRouteCrossConnectionPeeringsClientGetOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.Get method.

type ExpressRouteCrossConnectionPeeringsClientGetResponse added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientGetResponse struct {
	ExpressRouteCrossConnectionPeeringsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionPeeringsClientGetResponse contains the response from method ExpressRouteCrossConnectionPeeringsClient.Get.

type ExpressRouteCrossConnectionPeeringsClientGetResult added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientGetResult struct {
	ExpressRouteCrossConnectionPeering
}

ExpressRouteCrossConnectionPeeringsClientGetResult contains the result from method ExpressRouteCrossConnectionPeeringsClient.Get.

type ExpressRouteCrossConnectionPeeringsClientListOptions added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientListOptions struct {
}

ExpressRouteCrossConnectionPeeringsClientListOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.List method.

type ExpressRouteCrossConnectionPeeringsClientListPager added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientListPager struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionPeeringsClientListPager provides operations for iterating over paged responses.

func (*ExpressRouteCrossConnectionPeeringsClientListPager) Err added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRouteCrossConnectionPeeringsClientListPager) NextPage added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRouteCrossConnectionPeeringsClientListPager) PageResponse added in v0.3.0 

func (p *ExpressRouteCrossConnectionPeeringsClientListPager) PageResponse() ExpressRouteCrossConnectionPeeringsClientListResponse

PageResponse returns the current ExpressRouteCrossConnectionPeeringsClientListResponse page.

type ExpressRouteCrossConnectionPeeringsClientListResponse added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientListResponse struct {
	ExpressRouteCrossConnectionPeeringsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionPeeringsClientListResponse contains the response from method ExpressRouteCrossConnectionPeeringsClient.List.

type ExpressRouteCrossConnectionPeeringsClientListResult added in v0.3.0 

type ExpressRouteCrossConnectionPeeringsClientListResult struct {
	ExpressRouteCrossConnectionPeeringList
}

ExpressRouteCrossConnectionPeeringsClientListResult contains the result from method ExpressRouteCrossConnectionPeeringsClient.List.

type ExpressRouteCrossConnectionProperties 

type ExpressRouteCrossConnectionProperties struct {
	// The ExpressRouteCircuit.
	ExpressRouteCircuit *ExpressRouteCircuitReference `json:"expressRouteCircuit,omitempty"`

	// The list of peerings.
	Peerings []*ExpressRouteCrossConnectionPeering `json:"peerings,omitempty"`

	// Additional read only notes set by the connectivity provider.
	ServiceProviderNotes *string `json:"serviceProviderNotes,omitempty"`

	// The provisioning state of the circuit in the connectivity provider system.
	ServiceProviderProvisioningState *ServiceProviderProvisioningState `json:"serviceProviderProvisioningState,omitempty"`

	// READ-ONLY; The circuit bandwidth In Mbps.
	BandwidthInMbps *int32 `json:"bandwidthInMbps,omitempty" azure:"ro"`

	// READ-ONLY; The peering location of the ExpressRoute circuit.
	PeeringLocation *string `json:"peeringLocation,omitempty" azure:"ro"`

	// READ-ONLY; The name of the primary port.
	PrimaryAzurePort *string `json:"primaryAzurePort,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the express route cross connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The identifier of the circuit traffic.
	STag *int32 `json:"sTag,omitempty" azure:"ro"`

	// READ-ONLY; The name of the secondary port.
	SecondaryAzurePort *string `json:"secondaryAzurePort,omitempty" azure:"ro"`
}

ExpressRouteCrossConnectionProperties - Properties of ExpressRouteCrossConnection.

func (ExpressRouteCrossConnectionProperties) MarshalJSON 

func (e ExpressRouteCrossConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCrossConnectionProperties.

type ExpressRouteCrossConnectionRoutesTableSummary 

type ExpressRouteCrossConnectionRoutesTableSummary struct {
	// Autonomous system number.
	Asn *int32 `json:"asn,omitempty"`

	// IP address of Neighbor router.
	Neighbor *string `json:"neighbor,omitempty"`

	// Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group.
	StateOrPrefixesReceived *string `json:"stateOrPrefixesReceived,omitempty"`

	// The length of time that the BGP session has been in the Established state, or the current status if not in the Established
	// state.
	UpDown *string `json:"upDown,omitempty"`
}

ExpressRouteCrossConnectionRoutesTableSummary - The routes table associated with the ExpressRouteCircuit.

type ExpressRouteCrossConnectionsClient 

type ExpressRouteCrossConnectionsClient struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionsClient contains the methods for the ExpressRouteCrossConnections group. Don't use this type directly, use NewExpressRouteCrossConnectionsClient() instead.

func NewExpressRouteCrossConnectionsClient 

func NewExpressRouteCrossConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRouteCrossConnectionsClient

NewExpressRouteCrossConnectionsClient creates a new instance of ExpressRouteCrossConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRouteCrossConnectionsClient) BeginCreateOrUpdate 

func (client *ExpressRouteCrossConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, crossConnectionName string, parameters ExpressRouteCrossConnection, options *ExpressRouteCrossConnectionsClientBeginCreateOrUpdateOptions) (ExpressRouteCrossConnectionsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Update the specified ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. crossConnectionName - The name of the ExpressRouteCrossConnection. parameters - Parameters supplied to the update express route crossConnection operation. options - ExpressRouteCrossConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<cross-connection-name>",
		armnetwork.ExpressRouteCrossConnection{
			Properties: &armnetwork.ExpressRouteCrossConnectionProperties{
				ServiceProviderProvisioningState: armnetwork.ServiceProviderProvisioningState("NotProvisioned").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCrossConnectionsClientCreateOrUpdateResult)
}

Output:

func (*ExpressRouteCrossConnectionsClient) BeginListArpTable 

func (client *ExpressRouteCrossConnectionsClient) BeginListArpTable(ctx context.Context, resourceGroupName string, crossConnectionName string, peeringName string, devicePath string, options *ExpressRouteCrossConnectionsClientBeginListArpTableOptions) (ExpressRouteCrossConnectionsClientListArpTablePollerResponse, error)

BeginListArpTable - Gets the currently advertised ARP table associated with the express route cross connection in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. crossConnectionName - The name of the ExpressRouteCrossConnection. peeringName - The name of the peering. devicePath - The path of the device. options - ExpressRouteCrossConnectionsClientBeginListArpTableOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginListArpTable method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionsArpTable.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListArpTable(ctx,
		"<resource-group-name>",
		"<cross-connection-name>",
		"<peering-name>",
		"<device-path>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCrossConnectionsClientListArpTableResult)
}

Output:

func (*ExpressRouteCrossConnectionsClient) BeginListRoutesTable 

func (client *ExpressRouteCrossConnectionsClient) BeginListRoutesTable(ctx context.Context, resourceGroupName string, crossConnectionName string, peeringName string, devicePath string, options *ExpressRouteCrossConnectionsClientBeginListRoutesTableOptions) (ExpressRouteCrossConnectionsClientListRoutesTablePollerResponse, error)

BeginListRoutesTable - Gets the currently advertised routes table associated with the express route cross connection in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. crossConnectionName - The name of the ExpressRouteCrossConnection. peeringName - The name of the peering. devicePath - The path of the device. options - ExpressRouteCrossConnectionsClientBeginListRoutesTableOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginListRoutesTable method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionsRouteTable.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListRoutesTable(ctx,
		"<resource-group-name>",
		"<cross-connection-name>",
		"<peering-name>",
		"<device-path>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCrossConnectionsClientListRoutesTableResult)
}

Output:

func (*ExpressRouteCrossConnectionsClient) BeginListRoutesTableSummary 

func (client *ExpressRouteCrossConnectionsClient) BeginListRoutesTableSummary(ctx context.Context, resourceGroupName string, crossConnectionName string, peeringName string, devicePath string, options *ExpressRouteCrossConnectionsClientBeginListRoutesTableSummaryOptions) (ExpressRouteCrossConnectionsClientListRoutesTableSummaryPollerResponse, error)

BeginListRoutesTableSummary - Gets the route table summary associated with the express route cross connection in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. crossConnectionName - The name of the ExpressRouteCrossConnection. peeringName - The name of the peering. devicePath - The path of the device. options - ExpressRouteCrossConnectionsClientBeginListRoutesTableSummaryOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginListRoutesTableSummary method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListRoutesTableSummary(ctx,
		"<resource-group-name>",
		"<cross-connection-name>",
		"<peering-name>",
		"<device-path>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCrossConnectionsClientListRoutesTableSummaryResult)
}

Output:

func (*ExpressRouteCrossConnectionsClient) Get 

func (client *ExpressRouteCrossConnectionsClient) Get(ctx context.Context, resourceGroupName string, crossConnectionName string, options *ExpressRouteCrossConnectionsClientGetOptions) (ExpressRouteCrossConnectionsClientGetResponse, error)

Get - Gets details about the specified ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group (peering location of the circuit). crossConnectionName - The name of the ExpressRouteCrossConnection (service key of the circuit). options - ExpressRouteCrossConnectionsClientGetOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<cross-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCrossConnectionsClientGetResult)
}

Output:

func (*ExpressRouteCrossConnectionsClient) List 

func (client *ExpressRouteCrossConnectionsClient) List(options *ExpressRouteCrossConnectionsClientListOptions) *ExpressRouteCrossConnectionsClientListPager

List - Retrieves all the ExpressRouteCrossConnections in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ExpressRouteCrossConnectionsClientListOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ExpressRouteCrossConnectionsClient) ListByResourceGroup 

func (client *ExpressRouteCrossConnectionsClient) ListByResourceGroup(resourceGroupName string, options *ExpressRouteCrossConnectionsClientListByResourceGroupOptions) *ExpressRouteCrossConnectionsClientListByResourceGroupPager

ListByResourceGroup - Retrieves all the ExpressRouteCrossConnections in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - ExpressRouteCrossConnectionsClientListByResourceGroupOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ExpressRouteCrossConnectionsClient) UpdateTags 

func (client *ExpressRouteCrossConnectionsClient) UpdateTags(ctx context.Context, resourceGroupName string, crossConnectionName string, crossConnectionParameters TagsObject, options *ExpressRouteCrossConnectionsClientUpdateTagsOptions) (ExpressRouteCrossConnectionsClientUpdateTagsResponse, error)

UpdateTags - Updates an express route cross connection tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. crossConnectionName - The name of the cross connection. crossConnectionParameters - Parameters supplied to update express route cross connection tags. options - ExpressRouteCrossConnectionsClientUpdateTagsOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteCrossConnectionUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteCrossConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<cross-connection-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteCrossConnectionsClientUpdateTagsResult)
}

Output:

type ExpressRouteCrossConnectionsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ExpressRouteCrossConnectionsClientBeginCreateOrUpdateOptions struct {
}

ExpressRouteCrossConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginCreateOrUpdate method.

type ExpressRouteCrossConnectionsClientBeginListArpTableOptions added in v0.3.0 

type ExpressRouteCrossConnectionsClientBeginListArpTableOptions struct {
}

ExpressRouteCrossConnectionsClientBeginListArpTableOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginListArpTable method.

type ExpressRouteCrossConnectionsClientBeginListRoutesTableOptions added in v0.3.0 

type ExpressRouteCrossConnectionsClientBeginListRoutesTableOptions struct {
}

ExpressRouteCrossConnectionsClientBeginListRoutesTableOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginListRoutesTable method.

type ExpressRouteCrossConnectionsClientBeginListRoutesTableSummaryOptions added in v0.3.0 

type ExpressRouteCrossConnectionsClientBeginListRoutesTableSummaryOptions struct {
}

ExpressRouteCrossConnectionsClientBeginListRoutesTableSummaryOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginListRoutesTableSummary method.

type ExpressRouteCrossConnectionsClientCreateOrUpdatePoller added in v0.3.0 

type ExpressRouteCrossConnectionsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCrossConnectionsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCrossConnectionsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ExpressRouteCrossConnectionsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCrossConnectionsClientCreateOrUpdateResponse will be returned.

func (*ExpressRouteCrossConnectionsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCrossConnectionsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCrossConnectionsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCrossConnectionsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientCreateOrUpdatePollerResponse contains the response from method ExpressRouteCrossConnectionsClient.CreateOrUpdate.

func (ExpressRouteCrossConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCrossConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCrossConnectionsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCrossConnectionsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCrossConnectionsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ExpressRouteCrossConnectionsClient, token string) error

Resume rehydrates a ExpressRouteCrossConnectionsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ExpressRouteCrossConnectionsClientCreateOrUpdateResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientCreateOrUpdateResponse struct {
	ExpressRouteCrossConnectionsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientCreateOrUpdateResponse contains the response from method ExpressRouteCrossConnectionsClient.CreateOrUpdate.

type ExpressRouteCrossConnectionsClientCreateOrUpdateResult added in v0.3.0 

type ExpressRouteCrossConnectionsClientCreateOrUpdateResult struct {
	ExpressRouteCrossConnection
}

ExpressRouteCrossConnectionsClientCreateOrUpdateResult contains the result from method ExpressRouteCrossConnectionsClient.CreateOrUpdate.

type ExpressRouteCrossConnectionsClientGetOptions added in v0.3.0 

type ExpressRouteCrossConnectionsClientGetOptions struct {
}

ExpressRouteCrossConnectionsClientGetOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.Get method.

type ExpressRouteCrossConnectionsClientGetResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientGetResponse struct {
	ExpressRouteCrossConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientGetResponse contains the response from method ExpressRouteCrossConnectionsClient.Get.

type ExpressRouteCrossConnectionsClientGetResult added in v0.3.0 

type ExpressRouteCrossConnectionsClientGetResult struct {
	ExpressRouteCrossConnection
}

ExpressRouteCrossConnectionsClientGetResult contains the result from method ExpressRouteCrossConnectionsClient.Get.

type ExpressRouteCrossConnectionsClientListArpTablePoller added in v0.3.0 

type ExpressRouteCrossConnectionsClientListArpTablePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionsClientListArpTablePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCrossConnectionsClientListArpTablePoller) Done added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListArpTablePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCrossConnectionsClientListArpTablePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListArpTablePoller) FinalResponse(ctx context.Context) (ExpressRouteCrossConnectionsClientListArpTableResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCrossConnectionsClientListArpTableResponse will be returned.

func (*ExpressRouteCrossConnectionsClientListArpTablePoller) Poll added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListArpTablePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCrossConnectionsClientListArpTablePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListArpTablePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCrossConnectionsClientListArpTablePollerResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientListArpTablePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCrossConnectionsClientListArpTablePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientListArpTablePollerResponse contains the response from method ExpressRouteCrossConnectionsClient.ListArpTable.

func (ExpressRouteCrossConnectionsClientListArpTablePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCrossConnectionsClientListArpTablePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCrossConnectionsClientListArpTableResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCrossConnectionsClientListArpTablePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCrossConnectionsClientListArpTablePollerResponse) Resume(ctx context.Context, client *ExpressRouteCrossConnectionsClient, token string) error

Resume rehydrates a ExpressRouteCrossConnectionsClientListArpTablePollerResponse from the provided client and resume token.

type ExpressRouteCrossConnectionsClientListArpTableResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientListArpTableResponse struct {
	ExpressRouteCrossConnectionsClientListArpTableResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientListArpTableResponse contains the response from method ExpressRouteCrossConnectionsClient.ListArpTable.

type ExpressRouteCrossConnectionsClientListArpTableResult added in v0.3.0 

type ExpressRouteCrossConnectionsClientListArpTableResult struct {
	ExpressRouteCircuitsArpTableListResult
}

ExpressRouteCrossConnectionsClientListArpTableResult contains the result from method ExpressRouteCrossConnectionsClient.ListArpTable.

type ExpressRouteCrossConnectionsClientListByResourceGroupOptions added in v0.3.0 

type ExpressRouteCrossConnectionsClientListByResourceGroupOptions struct {
}

ExpressRouteCrossConnectionsClientListByResourceGroupOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.ListByResourceGroup method.

type ExpressRouteCrossConnectionsClientListByResourceGroupPager added in v0.3.0 

type ExpressRouteCrossConnectionsClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*ExpressRouteCrossConnectionsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRouteCrossConnectionsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRouteCrossConnectionsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListByResourceGroupPager) PageResponse() ExpressRouteCrossConnectionsClientListByResourceGroupResponse

PageResponse returns the current ExpressRouteCrossConnectionsClientListByResourceGroupResponse page.

type ExpressRouteCrossConnectionsClientListByResourceGroupResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientListByResourceGroupResponse struct {
	ExpressRouteCrossConnectionsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientListByResourceGroupResponse contains the response from method ExpressRouteCrossConnectionsClient.ListByResourceGroup.

type ExpressRouteCrossConnectionsClientListByResourceGroupResult added in v0.3.0 

type ExpressRouteCrossConnectionsClientListByResourceGroupResult struct {
	ExpressRouteCrossConnectionListResult
}

ExpressRouteCrossConnectionsClientListByResourceGroupResult contains the result from method ExpressRouteCrossConnectionsClient.ListByResourceGroup.

type ExpressRouteCrossConnectionsClientListOptions added in v0.3.0 

type ExpressRouteCrossConnectionsClientListOptions struct {
}

ExpressRouteCrossConnectionsClientListOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.List method.

type ExpressRouteCrossConnectionsClientListPager added in v0.3.0 

type ExpressRouteCrossConnectionsClientListPager struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionsClientListPager provides operations for iterating over paged responses.

func (*ExpressRouteCrossConnectionsClientListPager) Err added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRouteCrossConnectionsClientListPager) NextPage added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRouteCrossConnectionsClientListPager) PageResponse added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListPager) PageResponse() ExpressRouteCrossConnectionsClientListResponse

PageResponse returns the current ExpressRouteCrossConnectionsClientListResponse page.

type ExpressRouteCrossConnectionsClientListResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientListResponse struct {
	ExpressRouteCrossConnectionsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientListResponse contains the response from method ExpressRouteCrossConnectionsClient.List.

type ExpressRouteCrossConnectionsClientListResult added in v0.3.0 

type ExpressRouteCrossConnectionsClientListResult struct {
	ExpressRouteCrossConnectionListResult
}

ExpressRouteCrossConnectionsClientListResult contains the result from method ExpressRouteCrossConnectionsClient.List.

type ExpressRouteCrossConnectionsClientListRoutesTablePoller added in v0.3.0 

type ExpressRouteCrossConnectionsClientListRoutesTablePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionsClientListRoutesTablePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCrossConnectionsClientListRoutesTablePoller) Done added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListRoutesTablePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCrossConnectionsClientListRoutesTablePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListRoutesTablePoller) FinalResponse(ctx context.Context) (ExpressRouteCrossConnectionsClientListRoutesTableResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCrossConnectionsClientListRoutesTableResponse will be returned.

func (*ExpressRouteCrossConnectionsClientListRoutesTablePoller) Poll added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListRoutesTablePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCrossConnectionsClientListRoutesTablePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListRoutesTablePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCrossConnectionsClientListRoutesTablePollerResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientListRoutesTablePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCrossConnectionsClientListRoutesTablePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientListRoutesTablePollerResponse contains the response from method ExpressRouteCrossConnectionsClient.ListRoutesTable.

func (ExpressRouteCrossConnectionsClientListRoutesTablePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCrossConnectionsClientListRoutesTablePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCrossConnectionsClientListRoutesTableResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCrossConnectionsClientListRoutesTablePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCrossConnectionsClientListRoutesTablePollerResponse) Resume(ctx context.Context, client *ExpressRouteCrossConnectionsClient, token string) error

Resume rehydrates a ExpressRouteCrossConnectionsClientListRoutesTablePollerResponse from the provided client and resume token.

type ExpressRouteCrossConnectionsClientListRoutesTableResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientListRoutesTableResponse struct {
	ExpressRouteCrossConnectionsClientListRoutesTableResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientListRoutesTableResponse contains the response from method ExpressRouteCrossConnectionsClient.ListRoutesTable.

type ExpressRouteCrossConnectionsClientListRoutesTableResult added in v0.3.0 

type ExpressRouteCrossConnectionsClientListRoutesTableResult struct {
	ExpressRouteCircuitsRoutesTableListResult
}

ExpressRouteCrossConnectionsClientListRoutesTableResult contains the result from method ExpressRouteCrossConnectionsClient.ListRoutesTable.

type ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller added in v0.3.0 

type ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller struct {
	// contains filtered or unexported fields
}

ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller) Done added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller) FinalResponse(ctx context.Context) (ExpressRouteCrossConnectionsClientListRoutesTableSummaryResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteCrossConnectionsClientListRoutesTableSummaryResponse will be returned.

func (*ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller) Poll added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteCrossConnectionsClientListRoutesTableSummaryPollerResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientListRoutesTableSummaryPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteCrossConnectionsClientListRoutesTableSummaryPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientListRoutesTableSummaryPollerResponse contains the response from method ExpressRouteCrossConnectionsClient.ListRoutesTableSummary.

func (ExpressRouteCrossConnectionsClientListRoutesTableSummaryPollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteCrossConnectionsClientListRoutesTableSummaryPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteCrossConnectionsClientListRoutesTableSummaryResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteCrossConnectionsClientListRoutesTableSummaryPollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteCrossConnectionsClientListRoutesTableSummaryPollerResponse) Resume(ctx context.Context, client *ExpressRouteCrossConnectionsClient, token string) error

Resume rehydrates a ExpressRouteCrossConnectionsClientListRoutesTableSummaryPollerResponse from the provided client and resume token.

type ExpressRouteCrossConnectionsClientListRoutesTableSummaryResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientListRoutesTableSummaryResponse struct {
	ExpressRouteCrossConnectionsClientListRoutesTableSummaryResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientListRoutesTableSummaryResponse contains the response from method ExpressRouteCrossConnectionsClient.ListRoutesTableSummary.

type ExpressRouteCrossConnectionsClientListRoutesTableSummaryResult added in v0.3.0 

type ExpressRouteCrossConnectionsClientListRoutesTableSummaryResult struct {
	ExpressRouteCrossConnectionsRoutesTableSummaryListResult
}

ExpressRouteCrossConnectionsClientListRoutesTableSummaryResult contains the result from method ExpressRouteCrossConnectionsClient.ListRoutesTableSummary.

type ExpressRouteCrossConnectionsClientUpdateTagsOptions added in v0.3.0 

type ExpressRouteCrossConnectionsClientUpdateTagsOptions struct {
}

ExpressRouteCrossConnectionsClientUpdateTagsOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.UpdateTags method.

type ExpressRouteCrossConnectionsClientUpdateTagsResponse added in v0.3.0 

type ExpressRouteCrossConnectionsClientUpdateTagsResponse struct {
	ExpressRouteCrossConnectionsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteCrossConnectionsClientUpdateTagsResponse contains the response from method ExpressRouteCrossConnectionsClient.UpdateTags.

type ExpressRouteCrossConnectionsClientUpdateTagsResult added in v0.3.0 

type ExpressRouteCrossConnectionsClientUpdateTagsResult struct {
	ExpressRouteCrossConnection
}

ExpressRouteCrossConnectionsClientUpdateTagsResult contains the result from method ExpressRouteCrossConnectionsClient.UpdateTags.

type ExpressRouteCrossConnectionsRoutesTableSummaryListResult 

type ExpressRouteCrossConnectionsRoutesTableSummaryListResult struct {
	// A list of the routes table.
	Value []*ExpressRouteCrossConnectionRoutesTableSummary `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ExpressRouteCrossConnectionsRoutesTableSummaryListResult - Response for ListRoutesTable associated with the Express Route Cross Connections.

func (ExpressRouteCrossConnectionsRoutesTableSummaryListResult) MarshalJSON 

func (e ExpressRouteCrossConnectionsRoutesTableSummaryListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCrossConnectionsRoutesTableSummaryListResult.

type ExpressRouteGateway 

type ExpressRouteGateway struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the express route gateway.
	Properties *ExpressRouteGatewayProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ExpressRouteGateway - ExpressRoute gateway resource.

func (ExpressRouteGateway) MarshalJSON 

func (e ExpressRouteGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteGateway.

type ExpressRouteGatewayList 

type ExpressRouteGatewayList struct {
	// List of ExpressRoute gateways.
	Value []*ExpressRouteGateway `json:"value,omitempty"`
}

ExpressRouteGatewayList - List of ExpressRoute gateways.

func (ExpressRouteGatewayList) MarshalJSON 

func (e ExpressRouteGatewayList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteGatewayList.

type ExpressRouteGatewayProperties 

type ExpressRouteGatewayProperties struct {
	// REQUIRED; The Virtual Hub where the ExpressRoute gateway is or will be deployed.
	VirtualHub *VirtualHubID `json:"virtualHub,omitempty"`

	// Configuration for auto scaling.
	AutoScaleConfiguration *ExpressRouteGatewayPropertiesAutoScaleConfiguration `json:"autoScaleConfiguration,omitempty"`

	// READ-ONLY; List of ExpressRoute connections to the ExpressRoute gateway.
	ExpressRouteConnections []*ExpressRouteConnection `json:"expressRouteConnections,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the express route gateway resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ExpressRouteGatewayProperties - ExpressRoute gateway resource properties.

func (ExpressRouteGatewayProperties) MarshalJSON 

func (e ExpressRouteGatewayProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteGatewayProperties.

type ExpressRouteGatewayPropertiesAutoScaleConfiguration 

type ExpressRouteGatewayPropertiesAutoScaleConfiguration struct {
	// Minimum and maximum number of scale units to deploy.
	Bounds *ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds `json:"bounds,omitempty"`
}

ExpressRouteGatewayPropertiesAutoScaleConfiguration - Configuration for auto scaling.

type ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds 

type ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds struct {
	// Maximum number of scale units deployed for ExpressRoute gateway.
	Max *int32 `json:"max,omitempty"`

	// Minimum number of scale units deployed for ExpressRoute gateway.
	Min *int32 `json:"min,omitempty"`
}

ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds - Minimum and maximum number of scale units to deploy.

type ExpressRouteGatewaysClient 

type ExpressRouteGatewaysClient struct {
	// contains filtered or unexported fields
}

ExpressRouteGatewaysClient contains the methods for the ExpressRouteGateways group. Don't use this type directly, use NewExpressRouteGatewaysClient() instead.

func NewExpressRouteGatewaysClient 

func NewExpressRouteGatewaysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRouteGatewaysClient

NewExpressRouteGatewaysClient creates a new instance of ExpressRouteGatewaysClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRouteGatewaysClient) BeginCreateOrUpdate 

func (client *ExpressRouteGatewaysClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, expressRouteGatewayName string, putExpressRouteGatewayParameters ExpressRouteGateway, options *ExpressRouteGatewaysClientBeginCreateOrUpdateOptions) (ExpressRouteGatewaysClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a ExpressRoute gateway in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRouteGatewayName - The name of the ExpressRoute gateway. putExpressRouteGatewayParameters - Parameters required in an ExpressRoute gateway PUT operation. options - ExpressRouteGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteGatewaysClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteGatewayCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<express-route-gateway-name>",
		armnetwork.ExpressRouteGateway{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.ExpressRouteGatewayProperties{
				AutoScaleConfiguration: &armnetwork.ExpressRouteGatewayPropertiesAutoScaleConfiguration{
					Bounds: &armnetwork.ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds{
						Min: to.Int32Ptr(3),
					},
				},
				VirtualHub: &armnetwork.VirtualHubID{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteGatewaysClientCreateOrUpdateResult)
}

Output:

func (*ExpressRouteGatewaysClient) BeginDelete 

func (client *ExpressRouteGatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, expressRouteGatewayName string, options *ExpressRouteGatewaysClientBeginDeleteOptions) (ExpressRouteGatewaysClientDeletePollerResponse, error)

BeginDelete - Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRouteGatewayName - The name of the ExpressRoute gateway. options - ExpressRouteGatewaysClientBeginDeleteOptions contains the optional parameters for the ExpressRouteGatewaysClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteGatewayDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<express-route-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ExpressRouteGatewaysClient) BeginUpdateTags 

func (client *ExpressRouteGatewaysClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, expressRouteGatewayName string, expressRouteGatewayParameters TagsObject, options *ExpressRouteGatewaysClientBeginUpdateTagsOptions) (ExpressRouteGatewaysClientUpdateTagsPollerResponse, error)

BeginUpdateTags - Updates express route gateway tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the ExpressRouteGateway. expressRouteGatewayName - The name of the gateway. expressRouteGatewayParameters - Parameters supplied to update a virtual wan express route gateway tags. options - ExpressRouteGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the ExpressRouteGatewaysClient.BeginUpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteGatewayUpdateTags.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdateTags(ctx,
		"<resource-group-name>",
		"<express-route-gateway-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteGatewaysClientUpdateTagsResult)
}

Output:

func (*ExpressRouteGatewaysClient) Get 

func (client *ExpressRouteGatewaysClient) Get(ctx context.Context, resourceGroupName string, expressRouteGatewayName string, options *ExpressRouteGatewaysClientGetOptions) (ExpressRouteGatewaysClientGetResponse, error)

Get - Fetches the details of a ExpressRoute gateway in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRouteGatewayName - The name of the ExpressRoute gateway. options - ExpressRouteGatewaysClientGetOptions contains the optional parameters for the ExpressRouteGatewaysClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteGatewayGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<express-route-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteGatewaysClientGetResult)
}

Output:

func (*ExpressRouteGatewaysClient) ListByResourceGroup 

func (client *ExpressRouteGatewaysClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, options *ExpressRouteGatewaysClientListByResourceGroupOptions) (ExpressRouteGatewaysClientListByResourceGroupResponse, error)

ListByResourceGroup - Lists ExpressRoute gateways in a given resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - ExpressRouteGatewaysClientListByResourceGroupOptions contains the optional parameters for the ExpressRouteGatewaysClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteGatewayListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.ListByResourceGroup(ctx,
		"<resource-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteGatewaysClientListByResourceGroupResult)
}

Output:

func (*ExpressRouteGatewaysClient) ListBySubscription 

func (client *ExpressRouteGatewaysClient) ListBySubscription(ctx context.Context, options *ExpressRouteGatewaysClientListBySubscriptionOptions) (ExpressRouteGatewaysClientListBySubscriptionResponse, error)

ListBySubscription - Lists ExpressRoute gateways under a given subscription. If the operation fails it returns an *azcore.ResponseError type. options - ExpressRouteGatewaysClientListBySubscriptionOptions contains the optional parameters for the ExpressRouteGatewaysClient.ListBySubscription method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteGatewayListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.ListBySubscription(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteGatewaysClientListBySubscriptionResult)
}

Output:

type ExpressRouteGatewaysClientBeginCreateOrUpdateOptions added in v0.3.0 

type ExpressRouteGatewaysClientBeginCreateOrUpdateOptions struct {
}

ExpressRouteGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteGatewaysClient.BeginCreateOrUpdate method.

type ExpressRouteGatewaysClientBeginDeleteOptions added in v0.3.0 

type ExpressRouteGatewaysClientBeginDeleteOptions struct {
}

ExpressRouteGatewaysClientBeginDeleteOptions contains the optional parameters for the ExpressRouteGatewaysClient.BeginDelete method.

type ExpressRouteGatewaysClientBeginUpdateTagsOptions added in v0.3.0 

type ExpressRouteGatewaysClientBeginUpdateTagsOptions struct {
}

ExpressRouteGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the ExpressRouteGatewaysClient.BeginUpdateTags method.

type ExpressRouteGatewaysClientCreateOrUpdatePoller added in v0.3.0 

type ExpressRouteGatewaysClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteGatewaysClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteGatewaysClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ExpressRouteGatewaysClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteGatewaysClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteGatewaysClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ExpressRouteGatewaysClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteGatewaysClientCreateOrUpdateResponse will be returned.

func (*ExpressRouteGatewaysClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ExpressRouteGatewaysClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteGatewaysClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteGatewaysClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteGatewaysClientCreateOrUpdatePollerResponse added in v0.3.0 

type ExpressRouteGatewaysClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteGatewaysClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteGatewaysClientCreateOrUpdatePollerResponse contains the response from method ExpressRouteGatewaysClient.CreateOrUpdate.

func (ExpressRouteGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteGatewaysClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteGatewaysClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteGatewaysClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ExpressRouteGatewaysClient, token string) error

Resume rehydrates a ExpressRouteGatewaysClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ExpressRouteGatewaysClientCreateOrUpdateResponse added in v0.3.0 

type ExpressRouteGatewaysClientCreateOrUpdateResponse struct {
	ExpressRouteGatewaysClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteGatewaysClientCreateOrUpdateResponse contains the response from method ExpressRouteGatewaysClient.CreateOrUpdate.

type ExpressRouteGatewaysClientCreateOrUpdateResult added in v0.3.0 

type ExpressRouteGatewaysClientCreateOrUpdateResult struct {
	ExpressRouteGateway
}

ExpressRouteGatewaysClientCreateOrUpdateResult contains the result from method ExpressRouteGatewaysClient.CreateOrUpdate.

type ExpressRouteGatewaysClientDeletePoller added in v0.3.0 

type ExpressRouteGatewaysClientDeletePoller struct {
	// contains filtered or unexported fields
}

ExpressRouteGatewaysClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteGatewaysClientDeletePoller) Done added in v0.3.0 

func (p *ExpressRouteGatewaysClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteGatewaysClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteGatewaysClientDeletePoller) FinalResponse(ctx context.Context) (ExpressRouteGatewaysClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteGatewaysClientDeleteResponse will be returned.

func (*ExpressRouteGatewaysClientDeletePoller) Poll added in v0.3.0 

func (p *ExpressRouteGatewaysClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteGatewaysClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteGatewaysClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteGatewaysClientDeletePollerResponse added in v0.3.0 

type ExpressRouteGatewaysClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteGatewaysClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteGatewaysClientDeletePollerResponse contains the response from method ExpressRouteGatewaysClient.Delete.

func (ExpressRouteGatewaysClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteGatewaysClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteGatewaysClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteGatewaysClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteGatewaysClientDeletePollerResponse) Resume(ctx context.Context, client *ExpressRouteGatewaysClient, token string) error

Resume rehydrates a ExpressRouteGatewaysClientDeletePollerResponse from the provided client and resume token.

type ExpressRouteGatewaysClientDeleteResponse added in v0.3.0 

type ExpressRouteGatewaysClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteGatewaysClientDeleteResponse contains the response from method ExpressRouteGatewaysClient.Delete.

type ExpressRouteGatewaysClientGetOptions added in v0.3.0 

type ExpressRouteGatewaysClientGetOptions struct {
}

ExpressRouteGatewaysClientGetOptions contains the optional parameters for the ExpressRouteGatewaysClient.Get method.

type ExpressRouteGatewaysClientGetResponse added in v0.3.0 

type ExpressRouteGatewaysClientGetResponse struct {
	ExpressRouteGatewaysClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteGatewaysClientGetResponse contains the response from method ExpressRouteGatewaysClient.Get.

type ExpressRouteGatewaysClientGetResult added in v0.3.0 

type ExpressRouteGatewaysClientGetResult struct {
	ExpressRouteGateway
}

ExpressRouteGatewaysClientGetResult contains the result from method ExpressRouteGatewaysClient.Get.

type ExpressRouteGatewaysClientListByResourceGroupOptions added in v0.3.0 

type ExpressRouteGatewaysClientListByResourceGroupOptions struct {
}

ExpressRouteGatewaysClientListByResourceGroupOptions contains the optional parameters for the ExpressRouteGatewaysClient.ListByResourceGroup method.

type ExpressRouteGatewaysClientListByResourceGroupResponse added in v0.3.0 

type ExpressRouteGatewaysClientListByResourceGroupResponse struct {
	ExpressRouteGatewaysClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteGatewaysClientListByResourceGroupResponse contains the response from method ExpressRouteGatewaysClient.ListByResourceGroup.

type ExpressRouteGatewaysClientListByResourceGroupResult added in v0.3.0 

type ExpressRouteGatewaysClientListByResourceGroupResult struct {
	ExpressRouteGatewayList
}

ExpressRouteGatewaysClientListByResourceGroupResult contains the result from method ExpressRouteGatewaysClient.ListByResourceGroup.

type ExpressRouteGatewaysClientListBySubscriptionOptions added in v0.3.0 

type ExpressRouteGatewaysClientListBySubscriptionOptions struct {
}

ExpressRouteGatewaysClientListBySubscriptionOptions contains the optional parameters for the ExpressRouteGatewaysClient.ListBySubscription method.

type ExpressRouteGatewaysClientListBySubscriptionResponse added in v0.3.0 

type ExpressRouteGatewaysClientListBySubscriptionResponse struct {
	ExpressRouteGatewaysClientListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteGatewaysClientListBySubscriptionResponse contains the response from method ExpressRouteGatewaysClient.ListBySubscription.

type ExpressRouteGatewaysClientListBySubscriptionResult added in v0.3.0 

type ExpressRouteGatewaysClientListBySubscriptionResult struct {
	ExpressRouteGatewayList
}

ExpressRouteGatewaysClientListBySubscriptionResult contains the result from method ExpressRouteGatewaysClient.ListBySubscription.

type ExpressRouteGatewaysClientUpdateTagsPoller added in v0.3.0 

type ExpressRouteGatewaysClientUpdateTagsPoller struct {
	// contains filtered or unexported fields
}

ExpressRouteGatewaysClientUpdateTagsPoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRouteGatewaysClientUpdateTagsPoller) Done added in v0.3.0 

func (p *ExpressRouteGatewaysClientUpdateTagsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRouteGatewaysClientUpdateTagsPoller) FinalResponse added in v0.3.0 

func (p *ExpressRouteGatewaysClientUpdateTagsPoller) FinalResponse(ctx context.Context) (ExpressRouteGatewaysClientUpdateTagsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRouteGatewaysClientUpdateTagsResponse will be returned.

func (*ExpressRouteGatewaysClientUpdateTagsPoller) Poll added in v0.3.0 

func (p *ExpressRouteGatewaysClientUpdateTagsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRouteGatewaysClientUpdateTagsPoller) ResumeToken added in v0.3.0 

func (p *ExpressRouteGatewaysClientUpdateTagsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRouteGatewaysClientUpdateTagsPollerResponse added in v0.3.0 

type ExpressRouteGatewaysClientUpdateTagsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRouteGatewaysClientUpdateTagsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteGatewaysClientUpdateTagsPollerResponse contains the response from method ExpressRouteGatewaysClient.UpdateTags.

func (ExpressRouteGatewaysClientUpdateTagsPollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRouteGatewaysClientUpdateTagsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRouteGatewaysClientUpdateTagsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRouteGatewaysClientUpdateTagsPollerResponse) Resume added in v0.3.0 

func (l *ExpressRouteGatewaysClientUpdateTagsPollerResponse) Resume(ctx context.Context, client *ExpressRouteGatewaysClient, token string) error

Resume rehydrates a ExpressRouteGatewaysClientUpdateTagsPollerResponse from the provided client and resume token.

type ExpressRouteGatewaysClientUpdateTagsResponse added in v0.3.0 

type ExpressRouteGatewaysClientUpdateTagsResponse struct {
	ExpressRouteGatewaysClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteGatewaysClientUpdateTagsResponse contains the response from method ExpressRouteGatewaysClient.UpdateTags.

type ExpressRouteGatewaysClientUpdateTagsResult added in v0.3.0 

type ExpressRouteGatewaysClientUpdateTagsResult struct {
	ExpressRouteGateway
}

ExpressRouteGatewaysClientUpdateTagsResult contains the result from method ExpressRouteGatewaysClient.UpdateTags. 

type ExpressRouteLink struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of child port resource that is unique among child port resources of the parent.
	Name *string `json:"name,omitempty"`

	// ExpressRouteLink properties.
	Properties *ExpressRouteLinkPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

ExpressRouteLink child resource definition.

type ExpressRouteLinkAdminState 

type ExpressRouteLinkAdminState string

ExpressRouteLinkAdminState - Administrative state of the physical port. 

const (
	ExpressRouteLinkAdminStateDisabled ExpressRouteLinkAdminState = "Disabled"
	ExpressRouteLinkAdminStateEnabled  ExpressRouteLinkAdminState = "Enabled"
)

func PossibleExpressRouteLinkAdminStateValues 

func PossibleExpressRouteLinkAdminStateValues() []ExpressRouteLinkAdminState

PossibleExpressRouteLinkAdminStateValues returns the possible values for the ExpressRouteLinkAdminState const type.

func (ExpressRouteLinkAdminState) ToPtr 

func (c ExpressRouteLinkAdminState) ToPtr() *ExpressRouteLinkAdminState

ToPtr returns a *ExpressRouteLinkAdminState pointing to the current value.

type ExpressRouteLinkConnectorType 

type ExpressRouteLinkConnectorType string

ExpressRouteLinkConnectorType - Physical fiber port type. 

const (
	ExpressRouteLinkConnectorTypeLC ExpressRouteLinkConnectorType = "LC"
	ExpressRouteLinkConnectorTypeSC ExpressRouteLinkConnectorType = "SC"
)

func PossibleExpressRouteLinkConnectorTypeValues 

func PossibleExpressRouteLinkConnectorTypeValues() []ExpressRouteLinkConnectorType

PossibleExpressRouteLinkConnectorTypeValues returns the possible values for the ExpressRouteLinkConnectorType const type.

func (ExpressRouteLinkConnectorType) ToPtr 

func (c ExpressRouteLinkConnectorType) ToPtr() *ExpressRouteLinkConnectorType

ToPtr returns a *ExpressRouteLinkConnectorType pointing to the current value.

type ExpressRouteLinkListResult 

type ExpressRouteLinkListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of ExpressRouteLink sub-resources.
	Value []*ExpressRouteLink `json:"value,omitempty"`
}

ExpressRouteLinkListResult - Response for ListExpressRouteLinks API service call.

func (ExpressRouteLinkListResult) MarshalJSON 

func (e ExpressRouteLinkListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteLinkListResult.

type ExpressRouteLinkMacSecCipher 

type ExpressRouteLinkMacSecCipher string

ExpressRouteLinkMacSecCipher - Mac security cipher. 

const (
	ExpressRouteLinkMacSecCipherGCMAES128    ExpressRouteLinkMacSecCipher = "GcmAes128"
	ExpressRouteLinkMacSecCipherGCMAES256    ExpressRouteLinkMacSecCipher = "GcmAes256"
	ExpressRouteLinkMacSecCipherGCMAesXpn128 ExpressRouteLinkMacSecCipher = "GcmAesXpn128"
	ExpressRouteLinkMacSecCipherGCMAesXpn256 ExpressRouteLinkMacSecCipher = "GcmAesXpn256"
)

func PossibleExpressRouteLinkMacSecCipherValues 

func PossibleExpressRouteLinkMacSecCipherValues() []ExpressRouteLinkMacSecCipher

PossibleExpressRouteLinkMacSecCipherValues returns the possible values for the ExpressRouteLinkMacSecCipher const type.

func (ExpressRouteLinkMacSecCipher) ToPtr 

func (c ExpressRouteLinkMacSecCipher) ToPtr() *ExpressRouteLinkMacSecCipher

ToPtr returns a *ExpressRouteLinkMacSecCipher pointing to the current value.

type ExpressRouteLinkMacSecConfig 

type ExpressRouteLinkMacSecConfig struct {
	// Keyvault Secret Identifier URL containing Mac security CAK key.
	CakSecretIdentifier *string `json:"cakSecretIdentifier,omitempty"`

	// Mac security cipher.
	Cipher *ExpressRouteLinkMacSecCipher `json:"cipher,omitempty"`

	// Keyvault Secret Identifier URL containing Mac security CKN key.
	CknSecretIdentifier *string `json:"cknSecretIdentifier,omitempty"`

	// Sci mode enabled/disabled.
	SciState *ExpressRouteLinkMacSecSciState `json:"sciState,omitempty"`
}

ExpressRouteLinkMacSecConfig - ExpressRouteLink Mac Security Configuration.

type ExpressRouteLinkMacSecSciState 

type ExpressRouteLinkMacSecSciState string

ExpressRouteLinkMacSecSciState - Sci mode enabled/disabled. 

const (
	ExpressRouteLinkMacSecSciStateDisabled ExpressRouteLinkMacSecSciState = "Disabled"
	ExpressRouteLinkMacSecSciStateEnabled  ExpressRouteLinkMacSecSciState = "Enabled"
)

func PossibleExpressRouteLinkMacSecSciStateValues 

func PossibleExpressRouteLinkMacSecSciStateValues() []ExpressRouteLinkMacSecSciState

PossibleExpressRouteLinkMacSecSciStateValues returns the possible values for the ExpressRouteLinkMacSecSciState const type.

func (ExpressRouteLinkMacSecSciState) ToPtr 

func (c ExpressRouteLinkMacSecSciState) ToPtr() *ExpressRouteLinkMacSecSciState

ToPtr returns a *ExpressRouteLinkMacSecSciState pointing to the current value.

type ExpressRouteLinkPropertiesFormat 

type ExpressRouteLinkPropertiesFormat struct {
	// Administrative state of the physical port.
	AdminState *ExpressRouteLinkAdminState `json:"adminState,omitempty"`

	// MacSec configuration.
	MacSecConfig *ExpressRouteLinkMacSecConfig `json:"macSecConfig,omitempty"`

	// READ-ONLY; Physical fiber port type.
	ConnectorType *ExpressRouteLinkConnectorType `json:"connectorType,omitempty" azure:"ro"`

	// READ-ONLY; Name of Azure router interface.
	InterfaceName *string `json:"interfaceName,omitempty" azure:"ro"`

	// READ-ONLY; Mapping between physical port to patch panel port.
	PatchPanelID *string `json:"patchPanelId,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the express route link resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Mapping of physical patch panel to rack.
	RackID *string `json:"rackId,omitempty" azure:"ro"`

	// READ-ONLY; Name of Azure router associated with physical port.
	RouterName *string `json:"routerName,omitempty" azure:"ro"`
}

ExpressRouteLinkPropertiesFormat - Properties specific to ExpressRouteLink resources.

type ExpressRouteLinksClient 

type ExpressRouteLinksClient struct {
	// contains filtered or unexported fields
}

ExpressRouteLinksClient contains the methods for the ExpressRouteLinks group. Don't use this type directly, use NewExpressRouteLinksClient() instead.

func NewExpressRouteLinksClient 

func NewExpressRouteLinksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRouteLinksClient

NewExpressRouteLinksClient creates a new instance of ExpressRouteLinksClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRouteLinksClient) Get 

func (client *ExpressRouteLinksClient) Get(ctx context.Context, resourceGroupName string, expressRoutePortName string, linkName string, options *ExpressRouteLinksClientGetOptions) (ExpressRouteLinksClientGetResponse, error)

Get - Retrieves the specified ExpressRouteLink resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRoutePortName - The name of the ExpressRoutePort resource. linkName - The name of the ExpressRouteLink resource. options - ExpressRouteLinksClientGetOptions contains the optional parameters for the ExpressRouteLinksClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteLinkGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteLinksClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<express-route-port-name>",
		"<link-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRouteLinksClientGetResult)
}

Output:

func (*ExpressRouteLinksClient) List 

func (client *ExpressRouteLinksClient) List(resourceGroupName string, expressRoutePortName string, options *ExpressRouteLinksClientListOptions) *ExpressRouteLinksClientListPager

List - Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRoutePortName - The name of the ExpressRoutePort resource. options - ExpressRouteLinksClientListOptions contains the optional parameters for the ExpressRouteLinksClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteLinkList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteLinksClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<express-route-port-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ExpressRouteLinksClientGetOptions added in v0.3.0 

type ExpressRouteLinksClientGetOptions struct {
}

ExpressRouteLinksClientGetOptions contains the optional parameters for the ExpressRouteLinksClient.Get method.

type ExpressRouteLinksClientGetResponse added in v0.3.0 

type ExpressRouteLinksClientGetResponse struct {
	ExpressRouteLinksClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteLinksClientGetResponse contains the response from method ExpressRouteLinksClient.Get.

type ExpressRouteLinksClientGetResult added in v0.3.0 

type ExpressRouteLinksClientGetResult struct {
	ExpressRouteLink
}

ExpressRouteLinksClientGetResult contains the result from method ExpressRouteLinksClient.Get.

type ExpressRouteLinksClientListOptions added in v0.3.0 

type ExpressRouteLinksClientListOptions struct {
}

ExpressRouteLinksClientListOptions contains the optional parameters for the ExpressRouteLinksClient.List method.

type ExpressRouteLinksClientListPager added in v0.3.0 

type ExpressRouteLinksClientListPager struct {
	// contains filtered or unexported fields
}

ExpressRouteLinksClientListPager provides operations for iterating over paged responses.

func (*ExpressRouteLinksClientListPager) Err added in v0.3.0 

func (p *ExpressRouteLinksClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRouteLinksClientListPager) NextPage added in v0.3.0 

func (p *ExpressRouteLinksClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRouteLinksClientListPager) PageResponse added in v0.3.0 

func (p *ExpressRouteLinksClientListPager) PageResponse() ExpressRouteLinksClientListResponse

PageResponse returns the current ExpressRouteLinksClientListResponse page.

type ExpressRouteLinksClientListResponse added in v0.3.0 

type ExpressRouteLinksClientListResponse struct {
	ExpressRouteLinksClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteLinksClientListResponse contains the response from method ExpressRouteLinksClient.List.

type ExpressRouteLinksClientListResult added in v0.3.0 

type ExpressRouteLinksClientListResult struct {
	ExpressRouteLinkListResult
}

ExpressRouteLinksClientListResult contains the result from method ExpressRouteLinksClient.List.

type ExpressRoutePeeringState 

type ExpressRoutePeeringState string

ExpressRoutePeeringState - The state of peering. 

const (
	ExpressRoutePeeringStateDisabled ExpressRoutePeeringState = "Disabled"
	ExpressRoutePeeringStateEnabled  ExpressRoutePeeringState = "Enabled"
)

func PossibleExpressRoutePeeringStateValues 

func PossibleExpressRoutePeeringStateValues() []ExpressRoutePeeringState

PossibleExpressRoutePeeringStateValues returns the possible values for the ExpressRoutePeeringState const type.

func (ExpressRoutePeeringState) ToPtr 

func (c ExpressRoutePeeringState) ToPtr() *ExpressRoutePeeringState

ToPtr returns a *ExpressRoutePeeringState pointing to the current value.

type ExpressRoutePeeringType 

type ExpressRoutePeeringType string

ExpressRoutePeeringType - The peering type. 

const (
	ExpressRoutePeeringTypeAzurePrivatePeering ExpressRoutePeeringType = "AzurePrivatePeering"
	ExpressRoutePeeringTypeAzurePublicPeering  ExpressRoutePeeringType = "AzurePublicPeering"
	ExpressRoutePeeringTypeMicrosoftPeering    ExpressRoutePeeringType = "MicrosoftPeering"
)

func PossibleExpressRoutePeeringTypeValues 

func PossibleExpressRoutePeeringTypeValues() []ExpressRoutePeeringType

PossibleExpressRoutePeeringTypeValues returns the possible values for the ExpressRoutePeeringType const type.

func (ExpressRoutePeeringType) ToPtr 

func (c ExpressRoutePeeringType) ToPtr() *ExpressRoutePeeringType

ToPtr returns a *ExpressRoutePeeringType pointing to the current value.

type ExpressRoutePort 

type ExpressRoutePort struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The identity of ExpressRoutePort, if configured.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// ExpressRoutePort properties.
	Properties *ExpressRoutePortPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ExpressRoutePort resource definition.

func (ExpressRoutePort) MarshalJSON 

func (e ExpressRoutePort) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePort.

type ExpressRoutePortListResult 

type ExpressRoutePortListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of ExpressRoutePort resources.
	Value []*ExpressRoutePort `json:"value,omitempty"`
}

ExpressRoutePortListResult - Response for ListExpressRoutePorts API service call.

func (ExpressRoutePortListResult) MarshalJSON 

func (e ExpressRoutePortListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePortListResult.

type ExpressRoutePortPropertiesFormat 

type ExpressRoutePortPropertiesFormat struct {
	// Bandwidth of procured ports in Gbps.
	BandwidthInGbps *int32 `json:"bandwidthInGbps,omitempty"`

	// Encapsulation method on physical ports.
	Encapsulation *ExpressRoutePortsEncapsulation `json:"encapsulation,omitempty"`

	// The set of physical links of the ExpressRoutePort resource.
	Links []*ExpressRouteLink `json:"links,omitempty"`

	// The name of the peering location that the ExpressRoutePort is mapped to physically.
	PeeringLocation *string `json:"peeringLocation,omitempty"`

	// READ-ONLY; Date of the physical port allocation to be used in Letter of Authorization.
	AllocationDate *string `json:"allocationDate,omitempty" azure:"ro"`

	// READ-ONLY; Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
	Circuits []*SubResource `json:"circuits,omitempty" azure:"ro"`

	// READ-ONLY; Ether type of the physical port.
	EtherType *string `json:"etherType,omitempty" azure:"ro"`

	// READ-ONLY; Maximum transmission unit of the physical port pair(s).
	Mtu *string `json:"mtu,omitempty" azure:"ro"`

	// READ-ONLY; Aggregate Gbps of associated circuit bandwidths.
	ProvisionedBandwidthInGbps *float32 `json:"provisionedBandwidthInGbps,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the express route port resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the express route port resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

ExpressRoutePortPropertiesFormat - Properties specific to ExpressRoutePort resources.

func (ExpressRoutePortPropertiesFormat) MarshalJSON 

func (e ExpressRoutePortPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePortPropertiesFormat.

type ExpressRoutePortsClient 

type ExpressRoutePortsClient struct {
	// contains filtered or unexported fields
}

ExpressRoutePortsClient contains the methods for the ExpressRoutePorts group. Don't use this type directly, use NewExpressRoutePortsClient() instead.

func NewExpressRoutePortsClient 

func NewExpressRoutePortsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRoutePortsClient

NewExpressRoutePortsClient creates a new instance of ExpressRoutePortsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRoutePortsClient) BeginCreateOrUpdate 

func (client *ExpressRoutePortsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, expressRoutePortName string, parameters ExpressRoutePort, options *ExpressRoutePortsClientBeginCreateOrUpdateOptions) (ExpressRoutePortsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified ExpressRoutePort resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRoutePortName - The name of the ExpressRoutePort resource. parameters - Parameters supplied to the create ExpressRoutePort operation. options - ExpressRoutePortsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRoutePortsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRoutePortCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRoutePortsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<express-route-port-name>",
		armnetwork.ExpressRoutePort{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.ExpressRoutePortPropertiesFormat{
				BandwidthInGbps: to.Int32Ptr(100),
				Encapsulation:   armnetwork.ExpressRoutePortsEncapsulation("QinQ").ToPtr(),
				PeeringLocation: to.StringPtr("<peering-location>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRoutePortsClientCreateOrUpdateResult)
}

Output:

func (*ExpressRoutePortsClient) BeginDelete 

func (client *ExpressRoutePortsClient) BeginDelete(ctx context.Context, resourceGroupName string, expressRoutePortName string, options *ExpressRoutePortsClientBeginDeleteOptions) (ExpressRoutePortsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified ExpressRoutePort resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRoutePortName - The name of the ExpressRoutePort resource. options - ExpressRoutePortsClientBeginDeleteOptions contains the optional parameters for the ExpressRoutePortsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRoutePortDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRoutePortsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<express-route-port-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ExpressRoutePortsClient) GenerateLOA 

func (client *ExpressRoutePortsClient) GenerateLOA(ctx context.Context, resourceGroupName string, expressRoutePortName string, request GenerateExpressRoutePortsLOARequest, options *ExpressRoutePortsClientGenerateLOAOptions) (ExpressRoutePortsClientGenerateLOAResponse, error)

GenerateLOA - Generate a letter of authorization for the requested ExpressRoutePort resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRoutePortName - The name of ExpressRoutePort. request - Request parameters supplied to generate a letter of authorization. options - ExpressRoutePortsClientGenerateLOAOptions contains the optional parameters for the ExpressRoutePortsClient.GenerateLOA method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/GenerateExpressRoutePortsLOA.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRoutePortsClient("<subscription-id>", cred, nil)
	res, err := client.GenerateLOA(ctx,
		"<resource-group-name>",
		"<express-route-port-name>",
		armnetwork.GenerateExpressRoutePortsLOARequest{
			CustomerName: to.StringPtr("<customer-name>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRoutePortsClientGenerateLOAResult)
}

Output:

func (*ExpressRoutePortsClient) Get 

func (client *ExpressRoutePortsClient) Get(ctx context.Context, resourceGroupName string, expressRoutePortName string, options *ExpressRoutePortsClientGetOptions) (ExpressRoutePortsClientGetResponse, error)

Get - Retrieves the requested ExpressRoutePort resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRoutePortName - The name of ExpressRoutePort. options - ExpressRoutePortsClientGetOptions contains the optional parameters for the ExpressRoutePortsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRoutePortGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRoutePortsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<express-route-port-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRoutePortsClientGetResult)
}

Output:

func (*ExpressRoutePortsClient) List 

func (client *ExpressRoutePortsClient) List(options *ExpressRoutePortsClientListOptions) *ExpressRoutePortsClientListPager

List - List all the ExpressRoutePort resources in the specified subscription. If the operation fails it returns an *azcore.ResponseError type. options - ExpressRoutePortsClientListOptions contains the optional parameters for the ExpressRoutePortsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRoutePortList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRoutePortsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ExpressRoutePortsClient) ListByResourceGroup 

func (client *ExpressRoutePortsClient) ListByResourceGroup(resourceGroupName string, options *ExpressRoutePortsClientListByResourceGroupOptions) *ExpressRoutePortsClientListByResourceGroupPager

ListByResourceGroup - List all the ExpressRoutePort resources in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - ExpressRoutePortsClientListByResourceGroupOptions contains the optional parameters for the ExpressRoutePortsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRoutePortListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRoutePortsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ExpressRoutePortsClient) UpdateTags 

func (client *ExpressRoutePortsClient) UpdateTags(ctx context.Context, resourceGroupName string, expressRoutePortName string, parameters TagsObject, options *ExpressRoutePortsClientUpdateTagsOptions) (ExpressRoutePortsClientUpdateTagsResponse, error)

UpdateTags - Update ExpressRoutePort tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. expressRoutePortName - The name of the ExpressRoutePort resource. parameters - Parameters supplied to update ExpressRoutePort resource tags. options - ExpressRoutePortsClientUpdateTagsOptions contains the optional parameters for the ExpressRoutePortsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRoutePortUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRoutePortsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<express-route-port-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRoutePortsClientUpdateTagsResult)
}

Output:

type ExpressRoutePortsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ExpressRoutePortsClientBeginCreateOrUpdateOptions struct {
}

ExpressRoutePortsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRoutePortsClient.BeginCreateOrUpdate method.

type ExpressRoutePortsClientBeginDeleteOptions added in v0.3.0 

type ExpressRoutePortsClientBeginDeleteOptions struct {
}

ExpressRoutePortsClientBeginDeleteOptions contains the optional parameters for the ExpressRoutePortsClient.BeginDelete method.

type ExpressRoutePortsClientCreateOrUpdatePoller added in v0.3.0 

type ExpressRoutePortsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ExpressRoutePortsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRoutePortsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ExpressRoutePortsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRoutePortsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ExpressRoutePortsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ExpressRoutePortsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRoutePortsClientCreateOrUpdateResponse will be returned.

func (*ExpressRoutePortsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ExpressRoutePortsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRoutePortsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ExpressRoutePortsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRoutePortsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ExpressRoutePortsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRoutePortsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsClientCreateOrUpdatePollerResponse contains the response from method ExpressRoutePortsClient.CreateOrUpdate.

func (ExpressRoutePortsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRoutePortsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRoutePortsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRoutePortsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ExpressRoutePortsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ExpressRoutePortsClient, token string) error

Resume rehydrates a ExpressRoutePortsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ExpressRoutePortsClientCreateOrUpdateResponse added in v0.3.0 

type ExpressRoutePortsClientCreateOrUpdateResponse struct {
	ExpressRoutePortsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsClientCreateOrUpdateResponse contains the response from method ExpressRoutePortsClient.CreateOrUpdate.

type ExpressRoutePortsClientCreateOrUpdateResult added in v0.3.0 

type ExpressRoutePortsClientCreateOrUpdateResult struct {
	ExpressRoutePort
}

ExpressRoutePortsClientCreateOrUpdateResult contains the result from method ExpressRoutePortsClient.CreateOrUpdate.

type ExpressRoutePortsClientDeletePoller added in v0.3.0 

type ExpressRoutePortsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ExpressRoutePortsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ExpressRoutePortsClientDeletePoller) Done added in v0.3.0 

func (p *ExpressRoutePortsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExpressRoutePortsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ExpressRoutePortsClientDeletePoller) FinalResponse(ctx context.Context) (ExpressRoutePortsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExpressRoutePortsClientDeleteResponse will be returned.

func (*ExpressRoutePortsClientDeletePoller) Poll added in v0.3.0 

func (p *ExpressRoutePortsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExpressRoutePortsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ExpressRoutePortsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExpressRoutePortsClientDeletePollerResponse added in v0.3.0 

type ExpressRoutePortsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExpressRoutePortsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsClientDeletePollerResponse contains the response from method ExpressRoutePortsClient.Delete.

func (ExpressRoutePortsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ExpressRoutePortsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExpressRoutePortsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExpressRoutePortsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ExpressRoutePortsClientDeletePollerResponse) Resume(ctx context.Context, client *ExpressRoutePortsClient, token string) error

Resume rehydrates a ExpressRoutePortsClientDeletePollerResponse from the provided client and resume token.

type ExpressRoutePortsClientDeleteResponse added in v0.3.0 

type ExpressRoutePortsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsClientDeleteResponse contains the response from method ExpressRoutePortsClient.Delete.

type ExpressRoutePortsClientGenerateLOAOptions added in v0.3.0 

type ExpressRoutePortsClientGenerateLOAOptions struct {
}

ExpressRoutePortsClientGenerateLOAOptions contains the optional parameters for the ExpressRoutePortsClient.GenerateLOA method.

type ExpressRoutePortsClientGenerateLOAResponse added in v0.3.0 

type ExpressRoutePortsClientGenerateLOAResponse struct {
	ExpressRoutePortsClientGenerateLOAResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsClientGenerateLOAResponse contains the response from method ExpressRoutePortsClient.GenerateLOA.

type ExpressRoutePortsClientGenerateLOAResult added in v0.3.0 

type ExpressRoutePortsClientGenerateLOAResult struct {
	GenerateExpressRoutePortsLOAResult
}

ExpressRoutePortsClientGenerateLOAResult contains the result from method ExpressRoutePortsClient.GenerateLOA.

type ExpressRoutePortsClientGetOptions added in v0.3.0 

type ExpressRoutePortsClientGetOptions struct {
}

ExpressRoutePortsClientGetOptions contains the optional parameters for the ExpressRoutePortsClient.Get method.

type ExpressRoutePortsClientGetResponse added in v0.3.0 

type ExpressRoutePortsClientGetResponse struct {
	ExpressRoutePortsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsClientGetResponse contains the response from method ExpressRoutePortsClient.Get.

type ExpressRoutePortsClientGetResult added in v0.3.0 

type ExpressRoutePortsClientGetResult struct {
	ExpressRoutePort
}

ExpressRoutePortsClientGetResult contains the result from method ExpressRoutePortsClient.Get.

type ExpressRoutePortsClientListByResourceGroupOptions added in v0.3.0 

type ExpressRoutePortsClientListByResourceGroupOptions struct {
}

ExpressRoutePortsClientListByResourceGroupOptions contains the optional parameters for the ExpressRoutePortsClient.ListByResourceGroup method.

type ExpressRoutePortsClientListByResourceGroupPager added in v0.3.0 

type ExpressRoutePortsClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

ExpressRoutePortsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*ExpressRoutePortsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *ExpressRoutePortsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRoutePortsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *ExpressRoutePortsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRoutePortsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *ExpressRoutePortsClientListByResourceGroupPager) PageResponse() ExpressRoutePortsClientListByResourceGroupResponse

PageResponse returns the current ExpressRoutePortsClientListByResourceGroupResponse page.

type ExpressRoutePortsClientListByResourceGroupResponse added in v0.3.0 

type ExpressRoutePortsClientListByResourceGroupResponse struct {
	ExpressRoutePortsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsClientListByResourceGroupResponse contains the response from method ExpressRoutePortsClient.ListByResourceGroup.

type ExpressRoutePortsClientListByResourceGroupResult added in v0.3.0 

type ExpressRoutePortsClientListByResourceGroupResult struct {
	ExpressRoutePortListResult
}

ExpressRoutePortsClientListByResourceGroupResult contains the result from method ExpressRoutePortsClient.ListByResourceGroup.

type ExpressRoutePortsClientListOptions added in v0.3.0 

type ExpressRoutePortsClientListOptions struct {
}

ExpressRoutePortsClientListOptions contains the optional parameters for the ExpressRoutePortsClient.List method.

type ExpressRoutePortsClientListPager added in v0.3.0 

type ExpressRoutePortsClientListPager struct {
	// contains filtered or unexported fields
}

ExpressRoutePortsClientListPager provides operations for iterating over paged responses.

func (*ExpressRoutePortsClientListPager) Err added in v0.3.0 

func (p *ExpressRoutePortsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRoutePortsClientListPager) NextPage added in v0.3.0 

func (p *ExpressRoutePortsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRoutePortsClientListPager) PageResponse added in v0.3.0 

func (p *ExpressRoutePortsClientListPager) PageResponse() ExpressRoutePortsClientListResponse

PageResponse returns the current ExpressRoutePortsClientListResponse page.

type ExpressRoutePortsClientListResponse added in v0.3.0 

type ExpressRoutePortsClientListResponse struct {
	ExpressRoutePortsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsClientListResponse contains the response from method ExpressRoutePortsClient.List.

type ExpressRoutePortsClientListResult added in v0.3.0 

type ExpressRoutePortsClientListResult struct {
	ExpressRoutePortListResult
}

ExpressRoutePortsClientListResult contains the result from method ExpressRoutePortsClient.List.

type ExpressRoutePortsClientUpdateTagsOptions added in v0.3.0 

type ExpressRoutePortsClientUpdateTagsOptions struct {
}

ExpressRoutePortsClientUpdateTagsOptions contains the optional parameters for the ExpressRoutePortsClient.UpdateTags method.

type ExpressRoutePortsClientUpdateTagsResponse added in v0.3.0 

type ExpressRoutePortsClientUpdateTagsResponse struct {
	ExpressRoutePortsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsClientUpdateTagsResponse contains the response from method ExpressRoutePortsClient.UpdateTags.

type ExpressRoutePortsClientUpdateTagsResult added in v0.3.0 

type ExpressRoutePortsClientUpdateTagsResult struct {
	ExpressRoutePort
}

ExpressRoutePortsClientUpdateTagsResult contains the result from method ExpressRoutePortsClient.UpdateTags.

type ExpressRoutePortsEncapsulation 

type ExpressRoutePortsEncapsulation string

ExpressRoutePortsEncapsulation - Encapsulation method on physical ports. 

const (
	ExpressRoutePortsEncapsulationDot1Q ExpressRoutePortsEncapsulation = "Dot1Q"
	ExpressRoutePortsEncapsulationQinQ  ExpressRoutePortsEncapsulation = "QinQ"
)

func PossibleExpressRoutePortsEncapsulationValues 

func PossibleExpressRoutePortsEncapsulationValues() []ExpressRoutePortsEncapsulation

PossibleExpressRoutePortsEncapsulationValues returns the possible values for the ExpressRoutePortsEncapsulation const type.

func (ExpressRoutePortsEncapsulation) ToPtr 

func (c ExpressRoutePortsEncapsulation) ToPtr() *ExpressRoutePortsEncapsulation

ToPtr returns a *ExpressRoutePortsEncapsulation pointing to the current value.

type ExpressRoutePortsLocation 

type ExpressRoutePortsLocation struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// ExpressRoutePort peering location properties.
	Properties *ExpressRoutePortsLocationPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ExpressRoutePortsLocation - Definition of the ExpressRoutePorts peering location resource.

func (ExpressRoutePortsLocation) MarshalJSON 

func (e ExpressRoutePortsLocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePortsLocation.

type ExpressRoutePortsLocationBandwidths 

type ExpressRoutePortsLocationBandwidths struct {
	// READ-ONLY; Bandwidth descriptive name.
	OfferName *string `json:"offerName,omitempty" azure:"ro"`

	// READ-ONLY; Bandwidth value in Gbps.
	ValueInGbps *int32 `json:"valueInGbps,omitempty" azure:"ro"`
}

ExpressRoutePortsLocationBandwidths - Real-time inventory of available ExpressRoute port bandwidths.

type ExpressRoutePortsLocationListResult 

type ExpressRoutePortsLocationListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of all ExpressRoutePort peering locations.
	Value []*ExpressRoutePortsLocation `json:"value,omitempty"`
}

ExpressRoutePortsLocationListResult - Response for ListExpressRoutePortsLocations API service call.

func (ExpressRoutePortsLocationListResult) MarshalJSON 

func (e ExpressRoutePortsLocationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePortsLocationListResult.

type ExpressRoutePortsLocationPropertiesFormat 

type ExpressRoutePortsLocationPropertiesFormat struct {
	// The inventory of available ExpressRoutePort bandwidths.
	AvailableBandwidths []*ExpressRoutePortsLocationBandwidths `json:"availableBandwidths,omitempty"`

	// READ-ONLY; Address of peering location.
	Address *string `json:"address,omitempty" azure:"ro"`

	// READ-ONLY; Contact details of peering locations.
	Contact *string `json:"contact,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the express route port location resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ExpressRoutePortsLocationPropertiesFormat - Properties specific to ExpressRoutePorts peering location resources.

func (ExpressRoutePortsLocationPropertiesFormat) MarshalJSON 

func (e ExpressRoutePortsLocationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePortsLocationPropertiesFormat.

type ExpressRoutePortsLocationsClient 

type ExpressRoutePortsLocationsClient struct {
	// contains filtered or unexported fields
}

ExpressRoutePortsLocationsClient contains the methods for the ExpressRoutePortsLocations group. Don't use this type directly, use NewExpressRoutePortsLocationsClient() instead.

func NewExpressRoutePortsLocationsClient 

func NewExpressRoutePortsLocationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRoutePortsLocationsClient

NewExpressRoutePortsLocationsClient creates a new instance of ExpressRoutePortsLocationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRoutePortsLocationsClient) Get 

func (client *ExpressRoutePortsLocationsClient) Get(ctx context.Context, locationName string, options *ExpressRoutePortsLocationsClientGetOptions) (ExpressRoutePortsLocationsClientGetResponse, error)

Get - Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location. If the operation fails it returns an *azcore.ResponseError type. locationName - Name of the requested ExpressRoutePort peering location. options - ExpressRoutePortsLocationsClientGetOptions contains the optional parameters for the ExpressRoutePortsLocationsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRoutePortsLocationGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRoutePortsLocationsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<location-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExpressRoutePortsLocationsClientGetResult)
}

Output:

func (*ExpressRoutePortsLocationsClient) List 

func (client *ExpressRoutePortsLocationsClient) List(options *ExpressRoutePortsLocationsClientListOptions) *ExpressRoutePortsLocationsClientListPager

List - Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location. If the operation fails it returns an *azcore.ResponseError type. options - ExpressRoutePortsLocationsClientListOptions contains the optional parameters for the ExpressRoutePortsLocationsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRoutePortsLocationList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRoutePortsLocationsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ExpressRoutePortsLocationsClientGetOptions added in v0.3.0 

type ExpressRoutePortsLocationsClientGetOptions struct {
}

ExpressRoutePortsLocationsClientGetOptions contains the optional parameters for the ExpressRoutePortsLocationsClient.Get method.

type ExpressRoutePortsLocationsClientGetResponse added in v0.3.0 

type ExpressRoutePortsLocationsClientGetResponse struct {
	ExpressRoutePortsLocationsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsLocationsClientGetResponse contains the response from method ExpressRoutePortsLocationsClient.Get.

type ExpressRoutePortsLocationsClientGetResult added in v0.3.0 

type ExpressRoutePortsLocationsClientGetResult struct {
	ExpressRoutePortsLocation
}

ExpressRoutePortsLocationsClientGetResult contains the result from method ExpressRoutePortsLocationsClient.Get.

type ExpressRoutePortsLocationsClientListOptions added in v0.3.0 

type ExpressRoutePortsLocationsClientListOptions struct {
}

ExpressRoutePortsLocationsClientListOptions contains the optional parameters for the ExpressRoutePortsLocationsClient.List method.

type ExpressRoutePortsLocationsClientListPager added in v0.3.0 

type ExpressRoutePortsLocationsClientListPager struct {
	// contains filtered or unexported fields
}

ExpressRoutePortsLocationsClientListPager provides operations for iterating over paged responses.

func (*ExpressRoutePortsLocationsClientListPager) Err added in v0.3.0 

func (p *ExpressRoutePortsLocationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRoutePortsLocationsClientListPager) NextPage added in v0.3.0 

func (p *ExpressRoutePortsLocationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRoutePortsLocationsClientListPager) PageResponse added in v0.3.0 

func (p *ExpressRoutePortsLocationsClientListPager) PageResponse() ExpressRoutePortsLocationsClientListResponse

PageResponse returns the current ExpressRoutePortsLocationsClientListResponse page.

type ExpressRoutePortsLocationsClientListResponse added in v0.3.0 

type ExpressRoutePortsLocationsClientListResponse struct {
	ExpressRoutePortsLocationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRoutePortsLocationsClientListResponse contains the response from method ExpressRoutePortsLocationsClient.List.

type ExpressRoutePortsLocationsClientListResult added in v0.3.0 

type ExpressRoutePortsLocationsClientListResult struct {
	ExpressRoutePortsLocationListResult
}

ExpressRoutePortsLocationsClientListResult contains the result from method ExpressRoutePortsLocationsClient.List.

type ExpressRouteServiceProvider 

type ExpressRouteServiceProvider struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the express route service provider.
	Properties *ExpressRouteServiceProviderPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ExpressRouteServiceProvider - A ExpressRouteResourceProvider object.

func (ExpressRouteServiceProvider) MarshalJSON 

func (e ExpressRouteServiceProvider) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteServiceProvider.

type ExpressRouteServiceProviderBandwidthsOffered 

type ExpressRouteServiceProviderBandwidthsOffered struct {
	// The OfferName.
	OfferName *string `json:"offerName,omitempty"`

	// The ValueInMbps.
	ValueInMbps *int32 `json:"valueInMbps,omitempty"`
}

ExpressRouteServiceProviderBandwidthsOffered - Contains bandwidths offered in ExpressRouteServiceProvider resources.

type ExpressRouteServiceProviderListResult 

type ExpressRouteServiceProviderListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of ExpressRouteResourceProvider resources.
	Value []*ExpressRouteServiceProvider `json:"value,omitempty"`
}

ExpressRouteServiceProviderListResult - Response for the ListExpressRouteServiceProvider API service call.

func (ExpressRouteServiceProviderListResult) MarshalJSON 

func (e ExpressRouteServiceProviderListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteServiceProviderListResult.

type ExpressRouteServiceProviderPropertiesFormat 

type ExpressRouteServiceProviderPropertiesFormat struct {
	// A list of bandwidths offered.
	BandwidthsOffered []*ExpressRouteServiceProviderBandwidthsOffered `json:"bandwidthsOffered,omitempty"`

	// A list of peering locations.
	PeeringLocations []*string `json:"peeringLocations,omitempty"`

	// READ-ONLY; The provisioning state of the express route service provider resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ExpressRouteServiceProviderPropertiesFormat - Properties of ExpressRouteServiceProvider.

func (ExpressRouteServiceProviderPropertiesFormat) MarshalJSON 

func (e ExpressRouteServiceProviderPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteServiceProviderPropertiesFormat.

type ExpressRouteServiceProvidersClient 

type ExpressRouteServiceProvidersClient struct {
	// contains filtered or unexported fields
}

ExpressRouteServiceProvidersClient contains the methods for the ExpressRouteServiceProviders group. Don't use this type directly, use NewExpressRouteServiceProvidersClient() instead.

func NewExpressRouteServiceProvidersClient 

func NewExpressRouteServiceProvidersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExpressRouteServiceProvidersClient

NewExpressRouteServiceProvidersClient creates a new instance of ExpressRouteServiceProvidersClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExpressRouteServiceProvidersClient) List 

func (client *ExpressRouteServiceProvidersClient) List(options *ExpressRouteServiceProvidersClientListOptions) *ExpressRouteServiceProvidersClientListPager

List - Gets all the available express route service providers. If the operation fails it returns an *azcore.ResponseError type. options - ExpressRouteServiceProvidersClientListOptions contains the optional parameters for the ExpressRouteServiceProvidersClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ExpressRouteProviderList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewExpressRouteServiceProvidersClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ExpressRouteServiceProvidersClientListOptions added in v0.3.0 

type ExpressRouteServiceProvidersClientListOptions struct {
}

ExpressRouteServiceProvidersClientListOptions contains the optional parameters for the ExpressRouteServiceProvidersClient.List method.

type ExpressRouteServiceProvidersClientListPager added in v0.3.0 

type ExpressRouteServiceProvidersClientListPager struct {
	// contains filtered or unexported fields
}

ExpressRouteServiceProvidersClientListPager provides operations for iterating over paged responses.

func (*ExpressRouteServiceProvidersClientListPager) Err added in v0.3.0 

func (p *ExpressRouteServiceProvidersClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExpressRouteServiceProvidersClientListPager) NextPage added in v0.3.0 

func (p *ExpressRouteServiceProvidersClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExpressRouteServiceProvidersClientListPager) PageResponse added in v0.3.0 

func (p *ExpressRouteServiceProvidersClientListPager) PageResponse() ExpressRouteServiceProvidersClientListResponse

PageResponse returns the current ExpressRouteServiceProvidersClientListResponse page.

type ExpressRouteServiceProvidersClientListResponse added in v0.3.0 

type ExpressRouteServiceProvidersClientListResponse struct {
	ExpressRouteServiceProvidersClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExpressRouteServiceProvidersClientListResponse contains the response from method ExpressRouteServiceProvidersClient.List.

type ExpressRouteServiceProvidersClientListResult added in v0.3.0 

type ExpressRouteServiceProvidersClientListResult struct {
	ExpressRouteServiceProviderListResult
}

ExpressRouteServiceProvidersClientListResult contains the result from method ExpressRouteServiceProvidersClient.List.

type ExtendedLocation 

type ExtendedLocation struct {
	// The name of the extended location.
	Name *string `json:"name,omitempty"`

	// The type of the extended location.
	Type *ExtendedLocationTypes `json:"type,omitempty"`
}

ExtendedLocation complex type.

type ExtendedLocationTypes 

type ExtendedLocationTypes string

ExtendedLocationTypes - The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources. 

const (
	ExtendedLocationTypesEdgeZone ExtendedLocationTypes = "EdgeZone"
)

func PossibleExtendedLocationTypesValues 

func PossibleExtendedLocationTypesValues() []ExtendedLocationTypes

PossibleExtendedLocationTypesValues returns the possible values for the ExtendedLocationTypes const type.

func (ExtendedLocationTypes) ToPtr 

func (c ExtendedLocationTypes) ToPtr() *ExtendedLocationTypes

ToPtr returns a *ExtendedLocationTypes pointing to the current value.

type FilterItems added in v0.2.0 

type FilterItems struct {
	// The name of the field we would like to filter
	Field *string `json:"field,omitempty"`

	// List of values to filter the current field by
	Values []*string `json:"values,omitempty"`
}

FilterItems - Will contain the filter name and values to operate on

func (FilterItems) MarshalJSON added in v0.2.0 

func (f FilterItems) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FilterItems.

type FirewallPoliciesClient 

type FirewallPoliciesClient struct {
	// contains filtered or unexported fields
}

FirewallPoliciesClient contains the methods for the FirewallPolicies group. Don't use this type directly, use NewFirewallPoliciesClient() instead.

func NewFirewallPoliciesClient 

func NewFirewallPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *FirewallPoliciesClient

NewFirewallPoliciesClient creates a new instance of FirewallPoliciesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*FirewallPoliciesClient) BeginCreateOrUpdate 

func (client *FirewallPoliciesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, firewallPolicyName string, parameters FirewallPolicy, options *FirewallPoliciesClientBeginCreateOrUpdateOptions) (FirewallPoliciesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified Firewall Policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. parameters - Parameters supplied to the create or update Firewall Policy operation. options - FirewallPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the FirewallPoliciesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPoliciesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		armnetwork.FirewallPolicy{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.FirewallPolicyPropertiesFormat{
				DNSSettings: &armnetwork.DNSSettings{
					EnableProxy:                 to.BoolPtr(true),
					RequireProxyForNetworkRules: to.BoolPtr(false),
					Servers: []*string{
						to.StringPtr("30.3.4.5")},
				},
				ExplicitProxySettings: &armnetwork.ExplicitProxySettings{
					EnableExplicitProxy: to.BoolPtr(true),
					HTTPPort:            to.Int32Ptr(8087),
					HTTPSPort:           to.Int32Ptr(8087),
					PacFile:             to.StringPtr("<pac-file>"),
					PacFilePort:         to.Int32Ptr(8087),
				},
				Insights: &armnetwork.FirewallPolicyInsights{
					IsEnabled: to.BoolPtr(true),
					LogAnalyticsResources: &armnetwork.FirewallPolicyLogAnalyticsResources{
						DefaultWorkspaceID: &armnetwork.SubResource{
							ID: to.StringPtr("<id>"),
						},
						Workspaces: []*armnetwork.FirewallPolicyLogAnalyticsWorkspace{
							{
								Region: to.StringPtr("<region>"),
								WorkspaceID: &armnetwork.SubResource{
									ID: to.StringPtr("<id>"),
								},
							},
							{
								Region: to.StringPtr("<region>"),
								WorkspaceID: &armnetwork.SubResource{
									ID: to.StringPtr("<id>"),
								},
							}},
					},
					RetentionDays: to.Int32Ptr(100),
				},
				IntrusionDetection: &armnetwork.FirewallPolicyIntrusionDetection{
					Configuration: &armnetwork.FirewallPolicyIntrusionDetectionConfiguration{
						BypassTrafficSettings: []*armnetwork.FirewallPolicyIntrusionDetectionBypassTrafficSpecifications{
							{
								Name:        to.StringPtr("<name>"),
								Description: to.StringPtr("<description>"),
								DestinationAddresses: []*string{
									to.StringPtr("5.6.7.8")},
								DestinationPorts: []*string{
									to.StringPtr("*")},
								SourceAddresses: []*string{
									to.StringPtr("1.2.3.4")},
								Protocol: armnetwork.FirewallPolicyIntrusionDetectionProtocol("TCP").ToPtr(),
							}},
						SignatureOverrides: []*armnetwork.FirewallPolicyIntrusionDetectionSignatureSpecification{
							{
								ID:   to.StringPtr("<id>"),
								Mode: armnetwork.FirewallPolicyIntrusionDetectionStateType("Deny").ToPtr(),
							}},
					},
					Mode: armnetwork.FirewallPolicyIntrusionDetectionStateType("Alert").ToPtr(),
				},
				SKU: &armnetwork.FirewallPolicySKU{
					Tier: armnetwork.FirewallPolicySKUTier("Premium").ToPtr(),
				},
				Snat: &armnetwork.FirewallPolicySNAT{
					PrivateRanges: []*string{
						to.StringPtr("IANAPrivateRanges")},
				},
				SQL: &armnetwork.FirewallPolicySQL{
					AllowSQLRedirect: to.BoolPtr(true),
				},
				ThreatIntelMode: armnetwork.AzureFirewallThreatIntelMode("Alert").ToPtr(),
				ThreatIntelWhitelist: &armnetwork.FirewallPolicyThreatIntelWhitelist{
					Fqdns: []*string{
						to.StringPtr("*.microsoft.com")},
					IPAddresses: []*string{
						to.StringPtr("20.3.4.5")},
				},
				TransportSecurity: &armnetwork.FirewallPolicyTransportSecurity{
					CertificateAuthority: &armnetwork.FirewallPolicyCertificateAuthority{
						Name:             to.StringPtr("<name>"),
						KeyVaultSecretID: to.StringPtr("<key-vault-secret-id>"),
					},
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FirewallPoliciesClientCreateOrUpdateResult)
}

Output:

func (*FirewallPoliciesClient) BeginDelete 

func (client *FirewallPoliciesClient) BeginDelete(ctx context.Context, resourceGroupName string, firewallPolicyName string, options *FirewallPoliciesClientBeginDeleteOptions) (FirewallPoliciesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified Firewall Policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. options - FirewallPoliciesClientBeginDeleteOptions contains the optional parameters for the FirewallPoliciesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPoliciesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*FirewallPoliciesClient) Get 

func (client *FirewallPoliciesClient) Get(ctx context.Context, resourceGroupName string, firewallPolicyName string, options *FirewallPoliciesClientGetOptions) (FirewallPoliciesClientGetResponse, error)

Get - Gets the specified Firewall Policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. options - FirewallPoliciesClientGetOptions contains the optional parameters for the FirewallPoliciesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPoliciesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		&armnetwork.FirewallPoliciesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FirewallPoliciesClientGetResult)
}

Output:

func (*FirewallPoliciesClient) List 

func (client *FirewallPoliciesClient) List(resourceGroupName string, options *FirewallPoliciesClientListOptions) *FirewallPoliciesClientListPager

List - Lists all Firewall Policies in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - FirewallPoliciesClientListOptions contains the optional parameters for the FirewallPoliciesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPoliciesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*FirewallPoliciesClient) ListAll 

func (client *FirewallPoliciesClient) ListAll(options *FirewallPoliciesClientListAllOptions) *FirewallPoliciesClientListAllPager

ListAll - Gets all the Firewall Policies in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - FirewallPoliciesClientListAllOptions contains the optional parameters for the FirewallPoliciesClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPoliciesClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type FirewallPoliciesClientBeginCreateOrUpdateOptions added in v0.3.0 

type FirewallPoliciesClientBeginCreateOrUpdateOptions struct {
}

FirewallPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the FirewallPoliciesClient.BeginCreateOrUpdate method.

type FirewallPoliciesClientBeginDeleteOptions added in v0.3.0 

type FirewallPoliciesClientBeginDeleteOptions struct {
}

FirewallPoliciesClientBeginDeleteOptions contains the optional parameters for the FirewallPoliciesClient.BeginDelete method.

type FirewallPoliciesClientCreateOrUpdatePoller added in v0.3.0 

type FirewallPoliciesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

FirewallPoliciesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*FirewallPoliciesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *FirewallPoliciesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*FirewallPoliciesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *FirewallPoliciesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (FirewallPoliciesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final FirewallPoliciesClientCreateOrUpdateResponse will be returned.

func (*FirewallPoliciesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *FirewallPoliciesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*FirewallPoliciesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *FirewallPoliciesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type FirewallPoliciesClientCreateOrUpdatePollerResponse added in v0.3.0 

type FirewallPoliciesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *FirewallPoliciesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPoliciesClientCreateOrUpdatePollerResponse contains the response from method FirewallPoliciesClient.CreateOrUpdate.

func (FirewallPoliciesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l FirewallPoliciesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (FirewallPoliciesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*FirewallPoliciesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *FirewallPoliciesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *FirewallPoliciesClient, token string) error

Resume rehydrates a FirewallPoliciesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type FirewallPoliciesClientCreateOrUpdateResponse added in v0.3.0 

type FirewallPoliciesClientCreateOrUpdateResponse struct {
	FirewallPoliciesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPoliciesClientCreateOrUpdateResponse contains the response from method FirewallPoliciesClient.CreateOrUpdate.

type FirewallPoliciesClientCreateOrUpdateResult added in v0.3.0 

type FirewallPoliciesClientCreateOrUpdateResult struct {
	FirewallPolicy
}

FirewallPoliciesClientCreateOrUpdateResult contains the result from method FirewallPoliciesClient.CreateOrUpdate.

type FirewallPoliciesClientDeletePoller added in v0.3.0 

type FirewallPoliciesClientDeletePoller struct {
	// contains filtered or unexported fields
}

FirewallPoliciesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*FirewallPoliciesClientDeletePoller) Done added in v0.3.0 

func (p *FirewallPoliciesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*FirewallPoliciesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *FirewallPoliciesClientDeletePoller) FinalResponse(ctx context.Context) (FirewallPoliciesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final FirewallPoliciesClientDeleteResponse will be returned.

func (*FirewallPoliciesClientDeletePoller) Poll added in v0.3.0 

func (p *FirewallPoliciesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*FirewallPoliciesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *FirewallPoliciesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type FirewallPoliciesClientDeletePollerResponse added in v0.3.0 

type FirewallPoliciesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *FirewallPoliciesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPoliciesClientDeletePollerResponse contains the response from method FirewallPoliciesClient.Delete.

func (FirewallPoliciesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l FirewallPoliciesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (FirewallPoliciesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*FirewallPoliciesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *FirewallPoliciesClientDeletePollerResponse) Resume(ctx context.Context, client *FirewallPoliciesClient, token string) error

Resume rehydrates a FirewallPoliciesClientDeletePollerResponse from the provided client and resume token.

type FirewallPoliciesClientDeleteResponse added in v0.3.0 

type FirewallPoliciesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPoliciesClientDeleteResponse contains the response from method FirewallPoliciesClient.Delete.

type FirewallPoliciesClientGetOptions added in v0.3.0 

type FirewallPoliciesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

FirewallPoliciesClientGetOptions contains the optional parameters for the FirewallPoliciesClient.Get method.

type FirewallPoliciesClientGetResponse added in v0.3.0 

type FirewallPoliciesClientGetResponse struct {
	FirewallPoliciesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPoliciesClientGetResponse contains the response from method FirewallPoliciesClient.Get.

type FirewallPoliciesClientGetResult added in v0.3.0 

type FirewallPoliciesClientGetResult struct {
	FirewallPolicy
}

FirewallPoliciesClientGetResult contains the result from method FirewallPoliciesClient.Get.

type FirewallPoliciesClientListAllOptions added in v0.3.0 

type FirewallPoliciesClientListAllOptions struct {
}

FirewallPoliciesClientListAllOptions contains the optional parameters for the FirewallPoliciesClient.ListAll method.

type FirewallPoliciesClientListAllPager added in v0.3.0 

type FirewallPoliciesClientListAllPager struct {
	// contains filtered or unexported fields
}

FirewallPoliciesClientListAllPager provides operations for iterating over paged responses.

func (*FirewallPoliciesClientListAllPager) Err added in v0.3.0 

func (p *FirewallPoliciesClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*FirewallPoliciesClientListAllPager) NextPage added in v0.3.0 

func (p *FirewallPoliciesClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*FirewallPoliciesClientListAllPager) PageResponse added in v0.3.0 

func (p *FirewallPoliciesClientListAllPager) PageResponse() FirewallPoliciesClientListAllResponse

PageResponse returns the current FirewallPoliciesClientListAllResponse page.

type FirewallPoliciesClientListAllResponse added in v0.3.0 

type FirewallPoliciesClientListAllResponse struct {
	FirewallPoliciesClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPoliciesClientListAllResponse contains the response from method FirewallPoliciesClient.ListAll.

type FirewallPoliciesClientListAllResult added in v0.3.0 

type FirewallPoliciesClientListAllResult struct {
	FirewallPolicyListResult
}

FirewallPoliciesClientListAllResult contains the result from method FirewallPoliciesClient.ListAll.

type FirewallPoliciesClientListOptions added in v0.3.0 

type FirewallPoliciesClientListOptions struct {
}

FirewallPoliciesClientListOptions contains the optional parameters for the FirewallPoliciesClient.List method.

type FirewallPoliciesClientListPager added in v0.3.0 

type FirewallPoliciesClientListPager struct {
	// contains filtered or unexported fields
}

FirewallPoliciesClientListPager provides operations for iterating over paged responses.

func (*FirewallPoliciesClientListPager) Err added in v0.3.0 

func (p *FirewallPoliciesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*FirewallPoliciesClientListPager) NextPage added in v0.3.0 

func (p *FirewallPoliciesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*FirewallPoliciesClientListPager) PageResponse added in v0.3.0 

func (p *FirewallPoliciesClientListPager) PageResponse() FirewallPoliciesClientListResponse

PageResponse returns the current FirewallPoliciesClientListResponse page.

type FirewallPoliciesClientListResponse added in v0.3.0 

type FirewallPoliciesClientListResponse struct {
	FirewallPoliciesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPoliciesClientListResponse contains the response from method FirewallPoliciesClient.List.

type FirewallPoliciesClientListResult added in v0.3.0 

type FirewallPoliciesClientListResult struct {
	FirewallPolicyListResult
}

FirewallPoliciesClientListResult contains the result from method FirewallPoliciesClient.List.

type FirewallPolicy 

type FirewallPolicy struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The identity of the firewall policy.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the firewall policy.
	Properties *FirewallPolicyPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

FirewallPolicy Resource.

func (FirewallPolicy) MarshalJSON 

func (f FirewallPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicy.

type FirewallPolicyCertificateAuthority 

type FirewallPolicyCertificateAuthority struct {
	// Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.
	KeyVaultSecretID *string `json:"keyVaultSecretId,omitempty"`

	// Name of the CA certificate.
	Name *string `json:"name,omitempty"`
}

FirewallPolicyCertificateAuthority - Trusted Root certificates properties for tls.

type FirewallPolicyFilterRuleCollection 

type FirewallPolicyFilterRuleCollection struct {
	// REQUIRED; The type of the rule collection.
	RuleCollectionType *FirewallPolicyRuleCollectionType `json:"ruleCollectionType,omitempty"`

	// The action type of a Filter rule collection.
	Action *FirewallPolicyFilterRuleCollectionAction `json:"action,omitempty"`

	// The name of the rule collection.
	Name *string `json:"name,omitempty"`

	// Priority of the Firewall Policy Rule Collection resource.
	Priority *int32 `json:"priority,omitempty"`

	// List of rules included in a rule collection.
	Rules []FirewallPolicyRuleClassification `json:"rules,omitempty"`
}

FirewallPolicyFilterRuleCollection - Firewall Policy Filter Rule Collection.

func (*FirewallPolicyFilterRuleCollection) GetFirewallPolicyRuleCollection added in v0.3.0 

func (f *FirewallPolicyFilterRuleCollection) GetFirewallPolicyRuleCollection() *FirewallPolicyRuleCollection

GetFirewallPolicyRuleCollection implements the FirewallPolicyRuleCollectionClassification interface for type FirewallPolicyFilterRuleCollection.

func (FirewallPolicyFilterRuleCollection) MarshalJSON 

func (f FirewallPolicyFilterRuleCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyFilterRuleCollection.

func (*FirewallPolicyFilterRuleCollection) UnmarshalJSON 

func (f *FirewallPolicyFilterRuleCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyFilterRuleCollection.

type FirewallPolicyFilterRuleCollectionAction 

type FirewallPolicyFilterRuleCollectionAction struct {
	// The type of action.
	Type *FirewallPolicyFilterRuleCollectionActionType `json:"type,omitempty"`
}

FirewallPolicyFilterRuleCollectionAction - Properties of the FirewallPolicyFilterRuleCollectionAction.

type FirewallPolicyFilterRuleCollectionActionType 

type FirewallPolicyFilterRuleCollectionActionType string

FirewallPolicyFilterRuleCollectionActionType - The action type of a rule. 

const (
	FirewallPolicyFilterRuleCollectionActionTypeAllow FirewallPolicyFilterRuleCollectionActionType = "Allow"
	FirewallPolicyFilterRuleCollectionActionTypeDeny  FirewallPolicyFilterRuleCollectionActionType = "Deny"
)

func PossibleFirewallPolicyFilterRuleCollectionActionTypeValues 

func PossibleFirewallPolicyFilterRuleCollectionActionTypeValues() []FirewallPolicyFilterRuleCollectionActionType

PossibleFirewallPolicyFilterRuleCollectionActionTypeValues returns the possible values for the FirewallPolicyFilterRuleCollectionActionType const type.

func (FirewallPolicyFilterRuleCollectionActionType) ToPtr 

func (c FirewallPolicyFilterRuleCollectionActionType) ToPtr() *FirewallPolicyFilterRuleCollectionActionType

ToPtr returns a *FirewallPolicyFilterRuleCollectionActionType pointing to the current value.

type FirewallPolicyIdpsSignaturesClient added in v0.2.0 

type FirewallPolicyIdpsSignaturesClient struct {
	// contains filtered or unexported fields
}

FirewallPolicyIdpsSignaturesClient contains the methods for the FirewallPolicyIdpsSignatures group. Don't use this type directly, use NewFirewallPolicyIdpsSignaturesClient() instead.

func NewFirewallPolicyIdpsSignaturesClient added in v0.2.0 

func NewFirewallPolicyIdpsSignaturesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *FirewallPolicyIdpsSignaturesClient

NewFirewallPolicyIdpsSignaturesClient creates a new instance of FirewallPolicyIdpsSignaturesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*FirewallPolicyIdpsSignaturesClient) List added in v0.2.0 

func (client *FirewallPolicyIdpsSignaturesClient) List(ctx context.Context, resourceGroupName string, firewallPolicyName string, parameters IDPSQueryObject, options *FirewallPolicyIdpsSignaturesClientListOptions) (FirewallPolicyIdpsSignaturesClientListResponse, error)

List - Retrieves the current status of IDPS signatures for the relevant policy If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. options - FirewallPolicyIdpsSignaturesClientListOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyQuerySignatureOverrides.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPolicyIdpsSignaturesClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		armnetwork.IDPSQueryObject{
			Filters: []*armnetwork.FilterItems{
				{
					Field: to.StringPtr("<field>"),
					Values: []*string{
						to.StringPtr("Deny")},
				}},
			OrderBy: &armnetwork.OrderBy{
				Field: to.StringPtr("<field>"),
				Order: armnetwork.OrderByOrder("Ascending").ToPtr(),
			},
			ResultsPerPage: to.Int32Ptr(20),
			Search:         to.StringPtr("<search>"),
			Skip:           to.Int32Ptr(0),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FirewallPolicyIdpsSignaturesClientListResult)
}

Output:

type FirewallPolicyIdpsSignaturesClientListOptions added in v0.3.0 

type FirewallPolicyIdpsSignaturesClientListOptions struct {
}

FirewallPolicyIdpsSignaturesClientListOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesClient.List method.

type FirewallPolicyIdpsSignaturesClientListResponse added in v0.3.0 

type FirewallPolicyIdpsSignaturesClientListResponse struct {
	FirewallPolicyIdpsSignaturesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyIdpsSignaturesClientListResponse contains the response from method FirewallPolicyIdpsSignaturesClient.List.

type FirewallPolicyIdpsSignaturesClientListResult added in v0.3.0 

type FirewallPolicyIdpsSignaturesClientListResult struct {
	QueryResults
}

FirewallPolicyIdpsSignaturesClientListResult contains the result from method FirewallPolicyIdpsSignaturesClient.List.

type FirewallPolicyIdpsSignaturesFilterValuesClient added in v0.2.0 

type FirewallPolicyIdpsSignaturesFilterValuesClient struct {
	// contains filtered or unexported fields
}

FirewallPolicyIdpsSignaturesFilterValuesClient contains the methods for the FirewallPolicyIdpsSignaturesFilterValues group. Don't use this type directly, use NewFirewallPolicyIdpsSignaturesFilterValuesClient() instead.

func NewFirewallPolicyIdpsSignaturesFilterValuesClient added in v0.2.0 

func NewFirewallPolicyIdpsSignaturesFilterValuesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *FirewallPolicyIdpsSignaturesFilterValuesClient

NewFirewallPolicyIdpsSignaturesFilterValuesClient creates a new instance of FirewallPolicyIdpsSignaturesFilterValuesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*FirewallPolicyIdpsSignaturesFilterValuesClient) List added in v0.2.0 

func (client *FirewallPolicyIdpsSignaturesFilterValuesClient) List(ctx context.Context, resourceGroupName string, firewallPolicyName string, parameters SignatureOverridesFilterValuesQuery, options *FirewallPolicyIdpsSignaturesFilterValuesClientListOptions) (FirewallPolicyIdpsSignaturesFilterValuesClientListResponse, error)

List - Retrieves the current filter values for the signatures overrides If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. options - FirewallPolicyIdpsSignaturesFilterValuesClientListOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesFilterValuesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyQuerySignatureOverridesFilterValues.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPolicyIdpsSignaturesFilterValuesClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		armnetwork.SignatureOverridesFilterValuesQuery{
			FilterName: to.StringPtr("<filter-name>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FirewallPolicyIdpsSignaturesFilterValuesClientListResult)
}

Output:

type FirewallPolicyIdpsSignaturesFilterValuesClientListOptions added in v0.3.0 

type FirewallPolicyIdpsSignaturesFilterValuesClientListOptions struct {
}

FirewallPolicyIdpsSignaturesFilterValuesClientListOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesFilterValuesClient.List method.

type FirewallPolicyIdpsSignaturesFilterValuesClientListResponse added in v0.3.0 

type FirewallPolicyIdpsSignaturesFilterValuesClientListResponse struct {
	FirewallPolicyIdpsSignaturesFilterValuesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyIdpsSignaturesFilterValuesClientListResponse contains the response from method FirewallPolicyIdpsSignaturesFilterValuesClient.List.

type FirewallPolicyIdpsSignaturesFilterValuesClientListResult added in v0.3.0 

type FirewallPolicyIdpsSignaturesFilterValuesClientListResult struct {
	SignatureOverridesFilterValuesResponse
}

FirewallPolicyIdpsSignaturesFilterValuesClientListResult contains the result from method FirewallPolicyIdpsSignaturesFilterValuesClient.List.

type FirewallPolicyIdpsSignaturesOverridesClient added in v0.2.0 

type FirewallPolicyIdpsSignaturesOverridesClient struct {
	// contains filtered or unexported fields
}

FirewallPolicyIdpsSignaturesOverridesClient contains the methods for the FirewallPolicyIdpsSignaturesOverrides group. Don't use this type directly, use NewFirewallPolicyIdpsSignaturesOverridesClient() instead.

func NewFirewallPolicyIdpsSignaturesOverridesClient added in v0.2.0 

func NewFirewallPolicyIdpsSignaturesOverridesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *FirewallPolicyIdpsSignaturesOverridesClient

NewFirewallPolicyIdpsSignaturesOverridesClient creates a new instance of FirewallPolicyIdpsSignaturesOverridesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*FirewallPolicyIdpsSignaturesOverridesClient) Get added in v0.2.0 

func (client *FirewallPolicyIdpsSignaturesOverridesClient) Get(ctx context.Context, resourceGroupName string, firewallPolicyName string, options *FirewallPolicyIdpsSignaturesOverridesClientGetOptions) (FirewallPolicyIdpsSignaturesOverridesClientGetResponse, error)

Get - Returns all signatures overrides for a specific policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. options - FirewallPolicyIdpsSignaturesOverridesClientGetOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicySignatureOverridesGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPolicyIdpsSignaturesOverridesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FirewallPolicyIdpsSignaturesOverridesClientGetResult)
}

Output:

func (*FirewallPolicyIdpsSignaturesOverridesClient) List added in v0.2.0 

func (client *FirewallPolicyIdpsSignaturesOverridesClient) List(ctx context.Context, resourceGroupName string, firewallPolicyName string, options *FirewallPolicyIdpsSignaturesOverridesClientListOptions) (FirewallPolicyIdpsSignaturesOverridesClientListResponse, error)

List - Returns all signatures overrides objects for a specific policy as a list containing a single value. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. options - FirewallPolicyIdpsSignaturesOverridesClientListOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicySignatureOverridesList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPolicyIdpsSignaturesOverridesClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FirewallPolicyIdpsSignaturesOverridesClientListResult)
}

Output:

func (*FirewallPolicyIdpsSignaturesOverridesClient) Patch added in v0.2.0 

func (client *FirewallPolicyIdpsSignaturesOverridesClient) Patch(ctx context.Context, resourceGroupName string, firewallPolicyName string, parameters SignaturesOverrides, options *FirewallPolicyIdpsSignaturesOverridesClientPatchOptions) (FirewallPolicyIdpsSignaturesOverridesClientPatchResponse, error)

Patch - Will update the status of policy's signature overrides for IDPS If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. parameters - Will contain all properties of the object to put options - FirewallPolicyIdpsSignaturesOverridesClientPatchOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.Patch method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicySignatureOverridesPatch.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPolicyIdpsSignaturesOverridesClient("<subscription-id>", cred, nil)
	res, err := client.Patch(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		armnetwork.SignaturesOverrides{
			Name: to.StringPtr("<name>"),
			Type: to.StringPtr("<type>"),
			ID:   to.StringPtr("<id>"),
			Properties: &armnetwork.SignaturesOverridesProperties{
				Signatures: map[string]*string{
					"2000105": to.StringPtr("Off"),
					"2000106": to.StringPtr("Deny"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FirewallPolicyIdpsSignaturesOverridesClientPatchResult)
}

Output:

func (*FirewallPolicyIdpsSignaturesOverridesClient) Put added in v0.2.0 

func (client *FirewallPolicyIdpsSignaturesOverridesClient) Put(ctx context.Context, resourceGroupName string, firewallPolicyName string, parameters SignaturesOverrides, options *FirewallPolicyIdpsSignaturesOverridesClientPutOptions) (FirewallPolicyIdpsSignaturesOverridesClientPutResponse, error)

Put - Will override/create a new signature overrides for the policy's IDPS If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. parameters - Will contain all properties of the object to put options - FirewallPolicyIdpsSignaturesOverridesClientPutOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.Put method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicySignatureOverridesPut.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPolicyIdpsSignaturesOverridesClient("<subscription-id>", cred, nil)
	res, err := client.Put(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		armnetwork.SignaturesOverrides{
			Name: to.StringPtr("<name>"),
			Type: to.StringPtr("<type>"),
			ID:   to.StringPtr("<id>"),
			Properties: &armnetwork.SignaturesOverridesProperties{
				Signatures: map[string]*string{
					"2000105": to.StringPtr("Off"),
					"2000106": to.StringPtr("Deny"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FirewallPolicyIdpsSignaturesOverridesClientPutResult)
}

Output:

type FirewallPolicyIdpsSignaturesOverridesClientGetOptions added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientGetOptions struct {
}

FirewallPolicyIdpsSignaturesOverridesClientGetOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.Get method.

type FirewallPolicyIdpsSignaturesOverridesClientGetResponse added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientGetResponse struct {
	FirewallPolicyIdpsSignaturesOverridesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyIdpsSignaturesOverridesClientGetResponse contains the response from method FirewallPolicyIdpsSignaturesOverridesClient.Get.

type FirewallPolicyIdpsSignaturesOverridesClientGetResult added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientGetResult struct {
	SignaturesOverrides
}

FirewallPolicyIdpsSignaturesOverridesClientGetResult contains the result from method FirewallPolicyIdpsSignaturesOverridesClient.Get.

type FirewallPolicyIdpsSignaturesOverridesClientListOptions added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientListOptions struct {
}

FirewallPolicyIdpsSignaturesOverridesClientListOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.List method.

type FirewallPolicyIdpsSignaturesOverridesClientListResponse added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientListResponse struct {
	FirewallPolicyIdpsSignaturesOverridesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyIdpsSignaturesOverridesClientListResponse contains the response from method FirewallPolicyIdpsSignaturesOverridesClient.List.

type FirewallPolicyIdpsSignaturesOverridesClientListResult added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientListResult struct {
	SignaturesOverridesList
}

FirewallPolicyIdpsSignaturesOverridesClientListResult contains the result from method FirewallPolicyIdpsSignaturesOverridesClient.List.

type FirewallPolicyIdpsSignaturesOverridesClientPatchOptions added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientPatchOptions struct {
}

FirewallPolicyIdpsSignaturesOverridesClientPatchOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.Patch method.

type FirewallPolicyIdpsSignaturesOverridesClientPatchResponse added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientPatchResponse struct {
	FirewallPolicyIdpsSignaturesOverridesClientPatchResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyIdpsSignaturesOverridesClientPatchResponse contains the response from method FirewallPolicyIdpsSignaturesOverridesClient.Patch.

type FirewallPolicyIdpsSignaturesOverridesClientPatchResult added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientPatchResult struct {
	SignaturesOverrides
}

FirewallPolicyIdpsSignaturesOverridesClientPatchResult contains the result from method FirewallPolicyIdpsSignaturesOverridesClient.Patch.

type FirewallPolicyIdpsSignaturesOverridesClientPutOptions added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientPutOptions struct {
}

FirewallPolicyIdpsSignaturesOverridesClientPutOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.Put method.

type FirewallPolicyIdpsSignaturesOverridesClientPutResponse added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientPutResponse struct {
	FirewallPolicyIdpsSignaturesOverridesClientPutResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyIdpsSignaturesOverridesClientPutResponse contains the response from method FirewallPolicyIdpsSignaturesOverridesClient.Put.

type FirewallPolicyIdpsSignaturesOverridesClientPutResult added in v0.3.0 

type FirewallPolicyIdpsSignaturesOverridesClientPutResult struct {
	SignaturesOverrides
}

FirewallPolicyIdpsSignaturesOverridesClientPutResult contains the result from method FirewallPolicyIdpsSignaturesOverridesClient.Put.

type FirewallPolicyInsights 

type FirewallPolicyInsights struct {
	// A flag to indicate if the insights are enabled on the policy.
	IsEnabled *bool `json:"isEnabled,omitempty"`

	// Workspaces needed to configure the Firewall Policy Insights.
	LogAnalyticsResources *FirewallPolicyLogAnalyticsResources `json:"logAnalyticsResources,omitempty"`

	// Number of days the insights should be enabled on the policy.
	RetentionDays *int32 `json:"retentionDays,omitempty"`
}

FirewallPolicyInsights - Firewall Policy Insights.

type FirewallPolicyIntrusionDetection 

type FirewallPolicyIntrusionDetection struct {
	// Intrusion detection configuration properties.
	Configuration *FirewallPolicyIntrusionDetectionConfiguration `json:"configuration,omitempty"`

	// Intrusion detection general state.
	Mode *FirewallPolicyIntrusionDetectionStateType `json:"mode,omitempty"`
}

FirewallPolicyIntrusionDetection - Configuration for intrusion detection mode and rules.

type FirewallPolicyIntrusionDetectionBypassTrafficSpecifications 

type FirewallPolicyIntrusionDetectionBypassTrafficSpecifications struct {
	// Description of the bypass traffic rule.
	Description *string `json:"description,omitempty"`

	// List of destination IP addresses or ranges for this rule.
	DestinationAddresses []*string `json:"destinationAddresses,omitempty"`

	// List of destination IpGroups for this rule.
	DestinationIPGroups []*string `json:"destinationIpGroups,omitempty"`

	// List of destination ports or ranges.
	DestinationPorts []*string `json:"destinationPorts,omitempty"`

	// Name of the bypass traffic rule.
	Name *string `json:"name,omitempty"`

	// The rule bypass protocol.
	Protocol *FirewallPolicyIntrusionDetectionProtocol `json:"protocol,omitempty"`

	// List of source IP addresses or ranges for this rule.
	SourceAddresses []*string `json:"sourceAddresses,omitempty"`

	// List of source IpGroups for this rule.
	SourceIPGroups []*string `json:"sourceIpGroups,omitempty"`
}

FirewallPolicyIntrusionDetectionBypassTrafficSpecifications - Intrusion detection bypass traffic specification.

func (FirewallPolicyIntrusionDetectionBypassTrafficSpecifications) MarshalJSON 

func (f FirewallPolicyIntrusionDetectionBypassTrafficSpecifications) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyIntrusionDetectionBypassTrafficSpecifications.

type FirewallPolicyIntrusionDetectionConfiguration 

type FirewallPolicyIntrusionDetectionConfiguration struct {
	// List of rules for traffic to bypass.
	BypassTrafficSettings []*FirewallPolicyIntrusionDetectionBypassTrafficSpecifications `json:"bypassTrafficSettings,omitempty"`

	// List of specific signatures states.
	SignatureOverrides []*FirewallPolicyIntrusionDetectionSignatureSpecification `json:"signatureOverrides,omitempty"`
}

FirewallPolicyIntrusionDetectionConfiguration - The operation for configuring intrusion detection.

func (FirewallPolicyIntrusionDetectionConfiguration) MarshalJSON 

func (f FirewallPolicyIntrusionDetectionConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyIntrusionDetectionConfiguration.

type FirewallPolicyIntrusionDetectionProtocol 

type FirewallPolicyIntrusionDetectionProtocol string

FirewallPolicyIntrusionDetectionProtocol - Possible intrusion detection bypass traffic protocols. 

const (
	FirewallPolicyIntrusionDetectionProtocolANY  FirewallPolicyIntrusionDetectionProtocol = "ANY"
	FirewallPolicyIntrusionDetectionProtocolICMP FirewallPolicyIntrusionDetectionProtocol = "ICMP"
	FirewallPolicyIntrusionDetectionProtocolTCP  FirewallPolicyIntrusionDetectionProtocol = "TCP"
	FirewallPolicyIntrusionDetectionProtocolUDP  FirewallPolicyIntrusionDetectionProtocol = "UDP"
)

func PossibleFirewallPolicyIntrusionDetectionProtocolValues 

func PossibleFirewallPolicyIntrusionDetectionProtocolValues() []FirewallPolicyIntrusionDetectionProtocol

PossibleFirewallPolicyIntrusionDetectionProtocolValues returns the possible values for the FirewallPolicyIntrusionDetectionProtocol const type.

func (FirewallPolicyIntrusionDetectionProtocol) ToPtr 

func (c FirewallPolicyIntrusionDetectionProtocol) ToPtr() *FirewallPolicyIntrusionDetectionProtocol

ToPtr returns a *FirewallPolicyIntrusionDetectionProtocol pointing to the current value.

type FirewallPolicyIntrusionDetectionSignatureSpecification 

type FirewallPolicyIntrusionDetectionSignatureSpecification struct {
	// Signature id.
	ID *string `json:"id,omitempty"`

	// The signature state.
	Mode *FirewallPolicyIntrusionDetectionStateType `json:"mode,omitempty"`
}

FirewallPolicyIntrusionDetectionSignatureSpecification - Intrusion detection signatures specification states.

type FirewallPolicyIntrusionDetectionStateType 

type FirewallPolicyIntrusionDetectionStateType string

FirewallPolicyIntrusionDetectionStateType - Possible state values. 

const (
	FirewallPolicyIntrusionDetectionStateTypeAlert FirewallPolicyIntrusionDetectionStateType = "Alert"
	FirewallPolicyIntrusionDetectionStateTypeDeny  FirewallPolicyIntrusionDetectionStateType = "Deny"
	FirewallPolicyIntrusionDetectionStateTypeOff   FirewallPolicyIntrusionDetectionStateType = "Off"
)

func PossibleFirewallPolicyIntrusionDetectionStateTypeValues 

func PossibleFirewallPolicyIntrusionDetectionStateTypeValues() []FirewallPolicyIntrusionDetectionStateType

PossibleFirewallPolicyIntrusionDetectionStateTypeValues returns the possible values for the FirewallPolicyIntrusionDetectionStateType const type.

func (FirewallPolicyIntrusionDetectionStateType) ToPtr 

func (c FirewallPolicyIntrusionDetectionStateType) ToPtr() *FirewallPolicyIntrusionDetectionStateType

ToPtr returns a *FirewallPolicyIntrusionDetectionStateType pointing to the current value.

type FirewallPolicyListResult 

type FirewallPolicyListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Firewall Policies in a resource group.
	Value []*FirewallPolicy `json:"value,omitempty"`
}

FirewallPolicyListResult - Response for ListFirewallPolicies API service call.

func (FirewallPolicyListResult) MarshalJSON 

func (f FirewallPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyListResult.

type FirewallPolicyLogAnalyticsResources 

type FirewallPolicyLogAnalyticsResources struct {
	// The default workspace Id for Firewall Policy Insights.
	DefaultWorkspaceID *SubResource `json:"defaultWorkspaceId,omitempty"`

	// List of workspaces for Firewall Policy Insights.
	Workspaces []*FirewallPolicyLogAnalyticsWorkspace `json:"workspaces,omitempty"`
}

FirewallPolicyLogAnalyticsResources - Log Analytics Resources for Firewall Policy Insights.

func (FirewallPolicyLogAnalyticsResources) MarshalJSON 

func (f FirewallPolicyLogAnalyticsResources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyLogAnalyticsResources.

type FirewallPolicyLogAnalyticsWorkspace 

type FirewallPolicyLogAnalyticsWorkspace struct {
	// Region to configure the Workspace.
	Region *string `json:"region,omitempty"`

	// The workspace Id for Firewall Policy Insights.
	WorkspaceID *SubResource `json:"workspaceId,omitempty"`
}

FirewallPolicyLogAnalyticsWorkspace - Log Analytics Workspace for Firewall Policy Insights.

type FirewallPolicyNatRuleCollection 

type FirewallPolicyNatRuleCollection struct {
	// REQUIRED; The type of the rule collection.
	RuleCollectionType *FirewallPolicyRuleCollectionType `json:"ruleCollectionType,omitempty"`

	// The action type of a Nat rule collection.
	Action *FirewallPolicyNatRuleCollectionAction `json:"action,omitempty"`

	// The name of the rule collection.
	Name *string `json:"name,omitempty"`

	// Priority of the Firewall Policy Rule Collection resource.
	Priority *int32 `json:"priority,omitempty"`

	// List of rules included in a rule collection.
	Rules []FirewallPolicyRuleClassification `json:"rules,omitempty"`
}

FirewallPolicyNatRuleCollection - Firewall Policy NAT Rule Collection.

func (*FirewallPolicyNatRuleCollection) GetFirewallPolicyRuleCollection added in v0.3.0 

func (f *FirewallPolicyNatRuleCollection) GetFirewallPolicyRuleCollection() *FirewallPolicyRuleCollection

GetFirewallPolicyRuleCollection implements the FirewallPolicyRuleCollectionClassification interface for type FirewallPolicyNatRuleCollection.

func (FirewallPolicyNatRuleCollection) MarshalJSON 

func (f FirewallPolicyNatRuleCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyNatRuleCollection.

func (*FirewallPolicyNatRuleCollection) UnmarshalJSON 

func (f *FirewallPolicyNatRuleCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyNatRuleCollection.

type FirewallPolicyNatRuleCollectionAction 

type FirewallPolicyNatRuleCollectionAction struct {
	// The type of action.
	Type *FirewallPolicyNatRuleCollectionActionType `json:"type,omitempty"`
}

FirewallPolicyNatRuleCollectionAction - Properties of the FirewallPolicyNatRuleCollectionAction.

type FirewallPolicyNatRuleCollectionActionType 

type FirewallPolicyNatRuleCollectionActionType string

FirewallPolicyNatRuleCollectionActionType - The action type of a rule. 

const (
	FirewallPolicyNatRuleCollectionActionTypeDNAT FirewallPolicyNatRuleCollectionActionType = "DNAT"
)

func PossibleFirewallPolicyNatRuleCollectionActionTypeValues 

func PossibleFirewallPolicyNatRuleCollectionActionTypeValues() []FirewallPolicyNatRuleCollectionActionType

PossibleFirewallPolicyNatRuleCollectionActionTypeValues returns the possible values for the FirewallPolicyNatRuleCollectionActionType const type.

func (FirewallPolicyNatRuleCollectionActionType) ToPtr 

func (c FirewallPolicyNatRuleCollectionActionType) ToPtr() *FirewallPolicyNatRuleCollectionActionType

ToPtr returns a *FirewallPolicyNatRuleCollectionActionType pointing to the current value.

type FirewallPolicyPropertiesFormat 

type FirewallPolicyPropertiesFormat struct {
	// The parent firewall policy from which rules are inherited.
	BasePolicy *SubResource `json:"basePolicy,omitempty"`

	// DNS Proxy Settings definition.
	DNSSettings *DNSSettings `json:"dnsSettings,omitempty"`

	// Explicit Proxy Settings definition.
	ExplicitProxySettings *ExplicitProxySettings `json:"explicitProxySettings,omitempty"`

	// Insights on Firewall Policy.
	Insights *FirewallPolicyInsights `json:"insights,omitempty"`

	// The configuration for Intrusion detection.
	IntrusionDetection *FirewallPolicyIntrusionDetection `json:"intrusionDetection,omitempty"`

	// The Firewall Policy SKU.
	SKU *FirewallPolicySKU `json:"sku,omitempty"`

	// SQL Settings definition.
	SQL *FirewallPolicySQL `json:"sql,omitempty"`

	// The private IP addresses/IP ranges to which traffic will not be SNAT.
	Snat *FirewallPolicySNAT `json:"snat,omitempty"`

	// The operation mode for Threat Intelligence.
	ThreatIntelMode *AzureFirewallThreatIntelMode `json:"threatIntelMode,omitempty"`

	// ThreatIntel Whitelist for Firewall Policy.
	ThreatIntelWhitelist *FirewallPolicyThreatIntelWhitelist `json:"threatIntelWhitelist,omitempty"`

	// TLS Configuration definition.
	TransportSecurity *FirewallPolicyTransportSecurity `json:"transportSecurity,omitempty"`

	// READ-ONLY; List of references to Child Firewall Policies.
	ChildPolicies []*SubResource `json:"childPolicies,omitempty" azure:"ro"`

	// READ-ONLY; List of references to Azure Firewalls that this Firewall Policy is associated with.
	Firewalls []*SubResource `json:"firewalls,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the firewall policy resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; List of references to FirewallPolicyRuleCollectionGroups.
	RuleCollectionGroups []*SubResource `json:"ruleCollectionGroups,omitempty" azure:"ro"`
}

FirewallPolicyPropertiesFormat - Firewall Policy definition.

func (FirewallPolicyPropertiesFormat) MarshalJSON 

func (f FirewallPolicyPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyPropertiesFormat.

type FirewallPolicyRule 

type FirewallPolicyRule struct {
	// REQUIRED; Rule Type.
	RuleType *FirewallPolicyRuleType `json:"ruleType,omitempty"`

	// Description of the rule.
	Description *string `json:"description,omitempty"`

	// Name of the rule.
	Name *string `json:"name,omitempty"`
}

FirewallPolicyRule - Properties of a rule.

func (*FirewallPolicyRule) GetFirewallPolicyRule 

func (f *FirewallPolicyRule) GetFirewallPolicyRule() *FirewallPolicyRule

GetFirewallPolicyRule implements the FirewallPolicyRuleClassification interface for type FirewallPolicyRule.

type FirewallPolicyRuleApplicationProtocol 

type FirewallPolicyRuleApplicationProtocol struct {
	// Port number for the protocol, cannot be greater than 64000.
	Port *int32 `json:"port,omitempty"`

	// Protocol type.
	ProtocolType *FirewallPolicyRuleApplicationProtocolType `json:"protocolType,omitempty"`
}

FirewallPolicyRuleApplicationProtocol - Properties of the application rule protocol.

type FirewallPolicyRuleApplicationProtocolType 

type FirewallPolicyRuleApplicationProtocolType string

FirewallPolicyRuleApplicationProtocolType - The application protocol type of a Rule. 

const (
	FirewallPolicyRuleApplicationProtocolTypeHTTP  FirewallPolicyRuleApplicationProtocolType = "Http"
	FirewallPolicyRuleApplicationProtocolTypeHTTPS FirewallPolicyRuleApplicationProtocolType = "Https"
)

func PossibleFirewallPolicyRuleApplicationProtocolTypeValues 

func PossibleFirewallPolicyRuleApplicationProtocolTypeValues() []FirewallPolicyRuleApplicationProtocolType

PossibleFirewallPolicyRuleApplicationProtocolTypeValues returns the possible values for the FirewallPolicyRuleApplicationProtocolType const type.

func (FirewallPolicyRuleApplicationProtocolType) ToPtr 

func (c FirewallPolicyRuleApplicationProtocolType) ToPtr() *FirewallPolicyRuleApplicationProtocolType

ToPtr returns a *FirewallPolicyRuleApplicationProtocolType pointing to the current value.

type FirewallPolicyRuleClassification 

type FirewallPolicyRuleClassification interface {
	// GetFirewallPolicyRule returns the FirewallPolicyRule content of the underlying type.
	GetFirewallPolicyRule() *FirewallPolicyRule
}

FirewallPolicyRuleClassification provides polymorphic access to related types. Call the interface's GetFirewallPolicyRule() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ApplicationRule, *FirewallPolicyRule, *NatRule, *Rule

type FirewallPolicyRuleCollection 

type FirewallPolicyRuleCollection struct {
	// REQUIRED; The type of the rule collection.
	RuleCollectionType *FirewallPolicyRuleCollectionType `json:"ruleCollectionType,omitempty"`

	// The name of the rule collection.
	Name *string `json:"name,omitempty"`

	// Priority of the Firewall Policy Rule Collection resource.
	Priority *int32 `json:"priority,omitempty"`
}

FirewallPolicyRuleCollection - Properties of the rule collection.

func (*FirewallPolicyRuleCollection) GetFirewallPolicyRuleCollection 

func (f *FirewallPolicyRuleCollection) GetFirewallPolicyRuleCollection() *FirewallPolicyRuleCollection

GetFirewallPolicyRuleCollection implements the FirewallPolicyRuleCollectionClassification interface for type FirewallPolicyRuleCollection.

type FirewallPolicyRuleCollectionClassification 

type FirewallPolicyRuleCollectionClassification interface {
	// GetFirewallPolicyRuleCollection returns the FirewallPolicyRuleCollection content of the underlying type.
	GetFirewallPolicyRuleCollection() *FirewallPolicyRuleCollection
}

FirewallPolicyRuleCollectionClassification provides polymorphic access to related types. Call the interface's GetFirewallPolicyRuleCollection() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *FirewallPolicyFilterRuleCollection, *FirewallPolicyNatRuleCollection, *FirewallPolicyRuleCollection

type FirewallPolicyRuleCollectionGroup 

type FirewallPolicyRuleCollectionGroup struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// The properties of the firewall policy rule collection group.
	Properties *FirewallPolicyRuleCollectionGroupProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Rule Group type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

FirewallPolicyRuleCollectionGroup - Rule Collection Group resource.

type FirewallPolicyRuleCollectionGroupListResult 

type FirewallPolicyRuleCollectionGroupListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of FirewallPolicyRuleCollectionGroups in a FirewallPolicy.
	Value []*FirewallPolicyRuleCollectionGroup `json:"value,omitempty"`
}

FirewallPolicyRuleCollectionGroupListResult - Response for ListFirewallPolicyRuleCollectionGroups API service call.

func (FirewallPolicyRuleCollectionGroupListResult) MarshalJSON 

func (f FirewallPolicyRuleCollectionGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyRuleCollectionGroupListResult.

type FirewallPolicyRuleCollectionGroupProperties 

type FirewallPolicyRuleCollectionGroupProperties struct {
	// Priority of the Firewall Policy Rule Collection Group resource.
	Priority *int32 `json:"priority,omitempty"`

	// Group of Firewall Policy rule collections.
	RuleCollections []FirewallPolicyRuleCollectionClassification `json:"ruleCollections,omitempty"`

	// READ-ONLY; The provisioning state of the firewall policy rule collection group resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

FirewallPolicyRuleCollectionGroupProperties - Properties of the rule collection group.

func (FirewallPolicyRuleCollectionGroupProperties) MarshalJSON 

func (f FirewallPolicyRuleCollectionGroupProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyRuleCollectionGroupProperties.

func (*FirewallPolicyRuleCollectionGroupProperties) UnmarshalJSON 

func (f *FirewallPolicyRuleCollectionGroupProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyRuleCollectionGroupProperties.

type FirewallPolicyRuleCollectionGroupsClient 

type FirewallPolicyRuleCollectionGroupsClient struct {
	// contains filtered or unexported fields
}

FirewallPolicyRuleCollectionGroupsClient contains the methods for the FirewallPolicyRuleCollectionGroups group. Don't use this type directly, use NewFirewallPolicyRuleCollectionGroupsClient() instead.

func NewFirewallPolicyRuleCollectionGroupsClient 

func NewFirewallPolicyRuleCollectionGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *FirewallPolicyRuleCollectionGroupsClient

NewFirewallPolicyRuleCollectionGroupsClient creates a new instance of FirewallPolicyRuleCollectionGroupsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*FirewallPolicyRuleCollectionGroupsClient) BeginCreateOrUpdate 

func (client *FirewallPolicyRuleCollectionGroupsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, firewallPolicyName string, ruleCollectionGroupName string, parameters FirewallPolicyRuleCollectionGroup, options *FirewallPolicyRuleCollectionGroupsClientBeginCreateOrUpdateOptions) (FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified FirewallPolicyRuleCollectionGroup. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. ruleCollectionGroupName - The name of the FirewallPolicyRuleCollectionGroup. parameters - Parameters supplied to the create or update FirewallPolicyRuleCollectionGroup operation. options - FirewallPolicyRuleCollectionGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyNatRuleCollectionGroupPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		"<rule-collection-group-name>",
		armnetwork.FirewallPolicyRuleCollectionGroup{
			Properties: &armnetwork.FirewallPolicyRuleCollectionGroupProperties{
				Priority: to.Int32Ptr(100),
				RuleCollections: []armnetwork.FirewallPolicyRuleCollectionClassification{
					&armnetwork.FirewallPolicyNatRuleCollection{
						Name:               to.StringPtr("<name>"),
						Priority:           to.Int32Ptr(100),
						RuleCollectionType: armnetwork.FirewallPolicyRuleCollectionType("FirewallPolicyNatRuleCollection").ToPtr(),
						Action: &armnetwork.FirewallPolicyNatRuleCollectionAction{
							Type: armnetwork.FirewallPolicyNatRuleCollectionActionType("DNAT").ToPtr(),
						},
						Rules: []armnetwork.FirewallPolicyRuleClassification{
							&armnetwork.NatRule{
								Name:     to.StringPtr("<name>"),
								RuleType: armnetwork.FirewallPolicyRuleType("NatRule").ToPtr(),
								DestinationAddresses: []*string{
									to.StringPtr("152.23.32.23")},
								DestinationPorts: []*string{
									to.StringPtr("8080")},
								IPProtocols: []*armnetwork.FirewallPolicyRuleNetworkProtocol{
									armnetwork.FirewallPolicyRuleNetworkProtocol("TCP").ToPtr(),
									armnetwork.FirewallPolicyRuleNetworkProtocol("UDP").ToPtr()},
								SourceAddresses: []*string{
									to.StringPtr("2.2.2.2")},
								SourceIPGroups: []*string{},
								TranslatedFqdn: to.StringPtr("<translated-fqdn>"),
								TranslatedPort: to.StringPtr("<translated-port>"),
							}},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResult)
}

Output:

func (*FirewallPolicyRuleCollectionGroupsClient) BeginDelete 

func (client *FirewallPolicyRuleCollectionGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, firewallPolicyName string, ruleCollectionGroupName string, options *FirewallPolicyRuleCollectionGroupsClientBeginDeleteOptions) (FirewallPolicyRuleCollectionGroupsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified FirewallPolicyRuleCollectionGroup. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. ruleCollectionGroupName - The name of the FirewallPolicyRuleCollectionGroup. options - FirewallPolicyRuleCollectionGroupsClientBeginDeleteOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyRuleCollectionGroupDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		"<rule-collection-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*FirewallPolicyRuleCollectionGroupsClient) Get 

func (client *FirewallPolicyRuleCollectionGroupsClient) Get(ctx context.Context, resourceGroupName string, firewallPolicyName string, ruleCollectionGroupName string, options *FirewallPolicyRuleCollectionGroupsClientGetOptions) (FirewallPolicyRuleCollectionGroupsClientGetResponse, error)

Get - Gets the specified FirewallPolicyRuleCollectionGroup. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. ruleCollectionGroupName - The name of the FirewallPolicyRuleCollectionGroup. options - FirewallPolicyRuleCollectionGroupsClientGetOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyNatRuleCollectionGroupGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<firewall-policy-name>",
		"<rule-collection-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FirewallPolicyRuleCollectionGroupsClientGetResult)
}

Output:

func (*FirewallPolicyRuleCollectionGroupsClient) List 

func (client *FirewallPolicyRuleCollectionGroupsClient) List(resourceGroupName string, firewallPolicyName string, options *FirewallPolicyRuleCollectionGroupsClientListOptions) *FirewallPolicyRuleCollectionGroupsClientListPager

List - Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. options - FirewallPolicyRuleCollectionGroupsClientListOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<firewall-policy-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type FirewallPolicyRuleCollectionGroupsClientBeginCreateOrUpdateOptions added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientBeginCreateOrUpdateOptions struct {
}

FirewallPolicyRuleCollectionGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.BeginCreateOrUpdate method.

type FirewallPolicyRuleCollectionGroupsClientBeginDeleteOptions added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientBeginDeleteOptions struct {
}

FirewallPolicyRuleCollectionGroupsClientBeginDeleteOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.BeginDelete method.

type FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResponse will be returned.

func (*FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePollerResponse added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePollerResponse contains the response from method FirewallPolicyRuleCollectionGroupsClient.CreateOrUpdate.

func (FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *FirewallPolicyRuleCollectionGroupsClient, token string) error

Resume rehydrates a FirewallPolicyRuleCollectionGroupsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResponse added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResponse struct {
	FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResponse contains the response from method FirewallPolicyRuleCollectionGroupsClient.CreateOrUpdate.

type FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResult added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResult struct {
	FirewallPolicyRuleCollectionGroup
}

FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResult contains the result from method FirewallPolicyRuleCollectionGroupsClient.CreateOrUpdate.

type FirewallPolicyRuleCollectionGroupsClientDeletePoller added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientDeletePoller struct {
	// contains filtered or unexported fields
}

FirewallPolicyRuleCollectionGroupsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*FirewallPolicyRuleCollectionGroupsClientDeletePoller) Done added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*FirewallPolicyRuleCollectionGroupsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientDeletePoller) FinalResponse(ctx context.Context) (FirewallPolicyRuleCollectionGroupsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final FirewallPolicyRuleCollectionGroupsClientDeleteResponse will be returned.

func (*FirewallPolicyRuleCollectionGroupsClientDeletePoller) Poll added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*FirewallPolicyRuleCollectionGroupsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type FirewallPolicyRuleCollectionGroupsClientDeletePollerResponse added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *FirewallPolicyRuleCollectionGroupsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyRuleCollectionGroupsClientDeletePollerResponse contains the response from method FirewallPolicyRuleCollectionGroupsClient.Delete.

func (FirewallPolicyRuleCollectionGroupsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l FirewallPolicyRuleCollectionGroupsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (FirewallPolicyRuleCollectionGroupsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*FirewallPolicyRuleCollectionGroupsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *FirewallPolicyRuleCollectionGroupsClientDeletePollerResponse) Resume(ctx context.Context, client *FirewallPolicyRuleCollectionGroupsClient, token string) error

Resume rehydrates a FirewallPolicyRuleCollectionGroupsClientDeletePollerResponse from the provided client and resume token.

type FirewallPolicyRuleCollectionGroupsClientDeleteResponse added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyRuleCollectionGroupsClientDeleteResponse contains the response from method FirewallPolicyRuleCollectionGroupsClient.Delete.

type FirewallPolicyRuleCollectionGroupsClientGetOptions added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientGetOptions struct {
}

FirewallPolicyRuleCollectionGroupsClientGetOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.Get method.

type FirewallPolicyRuleCollectionGroupsClientGetResponse added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientGetResponse struct {
	FirewallPolicyRuleCollectionGroupsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyRuleCollectionGroupsClientGetResponse contains the response from method FirewallPolicyRuleCollectionGroupsClient.Get.

type FirewallPolicyRuleCollectionGroupsClientGetResult added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientGetResult struct {
	FirewallPolicyRuleCollectionGroup
}

FirewallPolicyRuleCollectionGroupsClientGetResult contains the result from method FirewallPolicyRuleCollectionGroupsClient.Get.

type FirewallPolicyRuleCollectionGroupsClientListOptions added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientListOptions struct {
}

FirewallPolicyRuleCollectionGroupsClientListOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.List method.

type FirewallPolicyRuleCollectionGroupsClientListPager added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientListPager struct {
	// contains filtered or unexported fields
}

FirewallPolicyRuleCollectionGroupsClientListPager provides operations for iterating over paged responses.

func (*FirewallPolicyRuleCollectionGroupsClientListPager) Err added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*FirewallPolicyRuleCollectionGroupsClientListPager) NextPage added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*FirewallPolicyRuleCollectionGroupsClientListPager) PageResponse added in v0.3.0 

func (p *FirewallPolicyRuleCollectionGroupsClientListPager) PageResponse() FirewallPolicyRuleCollectionGroupsClientListResponse

PageResponse returns the current FirewallPolicyRuleCollectionGroupsClientListResponse page.

type FirewallPolicyRuleCollectionGroupsClientListResponse added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientListResponse struct {
	FirewallPolicyRuleCollectionGroupsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FirewallPolicyRuleCollectionGroupsClientListResponse contains the response from method FirewallPolicyRuleCollectionGroupsClient.List.

type FirewallPolicyRuleCollectionGroupsClientListResult added in v0.3.0 

type FirewallPolicyRuleCollectionGroupsClientListResult struct {
	FirewallPolicyRuleCollectionGroupListResult
}

FirewallPolicyRuleCollectionGroupsClientListResult contains the result from method FirewallPolicyRuleCollectionGroupsClient.List.

type FirewallPolicyRuleCollectionType 

type FirewallPolicyRuleCollectionType string

FirewallPolicyRuleCollectionType - The type of the rule collection. 

const (
	FirewallPolicyRuleCollectionTypeFirewallPolicyFilterRuleCollection FirewallPolicyRuleCollectionType = "FirewallPolicyFilterRuleCollection"
	FirewallPolicyRuleCollectionTypeFirewallPolicyNatRuleCollection    FirewallPolicyRuleCollectionType = "FirewallPolicyNatRuleCollection"
)

func PossibleFirewallPolicyRuleCollectionTypeValues 

func PossibleFirewallPolicyRuleCollectionTypeValues() []FirewallPolicyRuleCollectionType

PossibleFirewallPolicyRuleCollectionTypeValues returns the possible values for the FirewallPolicyRuleCollectionType const type.

func (FirewallPolicyRuleCollectionType) ToPtr 

func (c FirewallPolicyRuleCollectionType) ToPtr() *FirewallPolicyRuleCollectionType

ToPtr returns a *FirewallPolicyRuleCollectionType pointing to the current value.

type FirewallPolicyRuleNetworkProtocol 

type FirewallPolicyRuleNetworkProtocol string

FirewallPolicyRuleNetworkProtocol - The Network protocol of a Rule. 

const (
	FirewallPolicyRuleNetworkProtocolAny  FirewallPolicyRuleNetworkProtocol = "Any"
	FirewallPolicyRuleNetworkProtocolICMP FirewallPolicyRuleNetworkProtocol = "ICMP"
	FirewallPolicyRuleNetworkProtocolTCP  FirewallPolicyRuleNetworkProtocol = "TCP"
	FirewallPolicyRuleNetworkProtocolUDP  FirewallPolicyRuleNetworkProtocol = "UDP"
)

func PossibleFirewallPolicyRuleNetworkProtocolValues 

func PossibleFirewallPolicyRuleNetworkProtocolValues() []FirewallPolicyRuleNetworkProtocol

PossibleFirewallPolicyRuleNetworkProtocolValues returns the possible values for the FirewallPolicyRuleNetworkProtocol const type.

func (FirewallPolicyRuleNetworkProtocol) ToPtr 

func (c FirewallPolicyRuleNetworkProtocol) ToPtr() *FirewallPolicyRuleNetworkProtocol

ToPtr returns a *FirewallPolicyRuleNetworkProtocol pointing to the current value.

type FirewallPolicyRuleType 

type FirewallPolicyRuleType string

FirewallPolicyRuleType - Rule Type. 

const (
	FirewallPolicyRuleTypeApplicationRule FirewallPolicyRuleType = "ApplicationRule"
	FirewallPolicyRuleTypeNatRule         FirewallPolicyRuleType = "NatRule"
	FirewallPolicyRuleTypeNetworkRule     FirewallPolicyRuleType = "NetworkRule"
)

func PossibleFirewallPolicyRuleTypeValues 

func PossibleFirewallPolicyRuleTypeValues() []FirewallPolicyRuleType

PossibleFirewallPolicyRuleTypeValues returns the possible values for the FirewallPolicyRuleType const type.

func (FirewallPolicyRuleType) ToPtr 

func (c FirewallPolicyRuleType) ToPtr() *FirewallPolicyRuleType

ToPtr returns a *FirewallPolicyRuleType pointing to the current value.

type FirewallPolicySKU 

type FirewallPolicySKU struct {
	// Tier of Firewall Policy.
	Tier *FirewallPolicySKUTier `json:"tier,omitempty"`
}

FirewallPolicySKU - SKU of Firewall policy.

type FirewallPolicySKUTier 

type FirewallPolicySKUTier string

FirewallPolicySKUTier - Tier of Firewall Policy. 

const (
	FirewallPolicySKUTierBasic    FirewallPolicySKUTier = "Basic"
	FirewallPolicySKUTierPremium  FirewallPolicySKUTier = "Premium"
	FirewallPolicySKUTierStandard FirewallPolicySKUTier = "Standard"
)

func PossibleFirewallPolicySKUTierValues 

func PossibleFirewallPolicySKUTierValues() []FirewallPolicySKUTier

PossibleFirewallPolicySKUTierValues returns the possible values for the FirewallPolicySKUTier const type.

func (FirewallPolicySKUTier) ToPtr 

func (c FirewallPolicySKUTier) ToPtr() *FirewallPolicySKUTier

ToPtr returns a *FirewallPolicySKUTier pointing to the current value.

type FirewallPolicySNAT 

type FirewallPolicySNAT struct {
	// List of private IP addresses/IP address ranges to not be SNAT.
	PrivateRanges []*string `json:"privateRanges,omitempty"`
}

FirewallPolicySNAT - The private IP addresses/IP ranges to which traffic will not be SNAT.

func (FirewallPolicySNAT) MarshalJSON 

func (f FirewallPolicySNAT) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicySNAT.

type FirewallPolicySQL 

type FirewallPolicySQL struct {
	// A flag to indicate if SQL Redirect traffic filtering is enabled. Turning on the flag requires no rule using port 11000-11999.
	AllowSQLRedirect *bool `json:"allowSqlRedirect,omitempty"`
}

FirewallPolicySQL - SQL Settings in Firewall Policy.

type FirewallPolicyThreatIntelWhitelist 

type FirewallPolicyThreatIntelWhitelist struct {
	// List of FQDNs for the ThreatIntel Whitelist.
	Fqdns []*string `json:"fqdns,omitempty"`

	// List of IP addresses for the ThreatIntel Whitelist.
	IPAddresses []*string `json:"ipAddresses,omitempty"`
}

FirewallPolicyThreatIntelWhitelist - ThreatIntel Whitelist for Firewall Policy.

func (FirewallPolicyThreatIntelWhitelist) MarshalJSON 

func (f FirewallPolicyThreatIntelWhitelist) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyThreatIntelWhitelist.

type FirewallPolicyTransportSecurity 

type FirewallPolicyTransportSecurity struct {
	// The CA used for intermediate CA generation.
	CertificateAuthority *FirewallPolicyCertificateAuthority `json:"certificateAuthority,omitempty"`
}

FirewallPolicyTransportSecurity - Configuration needed to perform TLS termination & initiation.

type FlowLog 

type FlowLog struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the flow log.
	Properties *FlowLogPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

FlowLog - A flow log resource.

func (FlowLog) MarshalJSON 

func (f FlowLog) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FlowLog.

type FlowLogFormatParameters 

type FlowLogFormatParameters struct {
	// The file type of flow log.
	Type *FlowLogFormatType `json:"type,omitempty"`

	// The version (revision) of the flow log.
	Version *int32 `json:"version,omitempty"`
}

FlowLogFormatParameters - Parameters that define the flow log format.

type FlowLogFormatType 

type FlowLogFormatType string

FlowLogFormatType - The file type of flow log. 

const (
	FlowLogFormatTypeJSON FlowLogFormatType = "JSON"
)

func PossibleFlowLogFormatTypeValues 

func PossibleFlowLogFormatTypeValues() []FlowLogFormatType

PossibleFlowLogFormatTypeValues returns the possible values for the FlowLogFormatType const type.

func (FlowLogFormatType) ToPtr 

func (c FlowLogFormatType) ToPtr() *FlowLogFormatType

ToPtr returns a *FlowLogFormatType pointing to the current value.

type FlowLogInformation 

type FlowLogInformation struct {
	// REQUIRED; Properties of the flow log.
	Properties *FlowLogProperties `json:"properties,omitempty"`

	// REQUIRED; The ID of the resource to configure for flow log and traffic analytics (optional) .
	TargetResourceID *string `json:"targetResourceId,omitempty"`

	// Parameters that define the configuration of traffic analytics.
	FlowAnalyticsConfiguration *TrafficAnalyticsProperties `json:"flowAnalyticsConfiguration,omitempty"`
}

FlowLogInformation - Information on the configuration of flow log and traffic analytics (optional) .

type FlowLogListResult 

type FlowLogListResult struct {
	// Information about flow log resource.
	Value []*FlowLog `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

FlowLogListResult - List of flow logs.

func (FlowLogListResult) MarshalJSON 

func (f FlowLogListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FlowLogListResult.

type FlowLogProperties 

type FlowLogProperties struct {
	// REQUIRED; Flag to enable/disable flow logging.
	Enabled *bool `json:"enabled,omitempty"`

	// REQUIRED; ID of the storage account which is used to store the flow log.
	StorageID *string `json:"storageId,omitempty"`

	// Parameters that define the flow log format.
	Format *FlowLogFormatParameters `json:"format,omitempty"`

	// Parameters that define the retention policy for flow log.
	RetentionPolicy *RetentionPolicyParameters `json:"retentionPolicy,omitempty"`
}

FlowLogProperties - Parameters that define the configuration of flow log.

type FlowLogPropertiesFormat 

type FlowLogPropertiesFormat struct {
	// REQUIRED; ID of the storage account which is used to store the flow log.
	StorageID *string `json:"storageId,omitempty"`

	// REQUIRED; ID of network security group to which flow log will be applied.
	TargetResourceID *string `json:"targetResourceId,omitempty"`

	// Flag to enable/disable flow logging.
	Enabled *bool `json:"enabled,omitempty"`

	// Parameters that define the configuration of traffic analytics.
	FlowAnalyticsConfiguration *TrafficAnalyticsProperties `json:"flowAnalyticsConfiguration,omitempty"`

	// Parameters that define the flow log format.
	Format *FlowLogFormatParameters `json:"format,omitempty"`

	// Parameters that define the retention policy for flow log.
	RetentionPolicy *RetentionPolicyParameters `json:"retentionPolicy,omitempty"`

	// READ-ONLY; The provisioning state of the flow log.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Guid of network security group to which flow log will be applied.
	TargetResourceGUID *string `json:"targetResourceGuid,omitempty" azure:"ro"`
}

FlowLogPropertiesFormat - Parameters that define the configuration of flow log.

type FlowLogStatusParameters 

type FlowLogStatusParameters struct {
	// REQUIRED; The target resource where getting the flow log and traffic analytics (optional) status.
	TargetResourceID *string `json:"targetResourceId,omitempty"`
}

FlowLogStatusParameters - Parameters that define a resource to query flow log and traffic analytics (optional) status.

type FlowLogsClient 

type FlowLogsClient struct {
	// contains filtered or unexported fields
}

FlowLogsClient contains the methods for the FlowLogs group. Don't use this type directly, use NewFlowLogsClient() instead.

func NewFlowLogsClient 

func NewFlowLogsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *FlowLogsClient

NewFlowLogsClient creates a new instance of FlowLogsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*FlowLogsClient) BeginCreateOrUpdate 

func (client *FlowLogsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkWatcherName string, flowLogName string, parameters FlowLog, options *FlowLogsClientBeginCreateOrUpdateOptions) (FlowLogsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Create or update a flow log for the specified network security group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. flowLogName - The name of the flow log. parameters - Parameters that define the create or update flow log resource. options - FlowLogsClientBeginCreateOrUpdateOptions contains the optional parameters for the FlowLogsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherFlowLogCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFlowLogsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<flow-log-name>",
		armnetwork.FlowLog{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.FlowLogPropertiesFormat{
				Format: &armnetwork.FlowLogFormatParameters{
					Type:    armnetwork.FlowLogFormatType("JSON").ToPtr(),
					Version: to.Int32Ptr(1),
				},
				Enabled:          to.BoolPtr(true),
				StorageID:        to.StringPtr("<storage-id>"),
				TargetResourceID: to.StringPtr("<target-resource-id>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FlowLogsClientCreateOrUpdateResult)
}

Output:

func (*FlowLogsClient) BeginDelete 

func (client *FlowLogsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkWatcherName string, flowLogName string, options *FlowLogsClientBeginDeleteOptions) (FlowLogsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified flow log resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. flowLogName - The name of the flow log resource. options - FlowLogsClientBeginDeleteOptions contains the optional parameters for the FlowLogsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherFlowLogDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFlowLogsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<flow-log-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*FlowLogsClient) Get 

func (client *FlowLogsClient) Get(ctx context.Context, resourceGroupName string, networkWatcherName string, flowLogName string, options *FlowLogsClientGetOptions) (FlowLogsClientGetResponse, error)

Get - Gets a flow log resource by name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. flowLogName - The name of the flow log resource. options - FlowLogsClientGetOptions contains the optional parameters for the FlowLogsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherFlowLogGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFlowLogsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<flow-log-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FlowLogsClientGetResult)
}

Output:

func (*FlowLogsClient) List 

func (client *FlowLogsClient) List(resourceGroupName string, networkWatcherName string, options *FlowLogsClientListOptions) *FlowLogsClientListPager

List - Lists all flow log resources for the specified Network Watcher. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group containing Network Watcher. networkWatcherName - The name of the Network Watcher resource. options - FlowLogsClientListOptions contains the optional parameters for the FlowLogsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherFlowLogList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFlowLogsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<network-watcher-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*FlowLogsClient) UpdateTags 

func (client *FlowLogsClient) UpdateTags(ctx context.Context, resourceGroupName string, networkWatcherName string, flowLogName string, parameters TagsObject, options *FlowLogsClientUpdateTagsOptions) (FlowLogsClientUpdateTagsResponse, error)

UpdateTags - Update tags of the specified flow log. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. flowLogName - The name of the flow log. parameters - Parameters supplied to update flow log tags. options - FlowLogsClientUpdateTagsOptions contains the optional parameters for the FlowLogsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherFlowLogUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewFlowLogsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<flow-log-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FlowLogsClientUpdateTagsResult)
}

Output:

type FlowLogsClientBeginCreateOrUpdateOptions added in v0.3.0 

type FlowLogsClientBeginCreateOrUpdateOptions struct {
}

FlowLogsClientBeginCreateOrUpdateOptions contains the optional parameters for the FlowLogsClient.BeginCreateOrUpdate method.

type FlowLogsClientBeginDeleteOptions added in v0.3.0 

type FlowLogsClientBeginDeleteOptions struct {
}

FlowLogsClientBeginDeleteOptions contains the optional parameters for the FlowLogsClient.BeginDelete method.

type FlowLogsClientCreateOrUpdatePoller added in v0.3.0 

type FlowLogsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

FlowLogsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*FlowLogsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *FlowLogsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*FlowLogsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *FlowLogsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (FlowLogsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final FlowLogsClientCreateOrUpdateResponse will be returned.

func (*FlowLogsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *FlowLogsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*FlowLogsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *FlowLogsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type FlowLogsClientCreateOrUpdatePollerResponse added in v0.3.0 

type FlowLogsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *FlowLogsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FlowLogsClientCreateOrUpdatePollerResponse contains the response from method FlowLogsClient.CreateOrUpdate.

func (FlowLogsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l FlowLogsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (FlowLogsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*FlowLogsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *FlowLogsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *FlowLogsClient, token string) error

Resume rehydrates a FlowLogsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type FlowLogsClientCreateOrUpdateResponse added in v0.3.0 

type FlowLogsClientCreateOrUpdateResponse struct {
	FlowLogsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FlowLogsClientCreateOrUpdateResponse contains the response from method FlowLogsClient.CreateOrUpdate.

type FlowLogsClientCreateOrUpdateResult added in v0.3.0 

type FlowLogsClientCreateOrUpdateResult struct {
	FlowLog
}

FlowLogsClientCreateOrUpdateResult contains the result from method FlowLogsClient.CreateOrUpdate.

type FlowLogsClientDeletePoller added in v0.3.0 

type FlowLogsClientDeletePoller struct {
	// contains filtered or unexported fields
}

FlowLogsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*FlowLogsClientDeletePoller) Done added in v0.3.0 

func (p *FlowLogsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*FlowLogsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *FlowLogsClientDeletePoller) FinalResponse(ctx context.Context) (FlowLogsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final FlowLogsClientDeleteResponse will be returned.

func (*FlowLogsClientDeletePoller) Poll added in v0.3.0 

func (p *FlowLogsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*FlowLogsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *FlowLogsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type FlowLogsClientDeletePollerResponse added in v0.3.0 

type FlowLogsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *FlowLogsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FlowLogsClientDeletePollerResponse contains the response from method FlowLogsClient.Delete.

func (FlowLogsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l FlowLogsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (FlowLogsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*FlowLogsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *FlowLogsClientDeletePollerResponse) Resume(ctx context.Context, client *FlowLogsClient, token string) error

Resume rehydrates a FlowLogsClientDeletePollerResponse from the provided client and resume token.

type FlowLogsClientDeleteResponse added in v0.3.0 

type FlowLogsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FlowLogsClientDeleteResponse contains the response from method FlowLogsClient.Delete.

type FlowLogsClientGetOptions added in v0.3.0 

type FlowLogsClientGetOptions struct {
}

FlowLogsClientGetOptions contains the optional parameters for the FlowLogsClient.Get method.

type FlowLogsClientGetResponse added in v0.3.0 

type FlowLogsClientGetResponse struct {
	FlowLogsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FlowLogsClientGetResponse contains the response from method FlowLogsClient.Get.

type FlowLogsClientGetResult added in v0.3.0 

type FlowLogsClientGetResult struct {
	FlowLog
}

FlowLogsClientGetResult contains the result from method FlowLogsClient.Get.

type FlowLogsClientListOptions added in v0.3.0 

type FlowLogsClientListOptions struct {
}

FlowLogsClientListOptions contains the optional parameters for the FlowLogsClient.List method.

type FlowLogsClientListPager added in v0.3.0 

type FlowLogsClientListPager struct {
	// contains filtered or unexported fields
}

FlowLogsClientListPager provides operations for iterating over paged responses.

func (*FlowLogsClientListPager) Err added in v0.3.0 

func (p *FlowLogsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*FlowLogsClientListPager) NextPage added in v0.3.0 

func (p *FlowLogsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*FlowLogsClientListPager) PageResponse added in v0.3.0 

func (p *FlowLogsClientListPager) PageResponse() FlowLogsClientListResponse

PageResponse returns the current FlowLogsClientListResponse page.

type FlowLogsClientListResponse added in v0.3.0 

type FlowLogsClientListResponse struct {
	FlowLogsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FlowLogsClientListResponse contains the response from method FlowLogsClient.List.

type FlowLogsClientListResult added in v0.3.0 

type FlowLogsClientListResult struct {
	FlowLogListResult
}

FlowLogsClientListResult contains the result from method FlowLogsClient.List.

type FlowLogsClientUpdateTagsOptions added in v0.3.0 

type FlowLogsClientUpdateTagsOptions struct {
}

FlowLogsClientUpdateTagsOptions contains the optional parameters for the FlowLogsClient.UpdateTags method.

type FlowLogsClientUpdateTagsResponse added in v0.3.0 

type FlowLogsClientUpdateTagsResponse struct {
	FlowLogsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FlowLogsClientUpdateTagsResponse contains the response from method FlowLogsClient.UpdateTags.

type FlowLogsClientUpdateTagsResult added in v0.3.0 

type FlowLogsClientUpdateTagsResult struct {
	FlowLog
}

FlowLogsClientUpdateTagsResult contains the result from method FlowLogsClient.UpdateTags.

type FrontendIPConfiguration 

type FrontendIPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name
	// can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of the load balancer probe.
	Properties *FrontendIPConfigurationPropertiesFormat `json:"properties,omitempty"`

	// A list of availability zones denoting the IP allocated for the resource needs to come from.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

FrontendIPConfiguration - Frontend IP address of the load balancer.

func (FrontendIPConfiguration) MarshalJSON 

func (f FrontendIPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FrontendIPConfiguration.

type FrontendIPConfigurationPropertiesFormat 

type FrontendIPConfigurationPropertiesFormat struct {
	// The reference to gateway load balancer frontend IP.
	GatewayLoadBalancer *SubResource `json:"gatewayLoadBalancer,omitempty"`

	// The private IP address of the IP configuration.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.
	PrivateIPAddressVersion *IPVersion `json:"privateIPAddressVersion,omitempty"`

	// The Private IP allocation method.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// The reference to the Public IP resource.
	PublicIPAddress *PublicIPAddress `json:"publicIPAddress,omitempty"`

	// The reference to the Public IP Prefix resource.
	PublicIPPrefix *SubResource `json:"publicIPPrefix,omitempty"`

	// The reference to the subnet resource.
	Subnet *Subnet `json:"subnet,omitempty"`

	// READ-ONLY; An array of references to inbound pools that use this frontend IP.
	InboundNatPools []*SubResource `json:"inboundNatPools,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to inbound rules that use this frontend IP.
	InboundNatRules []*SubResource `json:"inboundNatRules,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to load balancing rules that use this frontend IP.
	LoadBalancingRules []*SubResource `json:"loadBalancingRules,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to outbound rules that use this frontend IP.
	OutboundRules []*SubResource `json:"outboundRules,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the frontend IP configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

FrontendIPConfigurationPropertiesFormat - Properties of Frontend IP Configuration of the load balancer.

func (FrontendIPConfigurationPropertiesFormat) MarshalJSON 

func (f FrontendIPConfigurationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FrontendIPConfigurationPropertiesFormat.

type GatewayLoadBalancerTunnelInterface 

type GatewayLoadBalancerTunnelInterface struct {
	// Identifier of gateway load balancer tunnel interface.
	Identifier *int32 `json:"identifier,omitempty"`

	// Port of gateway load balancer tunnel interface.
	Port *int32 `json:"port,omitempty"`

	// Protocol of gateway load balancer tunnel interface.
	Protocol *GatewayLoadBalancerTunnelProtocol `json:"protocol,omitempty"`

	// Traffic type of gateway load balancer tunnel interface.
	Type *GatewayLoadBalancerTunnelInterfaceType `json:"type,omitempty"`
}

GatewayLoadBalancerTunnelInterface - Gateway load balancer tunnel interface of a load balancer backend address pool.

type GatewayLoadBalancerTunnelInterfaceType 

type GatewayLoadBalancerTunnelInterfaceType string

GatewayLoadBalancerTunnelInterfaceType - Traffic type of gateway load balancer tunnel interface. 

const (
	GatewayLoadBalancerTunnelInterfaceTypeExternal GatewayLoadBalancerTunnelInterfaceType = "External"
	GatewayLoadBalancerTunnelInterfaceTypeInternal GatewayLoadBalancerTunnelInterfaceType = "Internal"
	GatewayLoadBalancerTunnelInterfaceTypeNone     GatewayLoadBalancerTunnelInterfaceType = "None"
)

func PossibleGatewayLoadBalancerTunnelInterfaceTypeValues 

func PossibleGatewayLoadBalancerTunnelInterfaceTypeValues() []GatewayLoadBalancerTunnelInterfaceType

PossibleGatewayLoadBalancerTunnelInterfaceTypeValues returns the possible values for the GatewayLoadBalancerTunnelInterfaceType const type.

func (GatewayLoadBalancerTunnelInterfaceType) ToPtr 

func (c GatewayLoadBalancerTunnelInterfaceType) ToPtr() *GatewayLoadBalancerTunnelInterfaceType

ToPtr returns a *GatewayLoadBalancerTunnelInterfaceType pointing to the current value.

type GatewayLoadBalancerTunnelProtocol 

type GatewayLoadBalancerTunnelProtocol string

GatewayLoadBalancerTunnelProtocol - Protocol of gateway load balancer tunnel interface. 

const (
	GatewayLoadBalancerTunnelProtocolNative GatewayLoadBalancerTunnelProtocol = "Native"
	GatewayLoadBalancerTunnelProtocolNone   GatewayLoadBalancerTunnelProtocol = "None"
	GatewayLoadBalancerTunnelProtocolVXLAN  GatewayLoadBalancerTunnelProtocol = "VXLAN"
)

func PossibleGatewayLoadBalancerTunnelProtocolValues 

func PossibleGatewayLoadBalancerTunnelProtocolValues() []GatewayLoadBalancerTunnelProtocol

PossibleGatewayLoadBalancerTunnelProtocolValues returns the possible values for the GatewayLoadBalancerTunnelProtocol const type.

func (GatewayLoadBalancerTunnelProtocol) ToPtr 

func (c GatewayLoadBalancerTunnelProtocol) ToPtr() *GatewayLoadBalancerTunnelProtocol

ToPtr returns a *GatewayLoadBalancerTunnelProtocol pointing to the current value.

type GatewayRoute 

type GatewayRoute struct {
	// READ-ONLY; The route's AS path sequence.
	AsPath *string `json:"asPath,omitempty" azure:"ro"`

	// READ-ONLY; The gateway's local address.
	LocalAddress *string `json:"localAddress,omitempty" azure:"ro"`

	// READ-ONLY; The route's network prefix.
	Network *string `json:"network,omitempty" azure:"ro"`

	// READ-ONLY; The route's next hop.
	NextHop *string `json:"nextHop,omitempty" azure:"ro"`

	// READ-ONLY; The source this route was learned from.
	Origin *string `json:"origin,omitempty" azure:"ro"`

	// READ-ONLY; The peer this route was learned from.
	SourcePeer *string `json:"sourcePeer,omitempty" azure:"ro"`

	// READ-ONLY; The route's weight.
	Weight *int32 `json:"weight,omitempty" azure:"ro"`
}

GatewayRoute - Gateway routing details.

type GatewayRouteListResult 

type GatewayRouteListResult struct {
	// List of gateway routes.
	Value []*GatewayRoute `json:"value,omitempty"`
}

GatewayRouteListResult - List of virtual network gateway routes.

func (GatewayRouteListResult) MarshalJSON 

func (g GatewayRouteListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayRouteListResult.

type GenerateExpressRoutePortsLOARequest 

type GenerateExpressRoutePortsLOARequest struct {
	// REQUIRED; The customer name.
	CustomerName *string `json:"customerName,omitempty"`
}

GenerateExpressRoutePortsLOARequest - The customer name to be printed on a letter of authorization.

type GenerateExpressRoutePortsLOAResult 

type GenerateExpressRoutePortsLOAResult struct {
	// The content as a base64 encoded string.
	EncodedContent *string `json:"encodedContent,omitempty"`
}

GenerateExpressRoutePortsLOAResult - Response for GenerateExpressRoutePortsLOA API service call.

type GetVPNSitesConfigurationRequest 

type GetVPNSitesConfigurationRequest struct {
	// REQUIRED; The sas-url to download the configurations for vpn-sites.
	OutputBlobSasURL *string `json:"outputBlobSasUrl,omitempty"`

	// List of resource-ids of the vpn-sites for which config is to be downloaded.
	VPNSites []*string `json:"vpnSites,omitempty"`
}

GetVPNSitesConfigurationRequest - List of Vpn-Sites.

func (GetVPNSitesConfigurationRequest) MarshalJSON 

func (g GetVPNSitesConfigurationRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GetVPNSitesConfigurationRequest.

type HTTPConfiguration 

type HTTPConfiguration struct {
	// List of HTTP headers.
	Headers []*HTTPHeader `json:"headers,omitempty"`

	// HTTP method.
	Method *HTTPMethod `json:"method,omitempty"`

	// Valid status codes.
	ValidStatusCodes []*int32 `json:"validStatusCodes,omitempty"`
}

HTTPConfiguration - HTTP configuration of the connectivity check.

func (HTTPConfiguration) MarshalJSON 

func (h HTTPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HTTPConfiguration.

type HTTPConfigurationMethod 

type HTTPConfigurationMethod string

HTTPConfigurationMethod - The HTTP method to use. 

const (
	HTTPConfigurationMethodGet  HTTPConfigurationMethod = "Get"
	HTTPConfigurationMethodPost HTTPConfigurationMethod = "Post"
)

func PossibleHTTPConfigurationMethodValues 

func PossibleHTTPConfigurationMethodValues() []HTTPConfigurationMethod

PossibleHTTPConfigurationMethodValues returns the possible values for the HTTPConfigurationMethod const type.

func (HTTPConfigurationMethod) ToPtr 

func (c HTTPConfigurationMethod) ToPtr() *HTTPConfigurationMethod

ToPtr returns a *HTTPConfigurationMethod pointing to the current value.

type HTTPHeader 

type HTTPHeader struct {
	// The name in HTTP header.
	Name *string `json:"name,omitempty"`

	// The value in HTTP header.
	Value *string `json:"value,omitempty"`
}

HTTPHeader - The HTTP header.

type HTTPMethod 

type HTTPMethod string

HTTPMethod - HTTP method. 

const (
	HTTPMethodGet HTTPMethod = "Get"
)

func PossibleHTTPMethodValues 

func PossibleHTTPMethodValues() []HTTPMethod

PossibleHTTPMethodValues returns the possible values for the HTTPMethod const type.

func (HTTPMethod) ToPtr 

func (c HTTPMethod) ToPtr() *HTTPMethod

ToPtr returns a *HTTPMethod pointing to the current value. 

type HopLink struct {
	// Hop link properties.
	Properties *HopLinkProperties `json:"properties,omitempty"`

	// READ-ONLY; Provides additional context on links.
	Context map[string]*string `json:"context,omitempty" azure:"ro"`

	// READ-ONLY; List of issues.
	Issues []*ConnectivityIssue `json:"issues,omitempty" azure:"ro"`

	// READ-ONLY; Link type.
	LinkType *string `json:"linkType,omitempty" azure:"ro"`

	// READ-ONLY; The ID of the next hop.
	NextHopID *string `json:"nextHopId,omitempty" azure:"ro"`

	// READ-ONLY; Resource ID.
	ResourceID *string `json:"resourceId,omitempty" azure:"ro"`
}

HopLink - Hop link.

func (HopLink) MarshalJSON 

func (h HopLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HopLink.

type HopLinkProperties 

type HopLinkProperties struct {
	// READ-ONLY; Average roundtrip time in milliseconds.
	RoundTripTimeAvg *int64 `json:"roundTripTimeAvg,omitempty" azure:"ro"`

	// READ-ONLY; Maximum roundtrip time in milliseconds.
	RoundTripTimeMax *int64 `json:"roundTripTimeMax,omitempty" azure:"ro"`

	// READ-ONLY; Minimum roundtrip time in milliseconds.
	RoundTripTimeMin *int64 `json:"roundTripTimeMin,omitempty" azure:"ro"`
}

HopLinkProperties - Hop link properties.

type HubBgpConnectionStatus 

type HubBgpConnectionStatus string

HubBgpConnectionStatus - The current state of the VirtualHub to Peer. 

const (
	HubBgpConnectionStatusConnected    HubBgpConnectionStatus = "Connected"
	HubBgpConnectionStatusConnecting   HubBgpConnectionStatus = "Connecting"
	HubBgpConnectionStatusNotConnected HubBgpConnectionStatus = "NotConnected"
	HubBgpConnectionStatusUnknown      HubBgpConnectionStatus = "Unknown"
)

func PossibleHubBgpConnectionStatusValues 

func PossibleHubBgpConnectionStatusValues() []HubBgpConnectionStatus

PossibleHubBgpConnectionStatusValues returns the possible values for the HubBgpConnectionStatus const type.

func (HubBgpConnectionStatus) ToPtr 

func (c HubBgpConnectionStatus) ToPtr() *HubBgpConnectionStatus

ToPtr returns a *HubBgpConnectionStatus pointing to the current value.

type HubIPAddresses 

type HubIPAddresses struct {
	// Private IP Address associated with azure firewall.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// Public IP addresses associated with azure firewall.
	PublicIPs *HubPublicIPAddresses `json:"publicIPs,omitempty"`
}

HubIPAddresses - IP addresses associated with azure firewall.

type HubIPConfiguration 

type HubIPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the Ip Configuration.
	Name *string `json:"name,omitempty"`

	// The properties of the Virtual Hub IPConfigurations.
	Properties *HubIPConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Ipconfiguration type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

HubIPConfiguration - IpConfigurations.

type HubIPConfigurationPropertiesFormat 

type HubIPConfigurationPropertiesFormat struct {
	// The private IP address of the IP configuration.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// The private IP address allocation method.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// The reference to the public IP resource.
	PublicIPAddress *PublicIPAddress `json:"publicIPAddress,omitempty"`

	// The reference to the subnet resource.
	Subnet *Subnet `json:"subnet,omitempty"`

	// READ-ONLY; The provisioning state of the IP configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

HubIPConfigurationPropertiesFormat - Properties of IP configuration.

type HubPublicIPAddresses 

type HubPublicIPAddresses struct {
	// The list of Public IP addresses associated with azure firewall or IP addresses to be retained.
	Addresses []*AzureFirewallPublicIPAddress `json:"addresses,omitempty"`

	// The number of Public IP addresses associated with azure firewall.
	Count *int32 `json:"count,omitempty"`
}

HubPublicIPAddresses - Public IP addresses associated with azure firewall.

func (HubPublicIPAddresses) MarshalJSON 

func (h HubPublicIPAddresses) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubPublicIPAddresses.

type HubRoute 

type HubRoute struct {
	// REQUIRED; The type of destinations (eg: CIDR, ResourceId, Service).
	DestinationType *string `json:"destinationType,omitempty"`

	// REQUIRED; List of all destinations.
	Destinations []*string `json:"destinations,omitempty"`

	// REQUIRED; The name of the Route that is unique within a RouteTable. This name can be used to access this route.
	Name *string `json:"name,omitempty"`

	// REQUIRED; NextHop resource ID.
	NextHop *string `json:"nextHop,omitempty"`

	// REQUIRED; The type of next hop (eg: ResourceId).
	NextHopType *string `json:"nextHopType,omitempty"`
}

HubRoute - RouteTable route.

func (HubRoute) MarshalJSON 

func (h HubRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubRoute.

type HubRouteTable 

type HubRouteTable struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the RouteTable resource.
	Properties *HubRouteTableProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

HubRouteTable - RouteTable resource in a virtual hub.

type HubRouteTableProperties 

type HubRouteTableProperties struct {
	// List of labels associated with this route table.
	Labels []*string `json:"labels,omitempty"`

	// List of all routes.
	Routes []*HubRoute `json:"routes,omitempty"`

	// READ-ONLY; List of all connections associated with this route table.
	AssociatedConnections []*string `json:"associatedConnections,omitempty" azure:"ro"`

	// READ-ONLY; List of all connections that advertise to this route table.
	PropagatingConnections []*string `json:"propagatingConnections,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the RouteTable resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

HubRouteTableProperties - Parameters for RouteTable.

func (HubRouteTableProperties) MarshalJSON 

func (h HubRouteTableProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubRouteTableProperties.

type HubRouteTablesClient 

type HubRouteTablesClient struct {
	// contains filtered or unexported fields
}

HubRouteTablesClient contains the methods for the HubRouteTables group. Don't use this type directly, use NewHubRouteTablesClient() instead.

func NewHubRouteTablesClient 

func NewHubRouteTablesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *HubRouteTablesClient

NewHubRouteTablesClient creates a new instance of HubRouteTablesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*HubRouteTablesClient) BeginCreateOrUpdate 

func (client *HubRouteTablesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualHubName string, routeTableName string, routeTableParameters HubRouteTable, options *HubRouteTablesClientBeginCreateOrUpdateOptions) (HubRouteTablesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a RouteTable resource if it doesn't exist else updates the existing RouteTable. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. routeTableName - The name of the RouteTable. routeTableParameters - Parameters supplied to create or update RouteTable. options - HubRouteTablesClientBeginCreateOrUpdateOptions contains the optional parameters for the HubRouteTablesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/HubRouteTablePut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewHubRouteTablesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<route-table-name>",
		armnetwork.HubRouteTable{
			Properties: &armnetwork.HubRouteTableProperties{
				Labels: []*string{
					to.StringPtr("label1"),
					to.StringPtr("label2")},
				Routes: []*armnetwork.HubRoute{
					{
						Name:            to.StringPtr("<name>"),
						DestinationType: to.StringPtr("<destination-type>"),
						Destinations: []*string{
							to.StringPtr("10.0.0.0/8"),
							to.StringPtr("20.0.0.0/8"),
							to.StringPtr("30.0.0.0/8")},
						NextHop:     to.StringPtr("<next-hop>"),
						NextHopType: to.StringPtr("<next-hop-type>"),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.HubRouteTablesClientCreateOrUpdateResult)
}

Output:

func (*HubRouteTablesClient) BeginDelete 

func (client *HubRouteTablesClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, routeTableName string, options *HubRouteTablesClientBeginDeleteOptions) (HubRouteTablesClientDeletePollerResponse, error)

BeginDelete - Deletes a RouteTable. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the RouteTable. virtualHubName - The name of the VirtualHub. routeTableName - The name of the RouteTable. options - HubRouteTablesClientBeginDeleteOptions contains the optional parameters for the HubRouteTablesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/HubRouteTableDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewHubRouteTablesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<route-table-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*HubRouteTablesClient) Get 

func (client *HubRouteTablesClient) Get(ctx context.Context, resourceGroupName string, virtualHubName string, routeTableName string, options *HubRouteTablesClientGetOptions) (HubRouteTablesClientGetResponse, error)

Get - Retrieves the details of a RouteTable. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. routeTableName - The name of the RouteTable. options - HubRouteTablesClientGetOptions contains the optional parameters for the HubRouteTablesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/HubRouteTableGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewHubRouteTablesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<route-table-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.HubRouteTablesClientGetResult)
}

Output:

func (*HubRouteTablesClient) List 

func (client *HubRouteTablesClient) List(resourceGroupName string, virtualHubName string, options *HubRouteTablesClientListOptions) *HubRouteTablesClientListPager

List - Retrieves the details of all RouteTables. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. options - HubRouteTablesClientListOptions contains the optional parameters for the HubRouteTablesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/HubRouteTableList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewHubRouteTablesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<virtual-hub-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type HubRouteTablesClientBeginCreateOrUpdateOptions added in v0.3.0 

type HubRouteTablesClientBeginCreateOrUpdateOptions struct {
}

HubRouteTablesClientBeginCreateOrUpdateOptions contains the optional parameters for the HubRouteTablesClient.BeginCreateOrUpdate method.

type HubRouteTablesClientBeginDeleteOptions added in v0.3.0 

type HubRouteTablesClientBeginDeleteOptions struct {
}

HubRouteTablesClientBeginDeleteOptions contains the optional parameters for the HubRouteTablesClient.BeginDelete method.

type HubRouteTablesClientCreateOrUpdatePoller added in v0.3.0 

type HubRouteTablesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

HubRouteTablesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*HubRouteTablesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *HubRouteTablesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*HubRouteTablesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *HubRouteTablesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (HubRouteTablesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final HubRouteTablesClientCreateOrUpdateResponse will be returned.

func (*HubRouteTablesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *HubRouteTablesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*HubRouteTablesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *HubRouteTablesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type HubRouteTablesClientCreateOrUpdatePollerResponse added in v0.3.0 

type HubRouteTablesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *HubRouteTablesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubRouteTablesClientCreateOrUpdatePollerResponse contains the response from method HubRouteTablesClient.CreateOrUpdate.

func (HubRouteTablesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l HubRouteTablesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (HubRouteTablesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*HubRouteTablesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *HubRouteTablesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *HubRouteTablesClient, token string) error

Resume rehydrates a HubRouteTablesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type HubRouteTablesClientCreateOrUpdateResponse added in v0.3.0 

type HubRouteTablesClientCreateOrUpdateResponse struct {
	HubRouteTablesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubRouteTablesClientCreateOrUpdateResponse contains the response from method HubRouteTablesClient.CreateOrUpdate.

type HubRouteTablesClientCreateOrUpdateResult added in v0.3.0 

type HubRouteTablesClientCreateOrUpdateResult struct {
	HubRouteTable
}

HubRouteTablesClientCreateOrUpdateResult contains the result from method HubRouteTablesClient.CreateOrUpdate.

type HubRouteTablesClientDeletePoller added in v0.3.0 

type HubRouteTablesClientDeletePoller struct {
	// contains filtered or unexported fields
}

HubRouteTablesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*HubRouteTablesClientDeletePoller) Done added in v0.3.0 

func (p *HubRouteTablesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*HubRouteTablesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *HubRouteTablesClientDeletePoller) FinalResponse(ctx context.Context) (HubRouteTablesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final HubRouteTablesClientDeleteResponse will be returned.

func (*HubRouteTablesClientDeletePoller) Poll added in v0.3.0 

func (p *HubRouteTablesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*HubRouteTablesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *HubRouteTablesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type HubRouteTablesClientDeletePollerResponse added in v0.3.0 

type HubRouteTablesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *HubRouteTablesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubRouteTablesClientDeletePollerResponse contains the response from method HubRouteTablesClient.Delete.

func (HubRouteTablesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l HubRouteTablesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (HubRouteTablesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*HubRouteTablesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *HubRouteTablesClientDeletePollerResponse) Resume(ctx context.Context, client *HubRouteTablesClient, token string) error

Resume rehydrates a HubRouteTablesClientDeletePollerResponse from the provided client and resume token.

type HubRouteTablesClientDeleteResponse added in v0.3.0 

type HubRouteTablesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubRouteTablesClientDeleteResponse contains the response from method HubRouteTablesClient.Delete.

type HubRouteTablesClientGetOptions added in v0.3.0 

type HubRouteTablesClientGetOptions struct {
}

HubRouteTablesClientGetOptions contains the optional parameters for the HubRouteTablesClient.Get method.

type HubRouteTablesClientGetResponse added in v0.3.0 

type HubRouteTablesClientGetResponse struct {
	HubRouteTablesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubRouteTablesClientGetResponse contains the response from method HubRouteTablesClient.Get.

type HubRouteTablesClientGetResult added in v0.3.0 

type HubRouteTablesClientGetResult struct {
	HubRouteTable
}

HubRouteTablesClientGetResult contains the result from method HubRouteTablesClient.Get.

type HubRouteTablesClientListOptions added in v0.3.0 

type HubRouteTablesClientListOptions struct {
}

HubRouteTablesClientListOptions contains the optional parameters for the HubRouteTablesClient.List method.

type HubRouteTablesClientListPager added in v0.3.0 

type HubRouteTablesClientListPager struct {
	// contains filtered or unexported fields
}

HubRouteTablesClientListPager provides operations for iterating over paged responses.

func (*HubRouteTablesClientListPager) Err added in v0.3.0 

func (p *HubRouteTablesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*HubRouteTablesClientListPager) NextPage added in v0.3.0 

func (p *HubRouteTablesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*HubRouteTablesClientListPager) PageResponse added in v0.3.0 

func (p *HubRouteTablesClientListPager) PageResponse() HubRouteTablesClientListResponse

PageResponse returns the current HubRouteTablesClientListResponse page.

type HubRouteTablesClientListResponse added in v0.3.0 

type HubRouteTablesClientListResponse struct {
	HubRouteTablesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubRouteTablesClientListResponse contains the response from method HubRouteTablesClient.List.

type HubRouteTablesClientListResult added in v0.3.0 

type HubRouteTablesClientListResult struct {
	ListHubRouteTablesResult
}

HubRouteTablesClientListResult contains the result from method HubRouteTablesClient.List.

type HubVirtualNetworkConnection 

type HubVirtualNetworkConnection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the hub virtual network connection.
	Properties *HubVirtualNetworkConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

HubVirtualNetworkConnection Resource.

type HubVirtualNetworkConnectionProperties 

type HubVirtualNetworkConnectionProperties struct {
	// Deprecated: VirtualHub to RemoteVnet transit to enabled or not.
	AllowHubToRemoteVnetTransit *bool `json:"allowHubToRemoteVnetTransit,omitempty"`

	// Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.
	AllowRemoteVnetToUseHubVnetGateways *bool `json:"allowRemoteVnetToUseHubVnetGateways,omitempty"`

	// Enable internet security.
	EnableInternetSecurity *bool `json:"enableInternetSecurity,omitempty"`

	// Reference to the remote virtual network.
	RemoteVirtualNetwork *SubResource `json:"remoteVirtualNetwork,omitempty"`

	// The Routing Configuration indicating the associated and propagated route tables on this connection.
	RoutingConfiguration *RoutingConfiguration `json:"routingConfiguration,omitempty"`

	// READ-ONLY; The provisioning state of the hub virtual network connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

HubVirtualNetworkConnectionProperties - Parameters for HubVirtualNetworkConnection.

type HubVirtualNetworkConnectionStatus 

type HubVirtualNetworkConnectionStatus string

HubVirtualNetworkConnectionStatus - The current state of the VirtualHub to vnet connection. 

const (
	HubVirtualNetworkConnectionStatusConnected    HubVirtualNetworkConnectionStatus = "Connected"
	HubVirtualNetworkConnectionStatusConnecting   HubVirtualNetworkConnectionStatus = "Connecting"
	HubVirtualNetworkConnectionStatusNotConnected HubVirtualNetworkConnectionStatus = "NotConnected"
	HubVirtualNetworkConnectionStatusUnknown      HubVirtualNetworkConnectionStatus = "Unknown"
)

func PossibleHubVirtualNetworkConnectionStatusValues 

func PossibleHubVirtualNetworkConnectionStatusValues() []HubVirtualNetworkConnectionStatus

PossibleHubVirtualNetworkConnectionStatusValues returns the possible values for the HubVirtualNetworkConnectionStatus const type.

func (HubVirtualNetworkConnectionStatus) ToPtr 

func (c HubVirtualNetworkConnectionStatus) ToPtr() *HubVirtualNetworkConnectionStatus

ToPtr returns a *HubVirtualNetworkConnectionStatus pointing to the current value.

type HubVirtualNetworkConnectionsClient 

type HubVirtualNetworkConnectionsClient struct {
	// contains filtered or unexported fields
}

HubVirtualNetworkConnectionsClient contains the methods for the HubVirtualNetworkConnections group. Don't use this type directly, use NewHubVirtualNetworkConnectionsClient() instead.

func NewHubVirtualNetworkConnectionsClient 

func NewHubVirtualNetworkConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *HubVirtualNetworkConnectionsClient

NewHubVirtualNetworkConnectionsClient creates a new instance of HubVirtualNetworkConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*HubVirtualNetworkConnectionsClient) BeginCreateOrUpdate 

func (client *HubVirtualNetworkConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualHubName string, connectionName string, hubVirtualNetworkConnectionParameters HubVirtualNetworkConnection, options *HubVirtualNetworkConnectionsClientBeginCreateOrUpdateOptions) (HubVirtualNetworkConnectionsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a hub virtual network connection if it doesn't exist else updates the existing one. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the HubVirtualNetworkConnection. virtualHubName - The name of the VirtualHub. connectionName - The name of the HubVirtualNetworkConnection. hubVirtualNetworkConnectionParameters - Parameters supplied to create or update a hub virtual network connection. options - HubVirtualNetworkConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/HubVirtualNetworkConnectionPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewHubVirtualNetworkConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<connection-name>",
		armnetwork.HubVirtualNetworkConnection{
			Properties: &armnetwork.HubVirtualNetworkConnectionProperties{
				EnableInternetSecurity: to.BoolPtr(false),
				RemoteVirtualNetwork: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
				RoutingConfiguration: &armnetwork.RoutingConfiguration{
					AssociatedRouteTable: &armnetwork.SubResource{
						ID: to.StringPtr("<id>"),
					},
					PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
						IDs: []*armnetwork.SubResource{
							{
								ID: to.StringPtr("<id>"),
							}},
						Labels: []*string{
							to.StringPtr("label1"),
							to.StringPtr("label2")},
					},
					VnetRoutes: &armnetwork.VnetRoute{
						StaticRoutes: []*armnetwork.StaticRoute{
							{
								Name: to.StringPtr("<name>"),
								AddressPrefixes: []*string{
									to.StringPtr("10.1.0.0/16"),
									to.StringPtr("10.2.0.0/16")},
								NextHopIPAddress: to.StringPtr("<next-hop-ipaddress>"),
							},
							{
								Name: to.StringPtr("<name>"),
								AddressPrefixes: []*string{
									to.StringPtr("10.3.0.0/16"),
									to.StringPtr("10.4.0.0/16")},
								NextHopIPAddress: to.StringPtr("<next-hop-ipaddress>"),
							}},
					},
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.HubVirtualNetworkConnectionsClientCreateOrUpdateResult)
}

Output:

func (*HubVirtualNetworkConnectionsClient) BeginDelete 

func (client *HubVirtualNetworkConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, connectionName string, options *HubVirtualNetworkConnectionsClientBeginDeleteOptions) (HubVirtualNetworkConnectionsClientDeletePollerResponse, error)

BeginDelete - Deletes a HubVirtualNetworkConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. connectionName - The name of the HubVirtualNetworkConnection. options - HubVirtualNetworkConnectionsClientBeginDeleteOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/HubVirtualNetworkConnectionDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewHubVirtualNetworkConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*HubVirtualNetworkConnectionsClient) Get 

func (client *HubVirtualNetworkConnectionsClient) Get(ctx context.Context, resourceGroupName string, virtualHubName string, connectionName string, options *HubVirtualNetworkConnectionsClientGetOptions) (HubVirtualNetworkConnectionsClientGetResponse, error)

Get - Retrieves the details of a HubVirtualNetworkConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. connectionName - The name of the vpn connection. options - HubVirtualNetworkConnectionsClientGetOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/HubVirtualNetworkConnectionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewHubVirtualNetworkConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.HubVirtualNetworkConnectionsClientGetResult)
}

Output:

func (*HubVirtualNetworkConnectionsClient) List 

func (client *HubVirtualNetworkConnectionsClient) List(resourceGroupName string, virtualHubName string, options *HubVirtualNetworkConnectionsClientListOptions) *HubVirtualNetworkConnectionsClientListPager

List - Retrieves the details of all HubVirtualNetworkConnections. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. options - HubVirtualNetworkConnectionsClientListOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/HubVirtualNetworkConnectionList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewHubVirtualNetworkConnectionsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<virtual-hub-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type HubVirtualNetworkConnectionsClientBeginCreateOrUpdateOptions added in v0.3.0 

type HubVirtualNetworkConnectionsClientBeginCreateOrUpdateOptions struct {
}

HubVirtualNetworkConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.BeginCreateOrUpdate method.

type HubVirtualNetworkConnectionsClientBeginDeleteOptions added in v0.3.0 

type HubVirtualNetworkConnectionsClientBeginDeleteOptions struct {
}

HubVirtualNetworkConnectionsClientBeginDeleteOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.BeginDelete method.

type HubVirtualNetworkConnectionsClientCreateOrUpdatePoller added in v0.3.0 

type HubVirtualNetworkConnectionsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

HubVirtualNetworkConnectionsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*HubVirtualNetworkConnectionsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*HubVirtualNetworkConnectionsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (HubVirtualNetworkConnectionsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final HubVirtualNetworkConnectionsClientCreateOrUpdateResponse will be returned.

func (*HubVirtualNetworkConnectionsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*HubVirtualNetworkConnectionsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type HubVirtualNetworkConnectionsClientCreateOrUpdatePollerResponse added in v0.3.0 

type HubVirtualNetworkConnectionsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *HubVirtualNetworkConnectionsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubVirtualNetworkConnectionsClientCreateOrUpdatePollerResponse contains the response from method HubVirtualNetworkConnectionsClient.CreateOrUpdate.

func (HubVirtualNetworkConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l HubVirtualNetworkConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (HubVirtualNetworkConnectionsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*HubVirtualNetworkConnectionsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *HubVirtualNetworkConnectionsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *HubVirtualNetworkConnectionsClient, token string) error

Resume rehydrates a HubVirtualNetworkConnectionsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type HubVirtualNetworkConnectionsClientCreateOrUpdateResponse added in v0.3.0 

type HubVirtualNetworkConnectionsClientCreateOrUpdateResponse struct {
	HubVirtualNetworkConnectionsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubVirtualNetworkConnectionsClientCreateOrUpdateResponse contains the response from method HubVirtualNetworkConnectionsClient.CreateOrUpdate.

type HubVirtualNetworkConnectionsClientCreateOrUpdateResult added in v0.3.0 

type HubVirtualNetworkConnectionsClientCreateOrUpdateResult struct {
	HubVirtualNetworkConnection
}

HubVirtualNetworkConnectionsClientCreateOrUpdateResult contains the result from method HubVirtualNetworkConnectionsClient.CreateOrUpdate.

type HubVirtualNetworkConnectionsClientDeletePoller added in v0.3.0 

type HubVirtualNetworkConnectionsClientDeletePoller struct {
	// contains filtered or unexported fields
}

HubVirtualNetworkConnectionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*HubVirtualNetworkConnectionsClientDeletePoller) Done added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*HubVirtualNetworkConnectionsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (HubVirtualNetworkConnectionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final HubVirtualNetworkConnectionsClientDeleteResponse will be returned.

func (*HubVirtualNetworkConnectionsClientDeletePoller) Poll added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*HubVirtualNetworkConnectionsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type HubVirtualNetworkConnectionsClientDeletePollerResponse added in v0.3.0 

type HubVirtualNetworkConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *HubVirtualNetworkConnectionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubVirtualNetworkConnectionsClientDeletePollerResponse contains the response from method HubVirtualNetworkConnectionsClient.Delete.

func (HubVirtualNetworkConnectionsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l HubVirtualNetworkConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (HubVirtualNetworkConnectionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*HubVirtualNetworkConnectionsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *HubVirtualNetworkConnectionsClientDeletePollerResponse) Resume(ctx context.Context, client *HubVirtualNetworkConnectionsClient, token string) error

Resume rehydrates a HubVirtualNetworkConnectionsClientDeletePollerResponse from the provided client and resume token.

type HubVirtualNetworkConnectionsClientDeleteResponse added in v0.3.0 

type HubVirtualNetworkConnectionsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubVirtualNetworkConnectionsClientDeleteResponse contains the response from method HubVirtualNetworkConnectionsClient.Delete.

type HubVirtualNetworkConnectionsClientGetOptions added in v0.3.0 

type HubVirtualNetworkConnectionsClientGetOptions struct {
}

HubVirtualNetworkConnectionsClientGetOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.Get method.

type HubVirtualNetworkConnectionsClientGetResponse added in v0.3.0 

type HubVirtualNetworkConnectionsClientGetResponse struct {
	HubVirtualNetworkConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubVirtualNetworkConnectionsClientGetResponse contains the response from method HubVirtualNetworkConnectionsClient.Get.

type HubVirtualNetworkConnectionsClientGetResult added in v0.3.0 

type HubVirtualNetworkConnectionsClientGetResult struct {
	HubVirtualNetworkConnection
}

HubVirtualNetworkConnectionsClientGetResult contains the result from method HubVirtualNetworkConnectionsClient.Get.

type HubVirtualNetworkConnectionsClientListOptions added in v0.3.0 

type HubVirtualNetworkConnectionsClientListOptions struct {
}

HubVirtualNetworkConnectionsClientListOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.List method.

type HubVirtualNetworkConnectionsClientListPager added in v0.3.0 

type HubVirtualNetworkConnectionsClientListPager struct {
	// contains filtered or unexported fields
}

HubVirtualNetworkConnectionsClientListPager provides operations for iterating over paged responses.

func (*HubVirtualNetworkConnectionsClientListPager) Err added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*HubVirtualNetworkConnectionsClientListPager) NextPage added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*HubVirtualNetworkConnectionsClientListPager) PageResponse added in v0.3.0 

func (p *HubVirtualNetworkConnectionsClientListPager) PageResponse() HubVirtualNetworkConnectionsClientListResponse

PageResponse returns the current HubVirtualNetworkConnectionsClientListResponse page.

type HubVirtualNetworkConnectionsClientListResponse added in v0.3.0 

type HubVirtualNetworkConnectionsClientListResponse struct {
	HubVirtualNetworkConnectionsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

HubVirtualNetworkConnectionsClientListResponse contains the response from method HubVirtualNetworkConnectionsClient.List.

type HubVirtualNetworkConnectionsClientListResult added in v0.3.0 

type HubVirtualNetworkConnectionsClientListResult struct {
	ListHubVirtualNetworkConnectionsResult
}

HubVirtualNetworkConnectionsClientListResult contains the result from method HubVirtualNetworkConnectionsClient.List.

type IDPSQueryObject added in v0.2.0 

type IDPSQueryObject struct {
	// Contain all filters names and values
	Filters []*FilterItems `json:"filters,omitempty"`

	// Column to sort response by
	OrderBy *OrderBy `json:"orderBy,omitempty"`

	// The number of the results to return in each page
	ResultsPerPage *int32 `json:"resultsPerPage,omitempty"`

	// Search term in all columns
	Search *string `json:"search,omitempty"`

	// The number of records matching the filter to skip
	Skip *int32 `json:"skip,omitempty"`
}

IDPSQueryObject - Will describe the query to run against the IDPS signatures DB

func (IDPSQueryObject) MarshalJSON added in v0.2.0 

func (i IDPSQueryObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IDPSQueryObject.

type IPAddressAvailabilityResult 

type IPAddressAvailabilityResult struct {
	// Private IP address availability.
	Available *bool `json:"available,omitempty"`

	// Contains other available private IP addresses if the asked for address is taken.
	AvailableIPAddresses []*string `json:"availableIPAddresses,omitempty"`

	// Private IP address platform reserved.
	IsPlatformReserved *bool `json:"isPlatformReserved,omitempty"`
}

IPAddressAvailabilityResult - Response for CheckIPAddressAvailability API service call.

func (IPAddressAvailabilityResult) MarshalJSON 

func (i IPAddressAvailabilityResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPAddressAvailabilityResult.

type IPAllocation 

type IPAllocation struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the IpAllocation.
	Properties *IPAllocationPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

IPAllocation - IpAllocation resource.

func (IPAllocation) MarshalJSON 

func (i IPAllocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPAllocation.

type IPAllocationListResult 

type IPAllocationListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of IpAllocation resources.
	Value []*IPAllocation `json:"value,omitempty"`
}

IPAllocationListResult - Response for the ListIpAllocations API service call.

func (IPAllocationListResult) MarshalJSON 

func (i IPAllocationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPAllocationListResult.

type IPAllocationMethod 

type IPAllocationMethod string

IPAllocationMethod - IP address allocation method. 

const (
	IPAllocationMethodDynamic IPAllocationMethod = "Dynamic"
	IPAllocationMethodStatic  IPAllocationMethod = "Static"
)

func PossibleIPAllocationMethodValues 

func PossibleIPAllocationMethodValues() []IPAllocationMethod

PossibleIPAllocationMethodValues returns the possible values for the IPAllocationMethod const type.

func (IPAllocationMethod) ToPtr 

func (c IPAllocationMethod) ToPtr() *IPAllocationMethod

ToPtr returns a *IPAllocationMethod pointing to the current value.

type IPAllocationPropertiesFormat 

type IPAllocationPropertiesFormat struct {
	// IpAllocation tags.
	AllocationTags map[string]*string `json:"allocationTags,omitempty"`

	// The IPAM allocation ID.
	IpamAllocationID *string `json:"ipamAllocationId,omitempty"`

	// The address prefix for the IpAllocation.
	Prefix *string `json:"prefix,omitempty"`

	// The address prefix length for the IpAllocation.
	PrefixLength *int32 `json:"prefixLength,omitempty"`

	// The address prefix Type for the IpAllocation.
	PrefixType *IPVersion `json:"prefixType,omitempty"`

	// The type for the IpAllocation.
	Type *IPAllocationType `json:"type,omitempty"`

	// READ-ONLY; The Subnet that using the prefix of this IpAllocation resource.
	Subnet *SubResource `json:"subnet,omitempty" azure:"ro"`

	// READ-ONLY; The VirtualNetwork that using the prefix of this IpAllocation resource.
	VirtualNetwork *SubResource `json:"virtualNetwork,omitempty" azure:"ro"`
}

IPAllocationPropertiesFormat - Properties of the IpAllocation.

func (IPAllocationPropertiesFormat) MarshalJSON 

func (i IPAllocationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPAllocationPropertiesFormat.

type IPAllocationType 

type IPAllocationType string

IPAllocationType - IpAllocation type. 

const (
	IPAllocationTypeHypernet  IPAllocationType = "Hypernet"
	IPAllocationTypeUndefined IPAllocationType = "Undefined"
)

func PossibleIPAllocationTypeValues 

func PossibleIPAllocationTypeValues() []IPAllocationType

PossibleIPAllocationTypeValues returns the possible values for the IPAllocationType const type.

func (IPAllocationType) ToPtr 

func (c IPAllocationType) ToPtr() *IPAllocationType

ToPtr returns a *IPAllocationType pointing to the current value.

type IPAllocationsClient 

type IPAllocationsClient struct {
	// contains filtered or unexported fields
}

IPAllocationsClient contains the methods for the IPAllocations group. Don't use this type directly, use NewIPAllocationsClient() instead.

func NewIPAllocationsClient 

func NewIPAllocationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *IPAllocationsClient

NewIPAllocationsClient creates a new instance of IPAllocationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*IPAllocationsClient) BeginCreateOrUpdate 

func (client *IPAllocationsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, ipAllocationName string, parameters IPAllocation, options *IPAllocationsClientBeginCreateOrUpdateOptions) (IPAllocationsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates an IpAllocation in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ipAllocationName - The name of the IpAllocation. parameters - Parameters supplied to the create or update virtual network operation. options - IPAllocationsClientBeginCreateOrUpdateOptions contains the optional parameters for the IPAllocationsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpAllocationCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPAllocationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<ip-allocation-name>",
		armnetwork.IPAllocation{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.IPAllocationPropertiesFormat{
				Type: armnetwork.IPAllocationType("Hypernet").ToPtr(),
				AllocationTags: map[string]*string{
					"VNetID": to.StringPtr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1"),
				},
				Prefix: to.StringPtr("<prefix>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.IPAllocationsClientCreateOrUpdateResult)
}

Output:

func (*IPAllocationsClient) BeginDelete 

func (client *IPAllocationsClient) BeginDelete(ctx context.Context, resourceGroupName string, ipAllocationName string, options *IPAllocationsClientBeginDeleteOptions) (IPAllocationsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified IpAllocation. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ipAllocationName - The name of the IpAllocation. options - IPAllocationsClientBeginDeleteOptions contains the optional parameters for the IPAllocationsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpAllocationDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPAllocationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<ip-allocation-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*IPAllocationsClient) Get 

func (client *IPAllocationsClient) Get(ctx context.Context, resourceGroupName string, ipAllocationName string, options *IPAllocationsClientGetOptions) (IPAllocationsClientGetResponse, error)

Get - Gets the specified IpAllocation by resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ipAllocationName - The name of the IpAllocation. options - IPAllocationsClientGetOptions contains the optional parameters for the IPAllocationsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpAllocationGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPAllocationsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<ip-allocation-name>",
		&armnetwork.IPAllocationsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.IPAllocationsClientGetResult)
}

Output:

func (*IPAllocationsClient) List 

func (client *IPAllocationsClient) List(options *IPAllocationsClientListOptions) *IPAllocationsClientListPager

List - Gets all IpAllocations in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - IPAllocationsClientListOptions contains the optional parameters for the IPAllocationsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpAllocationList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPAllocationsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*IPAllocationsClient) ListByResourceGroup 

func (client *IPAllocationsClient) ListByResourceGroup(resourceGroupName string, options *IPAllocationsClientListByResourceGroupOptions) *IPAllocationsClientListByResourceGroupPager

ListByResourceGroup - Gets all IpAllocations in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - IPAllocationsClientListByResourceGroupOptions contains the optional parameters for the IPAllocationsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpAllocationListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPAllocationsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*IPAllocationsClient) UpdateTags 

func (client *IPAllocationsClient) UpdateTags(ctx context.Context, resourceGroupName string, ipAllocationName string, parameters TagsObject, options *IPAllocationsClientUpdateTagsOptions) (IPAllocationsClientUpdateTagsResponse, error)

UpdateTags - Updates a IpAllocation tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ipAllocationName - The name of the IpAllocation. parameters - Parameters supplied to update IpAllocation tags. options - IPAllocationsClientUpdateTagsOptions contains the optional parameters for the IPAllocationsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpAllocationUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPAllocationsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<ip-allocation-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.IPAllocationsClientUpdateTagsResult)
}

Output:

type IPAllocationsClientBeginCreateOrUpdateOptions added in v0.3.0 

type IPAllocationsClientBeginCreateOrUpdateOptions struct {
}

IPAllocationsClientBeginCreateOrUpdateOptions contains the optional parameters for the IPAllocationsClient.BeginCreateOrUpdate method.

type IPAllocationsClientBeginDeleteOptions added in v0.3.0 

type IPAllocationsClientBeginDeleteOptions struct {
}

IPAllocationsClientBeginDeleteOptions contains the optional parameters for the IPAllocationsClient.BeginDelete method.

type IPAllocationsClientCreateOrUpdatePoller added in v0.3.0 

type IPAllocationsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

IPAllocationsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*IPAllocationsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *IPAllocationsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*IPAllocationsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *IPAllocationsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (IPAllocationsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IPAllocationsClientCreateOrUpdateResponse will be returned.

func (*IPAllocationsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *IPAllocationsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IPAllocationsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *IPAllocationsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IPAllocationsClientCreateOrUpdatePollerResponse added in v0.3.0 

type IPAllocationsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IPAllocationsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPAllocationsClientCreateOrUpdatePollerResponse contains the response from method IPAllocationsClient.CreateOrUpdate.

func (IPAllocationsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l IPAllocationsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IPAllocationsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*IPAllocationsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *IPAllocationsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *IPAllocationsClient, token string) error

Resume rehydrates a IPAllocationsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type IPAllocationsClientCreateOrUpdateResponse added in v0.3.0 

type IPAllocationsClientCreateOrUpdateResponse struct {
	IPAllocationsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPAllocationsClientCreateOrUpdateResponse contains the response from method IPAllocationsClient.CreateOrUpdate.

type IPAllocationsClientCreateOrUpdateResult added in v0.3.0 

type IPAllocationsClientCreateOrUpdateResult struct {
	IPAllocation
}

IPAllocationsClientCreateOrUpdateResult contains the result from method IPAllocationsClient.CreateOrUpdate.

type IPAllocationsClientDeletePoller added in v0.3.0 

type IPAllocationsClientDeletePoller struct {
	// contains filtered or unexported fields
}

IPAllocationsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*IPAllocationsClientDeletePoller) Done added in v0.3.0 

func (p *IPAllocationsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*IPAllocationsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *IPAllocationsClientDeletePoller) FinalResponse(ctx context.Context) (IPAllocationsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IPAllocationsClientDeleteResponse will be returned.

func (*IPAllocationsClientDeletePoller) Poll added in v0.3.0 

func (p *IPAllocationsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IPAllocationsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *IPAllocationsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IPAllocationsClientDeletePollerResponse added in v0.3.0 

type IPAllocationsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IPAllocationsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPAllocationsClientDeletePollerResponse contains the response from method IPAllocationsClient.Delete.

func (IPAllocationsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l IPAllocationsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IPAllocationsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*IPAllocationsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *IPAllocationsClientDeletePollerResponse) Resume(ctx context.Context, client *IPAllocationsClient, token string) error

Resume rehydrates a IPAllocationsClientDeletePollerResponse from the provided client and resume token.

type IPAllocationsClientDeleteResponse added in v0.3.0 

type IPAllocationsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPAllocationsClientDeleteResponse contains the response from method IPAllocationsClient.Delete.

type IPAllocationsClientGetOptions added in v0.3.0 

type IPAllocationsClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

IPAllocationsClientGetOptions contains the optional parameters for the IPAllocationsClient.Get method.

type IPAllocationsClientGetResponse added in v0.3.0 

type IPAllocationsClientGetResponse struct {
	IPAllocationsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPAllocationsClientGetResponse contains the response from method IPAllocationsClient.Get.

type IPAllocationsClientGetResult added in v0.3.0 

type IPAllocationsClientGetResult struct {
	IPAllocation
}

IPAllocationsClientGetResult contains the result from method IPAllocationsClient.Get.

type IPAllocationsClientListByResourceGroupOptions added in v0.3.0 

type IPAllocationsClientListByResourceGroupOptions struct {
}

IPAllocationsClientListByResourceGroupOptions contains the optional parameters for the IPAllocationsClient.ListByResourceGroup method.

type IPAllocationsClientListByResourceGroupPager added in v0.3.0 

type IPAllocationsClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

IPAllocationsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*IPAllocationsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *IPAllocationsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*IPAllocationsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *IPAllocationsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IPAllocationsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *IPAllocationsClientListByResourceGroupPager) PageResponse() IPAllocationsClientListByResourceGroupResponse

PageResponse returns the current IPAllocationsClientListByResourceGroupResponse page.

type IPAllocationsClientListByResourceGroupResponse added in v0.3.0 

type IPAllocationsClientListByResourceGroupResponse struct {
	IPAllocationsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPAllocationsClientListByResourceGroupResponse contains the response from method IPAllocationsClient.ListByResourceGroup.

type IPAllocationsClientListByResourceGroupResult added in v0.3.0 

type IPAllocationsClientListByResourceGroupResult struct {
	IPAllocationListResult
}

IPAllocationsClientListByResourceGroupResult contains the result from method IPAllocationsClient.ListByResourceGroup.

type IPAllocationsClientListOptions added in v0.3.0 

type IPAllocationsClientListOptions struct {
}

IPAllocationsClientListOptions contains the optional parameters for the IPAllocationsClient.List method.

type IPAllocationsClientListPager added in v0.3.0 

type IPAllocationsClientListPager struct {
	// contains filtered or unexported fields
}

IPAllocationsClientListPager provides operations for iterating over paged responses.

func (*IPAllocationsClientListPager) Err added in v0.3.0 

func (p *IPAllocationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*IPAllocationsClientListPager) NextPage added in v0.3.0 

func (p *IPAllocationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IPAllocationsClientListPager) PageResponse added in v0.3.0 

func (p *IPAllocationsClientListPager) PageResponse() IPAllocationsClientListResponse

PageResponse returns the current IPAllocationsClientListResponse page.

type IPAllocationsClientListResponse added in v0.3.0 

type IPAllocationsClientListResponse struct {
	IPAllocationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPAllocationsClientListResponse contains the response from method IPAllocationsClient.List.

type IPAllocationsClientListResult added in v0.3.0 

type IPAllocationsClientListResult struct {
	IPAllocationListResult
}

IPAllocationsClientListResult contains the result from method IPAllocationsClient.List.

type IPAllocationsClientUpdateTagsOptions added in v0.3.0 

type IPAllocationsClientUpdateTagsOptions struct {
}

IPAllocationsClientUpdateTagsOptions contains the optional parameters for the IPAllocationsClient.UpdateTags method.

type IPAllocationsClientUpdateTagsResponse added in v0.3.0 

type IPAllocationsClientUpdateTagsResponse struct {
	IPAllocationsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPAllocationsClientUpdateTagsResponse contains the response from method IPAllocationsClient.UpdateTags.

type IPAllocationsClientUpdateTagsResult added in v0.3.0 

type IPAllocationsClientUpdateTagsResult struct {
	IPAllocation
}

IPAllocationsClientUpdateTagsResult contains the result from method IPAllocationsClient.UpdateTags.

type IPConfiguration 

type IPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the IP configuration.
	Properties *IPConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

IPConfiguration - IP configuration.

type IPConfigurationBgpPeeringAddress 

type IPConfigurationBgpPeeringAddress struct {
	// The list of custom BGP peering addresses which belong to IP configuration.
	CustomBgpIPAddresses []*string `json:"customBgpIpAddresses,omitempty"`

	// The ID of IP configuration which belongs to gateway.
	IPConfigurationID *string `json:"ipconfigurationId,omitempty"`

	// READ-ONLY; The list of default BGP peering addresses which belong to IP configuration.
	DefaultBgpIPAddresses []*string `json:"defaultBgpIpAddresses,omitempty" azure:"ro"`

	// READ-ONLY; The list of tunnel public IP addresses which belong to IP configuration.
	TunnelIPAddresses []*string `json:"tunnelIpAddresses,omitempty" azure:"ro"`
}

IPConfigurationBgpPeeringAddress - Properties of IPConfigurationBgpPeeringAddress.

func (IPConfigurationBgpPeeringAddress) MarshalJSON 

func (i IPConfigurationBgpPeeringAddress) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPConfigurationBgpPeeringAddress.

type IPConfigurationProfile 

type IPConfigurationProfile struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of the IP configuration profile.
	Properties *IPConfigurationProfilePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Sub Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

IPConfigurationProfile - IP configuration profile child resource.

type IPConfigurationProfilePropertiesFormat 

type IPConfigurationProfilePropertiesFormat struct {
	// The reference to the subnet resource to create a container network interface ip configuration.
	Subnet *Subnet `json:"subnet,omitempty"`

	// READ-ONLY; The provisioning state of the IP configuration profile resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

IPConfigurationProfilePropertiesFormat - IP configuration profile properties.

type IPConfigurationPropertiesFormat 

type IPConfigurationPropertiesFormat struct {
	// The private IP address of the IP configuration.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// The private IP address allocation method.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// The reference to the public IP resource.
	PublicIPAddress *PublicIPAddress `json:"publicIPAddress,omitempty"`

	// The reference to the subnet resource.
	Subnet *Subnet `json:"subnet,omitempty"`

	// READ-ONLY; The provisioning state of the IP configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

IPConfigurationPropertiesFormat - Properties of IP configuration.

type IPFlowProtocol 

type IPFlowProtocol string

IPFlowProtocol - Protocol to be verified on. 

const (
	IPFlowProtocolTCP IPFlowProtocol = "TCP"
	IPFlowProtocolUDP IPFlowProtocol = "UDP"
)

func PossibleIPFlowProtocolValues 

func PossibleIPFlowProtocolValues() []IPFlowProtocol

PossibleIPFlowProtocolValues returns the possible values for the IPFlowProtocol const type.

func (IPFlowProtocol) ToPtr 

func (c IPFlowProtocol) ToPtr() *IPFlowProtocol

ToPtr returns a *IPFlowProtocol pointing to the current value.

type IPGroup 

type IPGroup struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the IpGroups.
	Properties *IPGroupPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

IPGroup - The IpGroups resource information.

func (IPGroup) MarshalJSON 

func (i IPGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPGroup.

type IPGroupListResult 

type IPGroupListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of IpGroups information resources.
	Value []*IPGroup `json:"value,omitempty"`
}

IPGroupListResult - Response for the ListIpGroups API service call.

func (IPGroupListResult) MarshalJSON 

func (i IPGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPGroupListResult.

type IPGroupPropertiesFormat 

type IPGroupPropertiesFormat struct {
	// IpAddresses/IpAddressPrefixes in the IpGroups resource.
	IPAddresses []*string `json:"ipAddresses,omitempty"`

	// READ-ONLY; List of references to Firewall Policies resources that this IpGroups is associated with.
	FirewallPolicies []*SubResource `json:"firewallPolicies,omitempty" azure:"ro"`

	// READ-ONLY; List of references to Firewall resources that this IpGroups is associated with.
	Firewalls []*SubResource `json:"firewalls,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the IpGroups resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

IPGroupPropertiesFormat - The IpGroups property information.

func (IPGroupPropertiesFormat) MarshalJSON 

func (i IPGroupPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPGroupPropertiesFormat.

type IPGroupsClient 

type IPGroupsClient struct {
	// contains filtered or unexported fields
}

IPGroupsClient contains the methods for the IPGroups group. Don't use this type directly, use NewIPGroupsClient() instead.

func NewIPGroupsClient 

func NewIPGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *IPGroupsClient

NewIPGroupsClient creates a new instance of IPGroupsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*IPGroupsClient) BeginCreateOrUpdate 

func (client *IPGroupsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, ipGroupsName string, parameters IPGroup, options *IPGroupsClientBeginCreateOrUpdateOptions) (IPGroupsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates an ipGroups in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ipGroupsName - The name of the ipGroups. parameters - Parameters supplied to the create or update IpGroups operation. options - IPGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the IPGroupsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpGroupsCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<ip-groups-name>",
		armnetwork.IPGroup{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.IPGroupPropertiesFormat{
				IPAddresses: []*string{
					to.StringPtr("13.64.39.16/32"),
					to.StringPtr("40.74.146.80/31"),
					to.StringPtr("40.74.147.32/28")},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.IPGroupsClientCreateOrUpdateResult)
}

Output:

func (*IPGroupsClient) BeginDelete 

func (client *IPGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, ipGroupsName string, options *IPGroupsClientBeginDeleteOptions) (IPGroupsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified ipGroups. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ipGroupsName - The name of the ipGroups. options - IPGroupsClientBeginDeleteOptions contains the optional parameters for the IPGroupsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpGroupsDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<ip-groups-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*IPGroupsClient) Get 

func (client *IPGroupsClient) Get(ctx context.Context, resourceGroupName string, ipGroupsName string, options *IPGroupsClientGetOptions) (IPGroupsClientGetResponse, error)

Get - Gets the specified ipGroups. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ipGroupsName - The name of the ipGroups. options - IPGroupsClientGetOptions contains the optional parameters for the IPGroupsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpGroupsGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPGroupsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<ip-groups-name>",
		&armnetwork.IPGroupsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.IPGroupsClientGetResult)
}

Output:

func (*IPGroupsClient) List 

func (client *IPGroupsClient) List(options *IPGroupsClientListOptions) *IPGroupsClientListPager

List - Gets all IpGroups in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - IPGroupsClientListOptions contains the optional parameters for the IPGroupsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpGroupsListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPGroupsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*IPGroupsClient) ListByResourceGroup 

func (client *IPGroupsClient) ListByResourceGroup(resourceGroupName string, options *IPGroupsClientListByResourceGroupOptions) *IPGroupsClientListByResourceGroupPager

ListByResourceGroup - Gets all IpGroups in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - IPGroupsClientListByResourceGroupOptions contains the optional parameters for the IPGroupsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpGroupsListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPGroupsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*IPGroupsClient) UpdateGroups 

func (client *IPGroupsClient) UpdateGroups(ctx context.Context, resourceGroupName string, ipGroupsName string, parameters TagsObject, options *IPGroupsClientUpdateGroupsOptions) (IPGroupsClientUpdateGroupsResponse, error)

UpdateGroups - Updates tags of an IpGroups resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. ipGroupsName - The name of the ipGroups. parameters - Parameters supplied to the update ipGroups operation. options - IPGroupsClientUpdateGroupsOptions contains the optional parameters for the IPGroupsClient.UpdateGroups method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/IpGroupsUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewIPGroupsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateGroups(ctx,
		"<resource-group-name>",
		"<ip-groups-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
				"key2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.IPGroupsClientUpdateGroupsResult)
}

Output:

type IPGroupsClientBeginCreateOrUpdateOptions added in v0.3.0 

type IPGroupsClientBeginCreateOrUpdateOptions struct {
}

IPGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the IPGroupsClient.BeginCreateOrUpdate method.

type IPGroupsClientBeginDeleteOptions added in v0.3.0 

type IPGroupsClientBeginDeleteOptions struct {
}

IPGroupsClientBeginDeleteOptions contains the optional parameters for the IPGroupsClient.BeginDelete method.

type IPGroupsClientCreateOrUpdatePoller added in v0.3.0 

type IPGroupsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

IPGroupsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*IPGroupsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *IPGroupsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*IPGroupsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *IPGroupsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (IPGroupsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IPGroupsClientCreateOrUpdateResponse will be returned.

func (*IPGroupsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *IPGroupsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IPGroupsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *IPGroupsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IPGroupsClientCreateOrUpdatePollerResponse added in v0.3.0 

type IPGroupsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IPGroupsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPGroupsClientCreateOrUpdatePollerResponse contains the response from method IPGroupsClient.CreateOrUpdate.

func (IPGroupsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l IPGroupsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IPGroupsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*IPGroupsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *IPGroupsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *IPGroupsClient, token string) error

Resume rehydrates a IPGroupsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type IPGroupsClientCreateOrUpdateResponse added in v0.3.0 

type IPGroupsClientCreateOrUpdateResponse struct {
	IPGroupsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPGroupsClientCreateOrUpdateResponse contains the response from method IPGroupsClient.CreateOrUpdate.

type IPGroupsClientCreateOrUpdateResult added in v0.3.0 

type IPGroupsClientCreateOrUpdateResult struct {
	IPGroup
}

IPGroupsClientCreateOrUpdateResult contains the result from method IPGroupsClient.CreateOrUpdate.

type IPGroupsClientDeletePoller added in v0.3.0 

type IPGroupsClientDeletePoller struct {
	// contains filtered or unexported fields
}

IPGroupsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*IPGroupsClientDeletePoller) Done added in v0.3.0 

func (p *IPGroupsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*IPGroupsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *IPGroupsClientDeletePoller) FinalResponse(ctx context.Context) (IPGroupsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final IPGroupsClientDeleteResponse will be returned.

func (*IPGroupsClientDeletePoller) Poll added in v0.3.0 

func (p *IPGroupsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*IPGroupsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *IPGroupsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type IPGroupsClientDeletePollerResponse added in v0.3.0 

type IPGroupsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *IPGroupsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPGroupsClientDeletePollerResponse contains the response from method IPGroupsClient.Delete.

func (IPGroupsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l IPGroupsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (IPGroupsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*IPGroupsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *IPGroupsClientDeletePollerResponse) Resume(ctx context.Context, client *IPGroupsClient, token string) error

Resume rehydrates a IPGroupsClientDeletePollerResponse from the provided client and resume token.

type IPGroupsClientDeleteResponse added in v0.3.0 

type IPGroupsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPGroupsClientDeleteResponse contains the response from method IPGroupsClient.Delete.

type IPGroupsClientGetOptions added in v0.3.0 

type IPGroupsClientGetOptions struct {
	// Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource.
	Expand *string
}

IPGroupsClientGetOptions contains the optional parameters for the IPGroupsClient.Get method.

type IPGroupsClientGetResponse added in v0.3.0 

type IPGroupsClientGetResponse struct {
	IPGroupsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPGroupsClientGetResponse contains the response from method IPGroupsClient.Get.

type IPGroupsClientGetResult added in v0.3.0 

type IPGroupsClientGetResult struct {
	IPGroup
}

IPGroupsClientGetResult contains the result from method IPGroupsClient.Get.

type IPGroupsClientListByResourceGroupOptions added in v0.3.0 

type IPGroupsClientListByResourceGroupOptions struct {
}

IPGroupsClientListByResourceGroupOptions contains the optional parameters for the IPGroupsClient.ListByResourceGroup method.

type IPGroupsClientListByResourceGroupPager added in v0.3.0 

type IPGroupsClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

IPGroupsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*IPGroupsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *IPGroupsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*IPGroupsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *IPGroupsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IPGroupsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *IPGroupsClientListByResourceGroupPager) PageResponse() IPGroupsClientListByResourceGroupResponse

PageResponse returns the current IPGroupsClientListByResourceGroupResponse page.

type IPGroupsClientListByResourceGroupResponse added in v0.3.0 

type IPGroupsClientListByResourceGroupResponse struct {
	IPGroupsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPGroupsClientListByResourceGroupResponse contains the response from method IPGroupsClient.ListByResourceGroup.

type IPGroupsClientListByResourceGroupResult added in v0.3.0 

type IPGroupsClientListByResourceGroupResult struct {
	IPGroupListResult
}

IPGroupsClientListByResourceGroupResult contains the result from method IPGroupsClient.ListByResourceGroup.

type IPGroupsClientListOptions added in v0.3.0 

type IPGroupsClientListOptions struct {
}

IPGroupsClientListOptions contains the optional parameters for the IPGroupsClient.List method.

type IPGroupsClientListPager added in v0.3.0 

type IPGroupsClientListPager struct {
	// contains filtered or unexported fields
}

IPGroupsClientListPager provides operations for iterating over paged responses.

func (*IPGroupsClientListPager) Err added in v0.3.0 

func (p *IPGroupsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*IPGroupsClientListPager) NextPage added in v0.3.0 

func (p *IPGroupsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*IPGroupsClientListPager) PageResponse added in v0.3.0 

func (p *IPGroupsClientListPager) PageResponse() IPGroupsClientListResponse

PageResponse returns the current IPGroupsClientListResponse page.

type IPGroupsClientListResponse added in v0.3.0 

type IPGroupsClientListResponse struct {
	IPGroupsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPGroupsClientListResponse contains the response from method IPGroupsClient.List.

type IPGroupsClientListResult added in v0.3.0 

type IPGroupsClientListResult struct {
	IPGroupListResult
}

IPGroupsClientListResult contains the result from method IPGroupsClient.List.

type IPGroupsClientUpdateGroupsOptions added in v0.3.0 

type IPGroupsClientUpdateGroupsOptions struct {
}

IPGroupsClientUpdateGroupsOptions contains the optional parameters for the IPGroupsClient.UpdateGroups method.

type IPGroupsClientUpdateGroupsResponse added in v0.3.0 

type IPGroupsClientUpdateGroupsResponse struct {
	IPGroupsClientUpdateGroupsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

IPGroupsClientUpdateGroupsResponse contains the response from method IPGroupsClient.UpdateGroups.

type IPGroupsClientUpdateGroupsResult added in v0.3.0 

type IPGroupsClientUpdateGroupsResult struct {
	IPGroup
}

IPGroupsClientUpdateGroupsResult contains the result from method IPGroupsClient.UpdateGroups.

type IPSecEncryption 

type IPSecEncryption string

IPSecEncryption - The IPSec encryption algorithm (IKE phase 1). 

const (
	IPSecEncryptionAES128    IPSecEncryption = "AES128"
	IPSecEncryptionAES192    IPSecEncryption = "AES192"
	IPSecEncryptionAES256    IPSecEncryption = "AES256"
	IPSecEncryptionDES       IPSecEncryption = "DES"
	IPSecEncryptionDES3      IPSecEncryption = "DES3"
	IPSecEncryptionGCMAES128 IPSecEncryption = "GCMAES128"
	IPSecEncryptionGCMAES192 IPSecEncryption = "GCMAES192"
	IPSecEncryptionGCMAES256 IPSecEncryption = "GCMAES256"
	IPSecEncryptionNone      IPSecEncryption = "None"
)

func PossibleIPSecEncryptionValues 

func PossibleIPSecEncryptionValues() []IPSecEncryption

PossibleIPSecEncryptionValues returns the possible values for the IPSecEncryption const type.

func (IPSecEncryption) ToPtr 

func (c IPSecEncryption) ToPtr() *IPSecEncryption

ToPtr returns a *IPSecEncryption pointing to the current value.

type IPSecIntegrity 

type IPSecIntegrity string

IPSecIntegrity - The IPSec integrity algorithm (IKE phase 1). 

const (
	IPSecIntegrityGCMAES128 IPSecIntegrity = "GCMAES128"
	IPSecIntegrityGCMAES192 IPSecIntegrity = "GCMAES192"
	IPSecIntegrityGCMAES256 IPSecIntegrity = "GCMAES256"
	IPSecIntegrityMD5       IPSecIntegrity = "MD5"
	IPSecIntegritySHA1      IPSecIntegrity = "SHA1"
	IPSecIntegritySHA256    IPSecIntegrity = "SHA256"
)

func PossibleIPSecIntegrityValues 

func PossibleIPSecIntegrityValues() []IPSecIntegrity

PossibleIPSecIntegrityValues returns the possible values for the IPSecIntegrity const type.

func (IPSecIntegrity) ToPtr 

func (c IPSecIntegrity) ToPtr() *IPSecIntegrity

ToPtr returns a *IPSecIntegrity pointing to the current value.

type IPSecPolicy 

type IPSecPolicy struct {
	// REQUIRED; The DH Group used in IKE Phase 1 for initial SA.
	DhGroup *DhGroup `json:"dhGroup,omitempty"`

	// REQUIRED; The IPSec encryption algorithm (IKE phase 1).
	IPSecEncryption *IPSecEncryption `json:"ipsecEncryption,omitempty"`

	// REQUIRED; The IPSec integrity algorithm (IKE phase 1).
	IPSecIntegrity *IPSecIntegrity `json:"ipsecIntegrity,omitempty"`

	// REQUIRED; The IKE encryption algorithm (IKE phase 2).
	IkeEncryption *IkeEncryption `json:"ikeEncryption,omitempty"`

	// REQUIRED; The IKE integrity algorithm (IKE phase 2).
	IkeIntegrity *IkeIntegrity `json:"ikeIntegrity,omitempty"`

	// REQUIRED; The Pfs Group used in IKE Phase 2 for new child SA.
	PfsGroup *PfsGroup `json:"pfsGroup,omitempty"`

	// REQUIRED; The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN
	// tunnel.
	SaDataSizeKilobytes *int32 `json:"saDataSizeKilobytes,omitempty"`

	// REQUIRED; The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site
	// VPN tunnel.
	SaLifeTimeSeconds *int32 `json:"saLifeTimeSeconds,omitempty"`
}

IPSecPolicy - An IPSec Policy configuration for a virtual network gateway connection.

type IPTag 

type IPTag struct {
	// The IP tag type. Example: FirstPartyUsage.
	IPTagType *string `json:"ipTagType,omitempty"`

	// The value of the IP tag associated with the public IP. Example: SQL.
	Tag *string `json:"tag,omitempty"`
}

IPTag - Contains the IpTag associated with the object.

type IPVersion 

type IPVersion string

IPVersion - IP address version. 

const (
	IPVersionIPv4 IPVersion = "IPv4"
	IPVersionIPv6 IPVersion = "IPv6"
)

func PossibleIPVersionValues 

func PossibleIPVersionValues() []IPVersion

PossibleIPVersionValues returns the possible values for the IPVersion const type.

func (IPVersion) ToPtr 

func (c IPVersion) ToPtr() *IPVersion

ToPtr returns a *IPVersion pointing to the current value.

type IPv6CircuitConnectionConfig 

type IPv6CircuitConnectionConfig struct {
	// /125 IP address space to carve out customer addresses for global reach.
	AddressPrefix *string `json:"addressPrefix,omitempty"`

	// READ-ONLY; Express Route Circuit connection state.
	CircuitConnectionStatus *CircuitConnectionStatus `json:"circuitConnectionStatus,omitempty" azure:"ro"`
}

IPv6CircuitConnectionConfig - IPv6 Circuit Connection properties for global reach.

type IPv6ExpressRouteCircuitPeeringConfig 

type IPv6ExpressRouteCircuitPeeringConfig struct {
	// The Microsoft peering configuration.
	MicrosoftPeeringConfig *ExpressRouteCircuitPeeringConfig `json:"microsoftPeeringConfig,omitempty"`

	// The primary address prefix.
	PrimaryPeerAddressPrefix *string `json:"primaryPeerAddressPrefix,omitempty"`

	// The reference to the RouteFilter resource.
	RouteFilter *SubResource `json:"routeFilter,omitempty"`

	// The secondary address prefix.
	SecondaryPeerAddressPrefix *string `json:"secondaryPeerAddressPrefix,omitempty"`

	// The state of peering.
	State *ExpressRouteCircuitPeeringState `json:"state,omitempty"`
}

IPv6ExpressRouteCircuitPeeringConfig - Contains IPv6 peering config.

type IkeEncryption 

type IkeEncryption string

IkeEncryption - The IKE encryption algorithm (IKE phase 2). 

const (
	IkeEncryptionAES128    IkeEncryption = "AES128"
	IkeEncryptionAES192    IkeEncryption = "AES192"
	IkeEncryptionAES256    IkeEncryption = "AES256"
	IkeEncryptionDES       IkeEncryption = "DES"
	IkeEncryptionDES3      IkeEncryption = "DES3"
	IkeEncryptionGCMAES128 IkeEncryption = "GCMAES128"
	IkeEncryptionGCMAES256 IkeEncryption = "GCMAES256"
)

func PossibleIkeEncryptionValues 

func PossibleIkeEncryptionValues() []IkeEncryption

PossibleIkeEncryptionValues returns the possible values for the IkeEncryption const type.

func (IkeEncryption) ToPtr 

func (c IkeEncryption) ToPtr() *IkeEncryption

ToPtr returns a *IkeEncryption pointing to the current value.

type IkeIntegrity 

type IkeIntegrity string

IkeIntegrity - The IKE integrity algorithm (IKE phase 2). 

const (
	IkeIntegrityGCMAES128 IkeIntegrity = "GCMAES128"
	IkeIntegrityGCMAES256 IkeIntegrity = "GCMAES256"
	IkeIntegrityMD5       IkeIntegrity = "MD5"
	IkeIntegritySHA1      IkeIntegrity = "SHA1"
	IkeIntegritySHA256    IkeIntegrity = "SHA256"
	IkeIntegritySHA384    IkeIntegrity = "SHA384"
)

func PossibleIkeIntegrityValues 

func PossibleIkeIntegrityValues() []IkeIntegrity

PossibleIkeIntegrityValues returns the possible values for the IkeIntegrity const type.

func (IkeIntegrity) ToPtr 

func (c IkeIntegrity) ToPtr() *IkeIntegrity

ToPtr returns a *IkeIntegrity pointing to the current value.

type InboundNatPool 

type InboundNatPool struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be
	// used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of load balancer inbound nat pool.
	Properties *InboundNatPoolPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

InboundNatPool - Inbound NAT pool of the load balancer.

type InboundNatPoolPropertiesFormat 

type InboundNatPoolPropertiesFormat struct {
	// REQUIRED; The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
	BackendPort *int32 `json:"backendPort,omitempty"`

	// REQUIRED; 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"`

	// REQUIRED; 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"`

	// REQUIRED; The reference to the transport protocol used by the inbound NAT pool.
	Protocol *TransportProtocol `json:"protocol,omitempty"`

	// 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"`

	// Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used
	// when the protocol is set to TCP.
	EnableTCPReset *bool `json:"enableTcpReset,omitempty"`

	// A reference to frontend IP addresses.
	FrontendIPConfiguration *SubResource `json:"frontendIPConfiguration,omitempty"`

	// 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"`

	// READ-ONLY; The provisioning state of the inbound NAT pool resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

InboundNatPoolPropertiesFormat - Properties of Inbound NAT pool.

type InboundNatRule 

type InboundNatRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be
	// used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of load balancer inbound NAT rule.
	Properties *InboundNatRulePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

InboundNatRule - Inbound NAT rule of the load balancer.

type InboundNatRuleListResult 

type InboundNatRuleListResult struct {
	// A list of inbound NAT rules in a load balancer.
	Value []*InboundNatRule `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

InboundNatRuleListResult - Response for ListInboundNatRule API service call.

func (InboundNatRuleListResult) MarshalJSON 

func (i InboundNatRuleListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundNatRuleListResult.

type InboundNatRulePortMapping added in v0.2.0 

type InboundNatRulePortMapping struct {
	// READ-ONLY; Backend port.
	BackendPort *int32 `json:"backendPort,omitempty" azure:"ro"`

	// READ-ONLY; Frontend port.
	FrontendPort *int32 `json:"frontendPort,omitempty" azure:"ro"`

	// READ-ONLY; Name of inbound NAT rule.
	InboundNatRuleName *string `json:"inboundNatRuleName,omitempty" azure:"ro"`

	// READ-ONLY; The reference to the transport protocol used by the inbound NAT rule.
	Protocol *TransportProtocol `json:"protocol,omitempty" azure:"ro"`
}

InboundNatRulePortMapping - Individual port mappings for inbound NAT rule created for backend pool.

type InboundNatRulePropertiesFormat 

type InboundNatRulePropertiesFormat struct {
	// A reference to backendAddressPool resource.
	BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`

	// The port used for the internal endpoint. Acceptable values range from 1 to 65535.
	BackendPort *int32 `json:"backendPort,omitempty"`

	// 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"`

	// Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used
	// when the protocol is set to TCP.
	EnableTCPReset *bool `json:"enableTcpReset,omitempty"`

	// A reference to frontend IP addresses.
	FrontendIPConfiguration *SubResource `json:"frontendIPConfiguration,omitempty"`

	// 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"`

	// The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart.
	// Individual inbound NAT rule port mappings will be created for each
	// backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
	FrontendPortRangeEnd *int32 `json:"frontendPortRangeEnd,omitempty"`

	// The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd.
	// Individual inbound NAT rule port mappings will be created for each
	// backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
	FrontendPortRangeStart *int32 `json:"frontendPortRangeStart,omitempty"`

	// 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"`

	// The reference to the transport protocol used by the load balancing rule.
	Protocol *TransportProtocol `json:"protocol,omitempty"`

	// READ-ONLY; A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port
	// of each of the frontend IP configurations is forwarded to the backend IP.
	BackendIPConfiguration *InterfaceIPConfiguration `json:"backendIPConfiguration,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the inbound NAT rule resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

InboundNatRulePropertiesFormat - Properties of the inbound NAT rule.

type InboundNatRulesClient 

type InboundNatRulesClient struct {
	// contains filtered or unexported fields
}

InboundNatRulesClient contains the methods for the InboundNatRules group. Don't use this type directly, use NewInboundNatRulesClient() instead.

func NewInboundNatRulesClient 

func NewInboundNatRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *InboundNatRulesClient

NewInboundNatRulesClient creates a new instance of InboundNatRulesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*InboundNatRulesClient) BeginCreateOrUpdate 

func (client *InboundNatRulesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, loadBalancerName string, inboundNatRuleName string, inboundNatRuleParameters InboundNatRule, options *InboundNatRulesClientBeginCreateOrUpdateOptions) (InboundNatRulesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a load balancer inbound NAT rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. inboundNatRuleName - The name of the inbound NAT rule. inboundNatRuleParameters - Parameters supplied to the create or update inbound NAT rule operation. options - InboundNatRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the InboundNatRulesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/InboundNatRuleCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInboundNatRulesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		"<inbound-nat-rule-name>",
		armnetwork.InboundNatRule{
			Properties: &armnetwork.InboundNatRulePropertiesFormat{
				BackendPort:      to.Int32Ptr(3389),
				EnableFloatingIP: to.BoolPtr(false),
				EnableTCPReset:   to.BoolPtr(false),
				FrontendIPConfiguration: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
				FrontendPort:         to.Int32Ptr(3390),
				IdleTimeoutInMinutes: to.Int32Ptr(4),
				Protocol:             armnetwork.TransportProtocol("Tcp").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InboundNatRulesClientCreateOrUpdateResult)
}

Output:

func (*InboundNatRulesClient) BeginDelete 

func (client *InboundNatRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, loadBalancerName string, inboundNatRuleName string, options *InboundNatRulesClientBeginDeleteOptions) (InboundNatRulesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified load balancer inbound NAT rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. inboundNatRuleName - The name of the inbound NAT rule. options - InboundNatRulesClientBeginDeleteOptions contains the optional parameters for the InboundNatRulesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/InboundNatRuleDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInboundNatRulesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		"<inbound-nat-rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*InboundNatRulesClient) Get 

func (client *InboundNatRulesClient) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, inboundNatRuleName string, options *InboundNatRulesClientGetOptions) (InboundNatRulesClientGetResponse, error)

Get - Gets the specified load balancer inbound NAT rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. inboundNatRuleName - The name of the inbound NAT rule. options - InboundNatRulesClientGetOptions contains the optional parameters for the InboundNatRulesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/InboundNatRuleGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInboundNatRulesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		"<inbound-nat-rule-name>",
		&armnetwork.InboundNatRulesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InboundNatRulesClientGetResult)
}

Output:

func (*InboundNatRulesClient) List 

func (client *InboundNatRulesClient) List(resourceGroupName string, loadBalancerName string, options *InboundNatRulesClientListOptions) *InboundNatRulesClientListPager

List - Gets all the inbound NAT rules in a load balancer. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. options - InboundNatRulesClientListOptions contains the optional parameters for the InboundNatRulesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/InboundNatRuleList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInboundNatRulesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<load-balancer-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type InboundNatRulesClientBeginCreateOrUpdateOptions added in v0.3.0 

type InboundNatRulesClientBeginCreateOrUpdateOptions struct {
}

InboundNatRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the InboundNatRulesClient.BeginCreateOrUpdate method.

type InboundNatRulesClientBeginDeleteOptions added in v0.3.0 

type InboundNatRulesClientBeginDeleteOptions struct {
}

InboundNatRulesClientBeginDeleteOptions contains the optional parameters for the InboundNatRulesClient.BeginDelete method.

type InboundNatRulesClientCreateOrUpdatePoller added in v0.3.0 

type InboundNatRulesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

InboundNatRulesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*InboundNatRulesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *InboundNatRulesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*InboundNatRulesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *InboundNatRulesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (InboundNatRulesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InboundNatRulesClientCreateOrUpdateResponse will be returned.

func (*InboundNatRulesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *InboundNatRulesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InboundNatRulesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *InboundNatRulesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InboundNatRulesClientCreateOrUpdatePollerResponse added in v0.3.0 

type InboundNatRulesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InboundNatRulesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundNatRulesClientCreateOrUpdatePollerResponse contains the response from method InboundNatRulesClient.CreateOrUpdate.

func (InboundNatRulesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l InboundNatRulesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (InboundNatRulesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InboundNatRulesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *InboundNatRulesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *InboundNatRulesClient, token string) error

Resume rehydrates a InboundNatRulesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type InboundNatRulesClientCreateOrUpdateResponse added in v0.3.0 

type InboundNatRulesClientCreateOrUpdateResponse struct {
	InboundNatRulesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundNatRulesClientCreateOrUpdateResponse contains the response from method InboundNatRulesClient.CreateOrUpdate.

type InboundNatRulesClientCreateOrUpdateResult added in v0.3.0 

type InboundNatRulesClientCreateOrUpdateResult struct {
	InboundNatRule
}

InboundNatRulesClientCreateOrUpdateResult contains the result from method InboundNatRulesClient.CreateOrUpdate.

type InboundNatRulesClientDeletePoller added in v0.3.0 

type InboundNatRulesClientDeletePoller struct {
	// contains filtered or unexported fields
}

InboundNatRulesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*InboundNatRulesClientDeletePoller) Done added in v0.3.0 

func (p *InboundNatRulesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*InboundNatRulesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *InboundNatRulesClientDeletePoller) FinalResponse(ctx context.Context) (InboundNatRulesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InboundNatRulesClientDeleteResponse will be returned.

func (*InboundNatRulesClientDeletePoller) Poll added in v0.3.0 

func (p *InboundNatRulesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InboundNatRulesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *InboundNatRulesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InboundNatRulesClientDeletePollerResponse added in v0.3.0 

type InboundNatRulesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InboundNatRulesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundNatRulesClientDeletePollerResponse contains the response from method InboundNatRulesClient.Delete.

func (InboundNatRulesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l InboundNatRulesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (InboundNatRulesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InboundNatRulesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *InboundNatRulesClientDeletePollerResponse) Resume(ctx context.Context, client *InboundNatRulesClient, token string) error

Resume rehydrates a InboundNatRulesClientDeletePollerResponse from the provided client and resume token.

type InboundNatRulesClientDeleteResponse added in v0.3.0 

type InboundNatRulesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundNatRulesClientDeleteResponse contains the response from method InboundNatRulesClient.Delete.

type InboundNatRulesClientGetOptions added in v0.3.0 

type InboundNatRulesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

InboundNatRulesClientGetOptions contains the optional parameters for the InboundNatRulesClient.Get method.

type InboundNatRulesClientGetResponse added in v0.3.0 

type InboundNatRulesClientGetResponse struct {
	InboundNatRulesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundNatRulesClientGetResponse contains the response from method InboundNatRulesClient.Get.

type InboundNatRulesClientGetResult added in v0.3.0 

type InboundNatRulesClientGetResult struct {
	InboundNatRule
}

InboundNatRulesClientGetResult contains the result from method InboundNatRulesClient.Get.

type InboundNatRulesClientListOptions added in v0.3.0 

type InboundNatRulesClientListOptions struct {
}

InboundNatRulesClientListOptions contains the optional parameters for the InboundNatRulesClient.List method.

type InboundNatRulesClientListPager added in v0.3.0 

type InboundNatRulesClientListPager struct {
	// contains filtered or unexported fields
}

InboundNatRulesClientListPager provides operations for iterating over paged responses.

func (*InboundNatRulesClientListPager) Err added in v0.3.0 

func (p *InboundNatRulesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*InboundNatRulesClientListPager) NextPage added in v0.3.0 

func (p *InboundNatRulesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InboundNatRulesClientListPager) PageResponse added in v0.3.0 

func (p *InboundNatRulesClientListPager) PageResponse() InboundNatRulesClientListResponse

PageResponse returns the current InboundNatRulesClientListResponse page.

type InboundNatRulesClientListResponse added in v0.3.0 

type InboundNatRulesClientListResponse struct {
	InboundNatRulesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundNatRulesClientListResponse contains the response from method InboundNatRulesClient.List.

type InboundNatRulesClientListResult added in v0.3.0 

type InboundNatRulesClientListResult struct {
	InboundNatRuleListResult
}

InboundNatRulesClientListResult contains the result from method InboundNatRulesClient.List.

type InboundSecurityRule 

type InboundSecurityRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of security rule collection.
	Name *string `json:"name,omitempty"`

	// The properties of the Inbound Security Rules.
	Properties *InboundSecurityRuleProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; NVA inbound security rule type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

InboundSecurityRule - NVA Inbound Security Rule resource.

type InboundSecurityRuleClient 

type InboundSecurityRuleClient struct {
	// contains filtered or unexported fields
}

InboundSecurityRuleClient contains the methods for the InboundSecurityRule group. Don't use this type directly, use NewInboundSecurityRuleClient() instead.

func NewInboundSecurityRuleClient 

func NewInboundSecurityRuleClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *InboundSecurityRuleClient

NewInboundSecurityRuleClient creates a new instance of InboundSecurityRuleClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*InboundSecurityRuleClient) BeginCreateOrUpdate 

func (client *InboundSecurityRuleClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, ruleCollectionName string, parameters InboundSecurityRule, options *InboundSecurityRuleClientBeginCreateOrUpdateOptions) (InboundSecurityRuleClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified Network Virtual Appliance Inbound Security Rules. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkVirtualApplianceName - The name of the Network Virtual Appliance. ruleCollectionName - The name of security rule collection. parameters - Parameters supplied to the create or update Network Virtual Appliance Inbound Security Rules operation. options - InboundSecurityRuleClientBeginCreateOrUpdateOptions contains the optional parameters for the InboundSecurityRuleClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/InboundSecurityRulePut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInboundSecurityRuleClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-virtual-appliance-name>",
		"<rule-collection-name>",
		armnetwork.InboundSecurityRule{
			Properties: &armnetwork.InboundSecurityRuleProperties{
				Rules: []*armnetwork.InboundSecurityRules{
					{
						DestinationPortRange: to.Int32Ptr(22),
						SourceAddressPrefix:  to.StringPtr("<source-address-prefix>"),
						Protocol:             armnetwork.InboundSecurityRulesProtocol("TCP").ToPtr(),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InboundSecurityRuleClientCreateOrUpdateResult)
}

Output:

type InboundSecurityRuleClientBeginCreateOrUpdateOptions added in v0.3.0 

type InboundSecurityRuleClientBeginCreateOrUpdateOptions struct {
}

InboundSecurityRuleClientBeginCreateOrUpdateOptions contains the optional parameters for the InboundSecurityRuleClient.BeginCreateOrUpdate method.

type InboundSecurityRuleClientCreateOrUpdatePoller added in v0.3.0 

type InboundSecurityRuleClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

InboundSecurityRuleClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*InboundSecurityRuleClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *InboundSecurityRuleClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*InboundSecurityRuleClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *InboundSecurityRuleClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (InboundSecurityRuleClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InboundSecurityRuleClientCreateOrUpdateResponse will be returned.

func (*InboundSecurityRuleClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *InboundSecurityRuleClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InboundSecurityRuleClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *InboundSecurityRuleClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InboundSecurityRuleClientCreateOrUpdatePollerResponse added in v0.3.0 

type InboundSecurityRuleClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InboundSecurityRuleClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundSecurityRuleClientCreateOrUpdatePollerResponse contains the response from method InboundSecurityRuleClient.CreateOrUpdate.

func (InboundSecurityRuleClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l InboundSecurityRuleClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (InboundSecurityRuleClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InboundSecurityRuleClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *InboundSecurityRuleClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *InboundSecurityRuleClient, token string) error

Resume rehydrates a InboundSecurityRuleClientCreateOrUpdatePollerResponse from the provided client and resume token.

type InboundSecurityRuleClientCreateOrUpdateResponse added in v0.3.0 

type InboundSecurityRuleClientCreateOrUpdateResponse struct {
	InboundSecurityRuleClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InboundSecurityRuleClientCreateOrUpdateResponse contains the response from method InboundSecurityRuleClient.CreateOrUpdate.

type InboundSecurityRuleClientCreateOrUpdateResult added in v0.3.0 

type InboundSecurityRuleClientCreateOrUpdateResult struct {
	InboundSecurityRule
}

InboundSecurityRuleClientCreateOrUpdateResult contains the result from method InboundSecurityRuleClient.CreateOrUpdate.

type InboundSecurityRuleProperties 

type InboundSecurityRuleProperties struct {
	// List of allowed rules.
	Rules []*InboundSecurityRules `json:"rules,omitempty"`

	// READ-ONLY; The provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

InboundSecurityRuleProperties - Properties of the Inbound Security Rules resource.

func (InboundSecurityRuleProperties) MarshalJSON 

func (i InboundSecurityRuleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundSecurityRuleProperties.

type InboundSecurityRules 

type InboundSecurityRules struct {
	// NVA port ranges to be opened up. One needs to provide specific ports.
	DestinationPortRange *int32 `json:"destinationPortRange,omitempty"`

	// Protocol. This should be either TCP or UDP.
	Protocol *InboundSecurityRulesProtocol `json:"protocol,omitempty"`

	// The CIDR or source IP range. Only /30, /31 and /32 Ip ranges are allowed.
	SourceAddressPrefix *string `json:"sourceAddressPrefix,omitempty"`
}

InboundSecurityRules - Properties of the Inbound Security Rules resource.

type InboundSecurityRulesProtocol 

type InboundSecurityRulesProtocol string

InboundSecurityRulesProtocol - Protocol. This should be either TCP or UDP. 

const (
	InboundSecurityRulesProtocolTCP InboundSecurityRulesProtocol = "TCP"
	InboundSecurityRulesProtocolUDP InboundSecurityRulesProtocol = "UDP"
)

func PossibleInboundSecurityRulesProtocolValues 

func PossibleInboundSecurityRulesProtocolValues() []InboundSecurityRulesProtocol

PossibleInboundSecurityRulesProtocolValues returns the possible values for the InboundSecurityRulesProtocol const type.

func (InboundSecurityRulesProtocol) ToPtr 

func (c InboundSecurityRulesProtocol) ToPtr() *InboundSecurityRulesProtocol

ToPtr returns a *InboundSecurityRulesProtocol pointing to the current value.

type IntentPolicy added in v0.3.0 

type IntentPolicy struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

IntentPolicy - Network Intent Policy resource.

func (IntentPolicy) MarshalJSON added in v0.3.0 

func (i IntentPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntentPolicy.

type IntentPolicyConfiguration added in v0.3.0 

type IntentPolicyConfiguration struct {
	// The name of the Network Intent Policy for storing in target subscription.
	NetworkIntentPolicyName *string `json:"networkIntentPolicyName,omitempty"`

	// Source network intent policy.
	SourceNetworkIntentPolicy *IntentPolicy `json:"sourceNetworkIntentPolicy,omitempty"`
}

IntentPolicyConfiguration - Details of NetworkIntentPolicyConfiguration for PrepareNetworkPoliciesRequest.

type Interface added in v0.3.0 

type Interface struct {
	// The extended location of the network interface.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the network interface.
	Properties *InterfacePropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Interface - A network interface in a resource group.

func (Interface) MarshalJSON added in v0.3.0 

func (i Interface) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Interface.

type InterfaceAssociation added in v0.3.0 

type InterfaceAssociation struct {
	// Collection of custom security rules.
	SecurityRules []*SecurityRule `json:"securityRules,omitempty"`

	// READ-ONLY; Network interface ID.
	ID *string `json:"id,omitempty" azure:"ro"`
}

InterfaceAssociation - Network interface and its custom security rules.

func (InterfaceAssociation) MarshalJSON added in v0.3.0 

func (i InterfaceAssociation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceAssociation.

type InterfaceDNSSettings added in v0.3.0 

type InterfaceDNSSettings struct {
	// 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"`

	// Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.
	InternalDNSNameLabel *string `json:"internalDnsNameLabel,omitempty"`

	// READ-ONLY; 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" azure:"ro"`

	// READ-ONLY; Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS
	// name can be constructed by concatenating the VM name with the value of
	// internalDomainNameSuffix.
	InternalDomainNameSuffix *string `json:"internalDomainNameSuffix,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified DNS name supporting internal communications between VMs in the same virtual network.
	InternalFqdn *string `json:"internalFqdn,omitempty" azure:"ro"`
}

InterfaceDNSSettings - DNS settings of a network interface.

func (InterfaceDNSSettings) MarshalJSON added in v0.3.0 

func (i InterfaceDNSSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceDNSSettings.

type InterfaceIPConfiguration added in v0.3.0 

type InterfaceIPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Network interface IP configuration properties.
	Properties *InterfaceIPConfigurationPropertiesFormat `json:"properties,omitempty"`

	// Resource type.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

InterfaceIPConfiguration - IPConfiguration in a network interface.

type InterfaceIPConfigurationListResult added in v0.3.0 

type InterfaceIPConfigurationListResult struct {
	// A list of ip configurations.
	Value []*InterfaceIPConfiguration `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

InterfaceIPConfigurationListResult - Response for list ip configurations API service call.

func (InterfaceIPConfigurationListResult) MarshalJSON added in v0.3.0 

func (i InterfaceIPConfigurationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceIPConfigurationListResult.

type InterfaceIPConfigurationPrivateLinkConnectionProperties added in v0.3.0 

type InterfaceIPConfigurationPrivateLinkConnectionProperties struct {
	// READ-ONLY; List of FQDNs for current private link connection.
	Fqdns []*string `json:"fqdns,omitempty" azure:"ro"`

	// READ-ONLY; The group ID for current private link connection.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The required member name for current private link connection.
	RequiredMemberName *string `json:"requiredMemberName,omitempty" azure:"ro"`
}

InterfaceIPConfigurationPrivateLinkConnectionProperties - PrivateLinkConnection properties for the network interface.

func (InterfaceIPConfigurationPrivateLinkConnectionProperties) MarshalJSON added in v0.3.0 

func (i InterfaceIPConfigurationPrivateLinkConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceIPConfigurationPrivateLinkConnectionProperties.

type InterfaceIPConfigurationPropertiesFormat added in v0.3.0 

type InterfaceIPConfigurationPropertiesFormat struct {
	// The reference to ApplicationGatewayBackendAddressPool resource.
	ApplicationGatewayBackendAddressPools []*ApplicationGatewayBackendAddressPool `json:"applicationGatewayBackendAddressPools,omitempty"`

	// Application security groups in which the IP configuration is included.
	ApplicationSecurityGroups []*ApplicationSecurityGroup `json:"applicationSecurityGroups,omitempty"`

	// The reference to gateway load balancer frontend IP.
	GatewayLoadBalancer *SubResource `json:"gatewayLoadBalancer,omitempty"`

	// The reference to LoadBalancerBackendAddressPool resource.
	LoadBalancerBackendAddressPools []*BackendAddressPool `json:"loadBalancerBackendAddressPools,omitempty"`

	// A list of references of LoadBalancerInboundNatRules.
	LoadBalancerInboundNatRules []*InboundNatRule `json:"loadBalancerInboundNatRules,omitempty"`

	// Whether this is a primary customer address on the network interface.
	Primary *bool `json:"primary,omitempty"`

	// Private IP address of the IP configuration.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.
	PrivateIPAddressVersion *IPVersion `json:"privateIPAddressVersion,omitempty"`

	// The private IP address allocation method.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// Public IP address bound to the IP configuration.
	PublicIPAddress *PublicIPAddress `json:"publicIPAddress,omitempty"`

	// Subnet bound to the IP configuration.
	Subnet *Subnet `json:"subnet,omitempty"`

	// The reference to Virtual Network Taps.
	VirtualNetworkTaps []*VirtualNetworkTap `json:"virtualNetworkTaps,omitempty"`

	// READ-ONLY; PrivateLinkConnection properties for the network interface.
	PrivateLinkConnectionProperties *InterfaceIPConfigurationPrivateLinkConnectionProperties `json:"privateLinkConnectionProperties,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the network interface IP configuration.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

InterfaceIPConfigurationPropertiesFormat - Properties of IP configuration.

func (InterfaceIPConfigurationPropertiesFormat) MarshalJSON added in v0.3.0 

func (i InterfaceIPConfigurationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceIPConfigurationPropertiesFormat.

type InterfaceIPConfigurationsClient added in v0.3.0 

type InterfaceIPConfigurationsClient struct {
	// contains filtered or unexported fields
}

InterfaceIPConfigurationsClient contains the methods for the NetworkInterfaceIPConfigurations group. Don't use this type directly, use NewInterfaceIPConfigurationsClient() instead.

func NewInterfaceIPConfigurationsClient added in v0.3.0 

func NewInterfaceIPConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *InterfaceIPConfigurationsClient

NewInterfaceIPConfigurationsClient creates a new instance of InterfaceIPConfigurationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*InterfaceIPConfigurationsClient) Get added in v0.3.0 

func (client *InterfaceIPConfigurationsClient) Get(ctx context.Context, resourceGroupName string, networkInterfaceName string, ipConfigurationName string, options *InterfaceIPConfigurationsClientGetOptions) (InterfaceIPConfigurationsClientGetResponse, error)

Get - Gets the specified network interface ip configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. ipConfigurationName - The name of the ip configuration name. options - InterfaceIPConfigurationsClientGetOptions contains the optional parameters for the InterfaceIPConfigurationsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceIPConfigurationGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfaceIPConfigurationsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-interface-name>",
		"<ip-configuration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InterfaceIPConfigurationsClientGetResult)
}

Output:

func (*InterfaceIPConfigurationsClient) List added in v0.3.0 

func (client *InterfaceIPConfigurationsClient) List(resourceGroupName string, networkInterfaceName string, options *InterfaceIPConfigurationsClientListOptions) *InterfaceIPConfigurationsClientListPager

List - Get all ip configurations in a network interface. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. options - InterfaceIPConfigurationsClientListOptions contains the optional parameters for the InterfaceIPConfigurationsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceIPConfigurationList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfaceIPConfigurationsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<network-interface-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type InterfaceIPConfigurationsClientGetOptions added in v0.3.0 

type InterfaceIPConfigurationsClientGetOptions struct {
}

InterfaceIPConfigurationsClientGetOptions contains the optional parameters for the InterfaceIPConfigurationsClient.Get method.

type InterfaceIPConfigurationsClientGetResponse added in v0.3.0 

type InterfaceIPConfigurationsClientGetResponse struct {
	InterfaceIPConfigurationsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfaceIPConfigurationsClientGetResponse contains the response from method InterfaceIPConfigurationsClient.Get.

type InterfaceIPConfigurationsClientGetResult added in v0.3.0 

type InterfaceIPConfigurationsClientGetResult struct {
	InterfaceIPConfiguration
}

InterfaceIPConfigurationsClientGetResult contains the result from method InterfaceIPConfigurationsClient.Get.

type InterfaceIPConfigurationsClientListOptions added in v0.3.0 

type InterfaceIPConfigurationsClientListOptions struct {
}

InterfaceIPConfigurationsClientListOptions contains the optional parameters for the InterfaceIPConfigurationsClient.List method.

type InterfaceIPConfigurationsClientListPager added in v0.3.0 

type InterfaceIPConfigurationsClientListPager struct {
	// contains filtered or unexported fields
}

InterfaceIPConfigurationsClientListPager provides operations for iterating over paged responses.

func (*InterfaceIPConfigurationsClientListPager) Err added in v0.3.0 

func (p *InterfaceIPConfigurationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*InterfaceIPConfigurationsClientListPager) NextPage added in v0.3.0 

func (p *InterfaceIPConfigurationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InterfaceIPConfigurationsClientListPager) PageResponse added in v0.3.0 

func (p *InterfaceIPConfigurationsClientListPager) PageResponse() InterfaceIPConfigurationsClientListResponse

PageResponse returns the current InterfaceIPConfigurationsClientListResponse page.

type InterfaceIPConfigurationsClientListResponse added in v0.3.0 

type InterfaceIPConfigurationsClientListResponse struct {
	InterfaceIPConfigurationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfaceIPConfigurationsClientListResponse contains the response from method InterfaceIPConfigurationsClient.List.

type InterfaceIPConfigurationsClientListResult added in v0.3.0 

type InterfaceIPConfigurationsClientListResult struct {
	InterfaceIPConfigurationListResult
}

InterfaceIPConfigurationsClientListResult contains the result from method InterfaceIPConfigurationsClient.List.

type InterfaceListResult added in v0.3.0 

type InterfaceListResult struct {
	// A list of network interfaces in a resource group.
	Value []*Interface `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

InterfaceListResult - Response for the ListNetworkInterface API service call.

func (InterfaceListResult) MarshalJSON added in v0.3.0 

func (i InterfaceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceListResult.

type InterfaceLoadBalancerListResult added in v0.3.0 

type InterfaceLoadBalancerListResult struct {
	// A list of load balancers.
	Value []*LoadBalancer `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

InterfaceLoadBalancerListResult - Response for list ip configurations API service call.

func (InterfaceLoadBalancerListResult) MarshalJSON added in v0.3.0 

func (i InterfaceLoadBalancerListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceLoadBalancerListResult.

type InterfaceLoadBalancersClient added in v0.3.0 

type InterfaceLoadBalancersClient struct {
	// contains filtered or unexported fields
}

InterfaceLoadBalancersClient contains the methods for the NetworkInterfaceLoadBalancers group. Don't use this type directly, use NewInterfaceLoadBalancersClient() instead.

func NewInterfaceLoadBalancersClient added in v0.3.0 

func NewInterfaceLoadBalancersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *InterfaceLoadBalancersClient

NewInterfaceLoadBalancersClient creates a new instance of InterfaceLoadBalancersClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*InterfaceLoadBalancersClient) List added in v0.3.0 

func (client *InterfaceLoadBalancersClient) List(resourceGroupName string, networkInterfaceName string, options *InterfaceLoadBalancersClientListOptions) *InterfaceLoadBalancersClientListPager

List - List all load balancers in a network interface. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. options - InterfaceLoadBalancersClientListOptions contains the optional parameters for the InterfaceLoadBalancersClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceLoadBalancerList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfaceLoadBalancersClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<network-interface-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type InterfaceLoadBalancersClientListOptions added in v0.3.0 

type InterfaceLoadBalancersClientListOptions struct {
}

InterfaceLoadBalancersClientListOptions contains the optional parameters for the InterfaceLoadBalancersClient.List method.

type InterfaceLoadBalancersClientListPager added in v0.3.0 

type InterfaceLoadBalancersClientListPager struct {
	// contains filtered or unexported fields
}

InterfaceLoadBalancersClientListPager provides operations for iterating over paged responses.

func (*InterfaceLoadBalancersClientListPager) Err added in v0.3.0 

func (p *InterfaceLoadBalancersClientListPager) Err() error

Err returns the last error encountered while paging.

func (*InterfaceLoadBalancersClientListPager) NextPage added in v0.3.0 

func (p *InterfaceLoadBalancersClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InterfaceLoadBalancersClientListPager) PageResponse added in v0.3.0 

func (p *InterfaceLoadBalancersClientListPager) PageResponse() InterfaceLoadBalancersClientListResponse

PageResponse returns the current InterfaceLoadBalancersClientListResponse page.

type InterfaceLoadBalancersClientListResponse added in v0.3.0 

type InterfaceLoadBalancersClientListResponse struct {
	InterfaceLoadBalancersClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfaceLoadBalancersClientListResponse contains the response from method InterfaceLoadBalancersClient.List.

type InterfaceLoadBalancersClientListResult added in v0.3.0 

type InterfaceLoadBalancersClientListResult struct {
	InterfaceLoadBalancerListResult
}

InterfaceLoadBalancersClientListResult contains the result from method InterfaceLoadBalancersClient.List.

type InterfacePropertiesFormat added in v0.3.0 

type InterfacePropertiesFormat struct {
	// The DNS settings in network interface.
	DNSSettings *InterfaceDNSSettings `json:"dnsSettings,omitempty"`

	// If the network interface is accelerated networking enabled.
	EnableAcceleratedNetworking *bool `json:"enableAcceleratedNetworking,omitempty"`

	// Indicates whether IP forwarding is enabled on this network interface.
	EnableIPForwarding *bool `json:"enableIPForwarding,omitempty"`

	// A list of IPConfigurations of the network interface.
	IPConfigurations []*InterfaceIPConfiguration `json:"ipConfigurations,omitempty"`

	// Migration phase of Network Interface resource.
	MigrationPhase *NetworkInterfaceMigrationPhase `json:"migrationPhase,omitempty"`

	// The reference to the NetworkSecurityGroup resource.
	NetworkSecurityGroup *SecurityGroup `json:"networkSecurityGroup,omitempty"`

	// Type of Network Interface resource.
	NicType *NetworkInterfaceNicType `json:"nicType,omitempty"`

	// Privatelinkservice of the network interface resource.
	PrivateLinkService *PrivateLinkService `json:"privateLinkService,omitempty"`

	// WorkloadType of the NetworkInterface for BareMetal resources
	WorkloadType *string `json:"workloadType,omitempty"`

	// READ-ONLY; A reference to the dscp configuration to which the network interface is linked.
	DscpConfiguration *SubResource `json:"dscpConfiguration,omitempty" azure:"ro"`

	// READ-ONLY; A list of references to linked BareMetal resources.
	HostedWorkloads []*string `json:"hostedWorkloads,omitempty" azure:"ro"`

	// READ-ONLY; The MAC address of the network interface.
	MacAddress *string `json:"macAddress,omitempty" azure:"ro"`

	// READ-ONLY; Whether this is a primary network interface on a virtual machine.
	Primary *bool `json:"primary,omitempty" azure:"ro"`

	// READ-ONLY; A reference to the private endpoint to which the network interface is linked.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the network interface resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the network interface resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`

	// READ-ONLY; A list of TapConfigurations of the network interface.
	TapConfigurations []*InterfaceTapConfiguration `json:"tapConfigurations,omitempty" azure:"ro"`

	// READ-ONLY; The reference to a virtual machine.
	VirtualMachine *SubResource `json:"virtualMachine,omitempty" azure:"ro"`

	// READ-ONLY; Whether the virtual machine this nic is attached to supports encryption.
	VnetEncryptionSupported *bool `json:"vnetEncryptionSupported,omitempty" azure:"ro"`
}

InterfacePropertiesFormat - NetworkInterface properties.

func (InterfacePropertiesFormat) MarshalJSON added in v0.3.0 

func (i InterfacePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfacePropertiesFormat.

type InterfaceTapConfiguration added in v0.3.0 

type InterfaceTapConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the Virtual Network Tap configuration.
	Properties *InterfaceTapConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Sub Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

InterfaceTapConfiguration - Tap configuration in a Network Interface.

type InterfaceTapConfigurationListResult added in v0.3.0 

type InterfaceTapConfigurationListResult struct {
	// A list of tap configurations.
	Value []*InterfaceTapConfiguration `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

InterfaceTapConfigurationListResult - Response for list tap configurations API service call.

func (InterfaceTapConfigurationListResult) MarshalJSON added in v0.3.0 

func (i InterfaceTapConfigurationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceTapConfigurationListResult.

type InterfaceTapConfigurationPropertiesFormat added in v0.3.0 

type InterfaceTapConfigurationPropertiesFormat struct {
	// The reference to the Virtual Network Tap resource.
	VirtualNetworkTap *VirtualNetworkTap `json:"virtualNetworkTap,omitempty"`

	// READ-ONLY; The provisioning state of the network interface tap configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

InterfaceTapConfigurationPropertiesFormat - Properties of Virtual Network Tap configuration.

type InterfaceTapConfigurationsClient added in v0.3.0 

type InterfaceTapConfigurationsClient struct {
	// contains filtered or unexported fields
}

InterfaceTapConfigurationsClient contains the methods for the NetworkInterfaceTapConfigurations group. Don't use this type directly, use NewInterfaceTapConfigurationsClient() instead.

func NewInterfaceTapConfigurationsClient added in v0.3.0 

func NewInterfaceTapConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *InterfaceTapConfigurationsClient

NewInterfaceTapConfigurationsClient creates a new instance of InterfaceTapConfigurationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*InterfaceTapConfigurationsClient) BeginCreateOrUpdate added in v0.3.0 

func (client *InterfaceTapConfigurationsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkInterfaceName string, tapConfigurationName string, tapConfigurationParameters InterfaceTapConfiguration, options *InterfaceTapConfigurationsClientBeginCreateOrUpdateOptions) (InterfaceTapConfigurationsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a Tap configuration in the specified NetworkInterface. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. tapConfigurationName - The name of the tap configuration. tapConfigurationParameters - Parameters supplied to the create or update tap configuration operation. options - InterfaceTapConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the InterfaceTapConfigurationsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceTapConfigurationCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfaceTapConfigurationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-interface-name>",
		"<tap-configuration-name>",
		armnetwork.InterfaceTapConfiguration{
			Properties: &armnetwork.InterfaceTapConfigurationPropertiesFormat{
				VirtualNetworkTap: &armnetwork.VirtualNetworkTap{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InterfaceTapConfigurationsClientCreateOrUpdateResult)
}

Output:

func (*InterfaceTapConfigurationsClient) BeginDelete added in v0.3.0 

func (client *InterfaceTapConfigurationsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkInterfaceName string, tapConfigurationName string, options *InterfaceTapConfigurationsClientBeginDeleteOptions) (InterfaceTapConfigurationsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified tap configuration from the NetworkInterface. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. tapConfigurationName - The name of the tap configuration. options - InterfaceTapConfigurationsClientBeginDeleteOptions contains the optional parameters for the InterfaceTapConfigurationsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceTapConfigurationDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfaceTapConfigurationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-interface-name>",
		"<tap-configuration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*InterfaceTapConfigurationsClient) Get added in v0.3.0 

func (client *InterfaceTapConfigurationsClient) Get(ctx context.Context, resourceGroupName string, networkInterfaceName string, tapConfigurationName string, options *InterfaceTapConfigurationsClientGetOptions) (InterfaceTapConfigurationsClientGetResponse, error)

Get - Get the specified tap configuration on a network interface. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. tapConfigurationName - The name of the tap configuration. options - InterfaceTapConfigurationsClientGetOptions contains the optional parameters for the InterfaceTapConfigurationsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceTapConfigurationGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfaceTapConfigurationsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-interface-name>",
		"<tap-configuration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InterfaceTapConfigurationsClientGetResult)
}

Output:

func (*InterfaceTapConfigurationsClient) List added in v0.3.0 

func (client *InterfaceTapConfigurationsClient) List(resourceGroupName string, networkInterfaceName string, options *InterfaceTapConfigurationsClientListOptions) *InterfaceTapConfigurationsClientListPager

List - Get all Tap configurations in a network interface. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. options - InterfaceTapConfigurationsClientListOptions contains the optional parameters for the InterfaceTapConfigurationsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceTapConfigurationList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfaceTapConfigurationsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<network-interface-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type InterfaceTapConfigurationsClientBeginCreateOrUpdateOptions added in v0.3.0 

type InterfaceTapConfigurationsClientBeginCreateOrUpdateOptions struct {
}

InterfaceTapConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the InterfaceTapConfigurationsClient.BeginCreateOrUpdate method.

type InterfaceTapConfigurationsClientBeginDeleteOptions added in v0.3.0 

type InterfaceTapConfigurationsClientBeginDeleteOptions struct {
}

InterfaceTapConfigurationsClientBeginDeleteOptions contains the optional parameters for the InterfaceTapConfigurationsClient.BeginDelete method.

type InterfaceTapConfigurationsClientCreateOrUpdatePoller added in v0.3.0 

type InterfaceTapConfigurationsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

InterfaceTapConfigurationsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*InterfaceTapConfigurationsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *InterfaceTapConfigurationsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*InterfaceTapConfigurationsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *InterfaceTapConfigurationsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (InterfaceTapConfigurationsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InterfaceTapConfigurationsClientCreateOrUpdateResponse will be returned.

func (*InterfaceTapConfigurationsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *InterfaceTapConfigurationsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InterfaceTapConfigurationsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *InterfaceTapConfigurationsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InterfaceTapConfigurationsClientCreateOrUpdatePollerResponse added in v0.3.0 

type InterfaceTapConfigurationsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InterfaceTapConfigurationsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfaceTapConfigurationsClientCreateOrUpdatePollerResponse contains the response from method InterfaceTapConfigurationsClient.CreateOrUpdate.

func (InterfaceTapConfigurationsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l InterfaceTapConfigurationsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (InterfaceTapConfigurationsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InterfaceTapConfigurationsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *InterfaceTapConfigurationsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *InterfaceTapConfigurationsClient, token string) error

Resume rehydrates a InterfaceTapConfigurationsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type InterfaceTapConfigurationsClientCreateOrUpdateResponse added in v0.3.0 

type InterfaceTapConfigurationsClientCreateOrUpdateResponse struct {
	InterfaceTapConfigurationsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfaceTapConfigurationsClientCreateOrUpdateResponse contains the response from method InterfaceTapConfigurationsClient.CreateOrUpdate.

type InterfaceTapConfigurationsClientCreateOrUpdateResult added in v0.3.0 

type InterfaceTapConfigurationsClientCreateOrUpdateResult struct {
	InterfaceTapConfiguration
}

InterfaceTapConfigurationsClientCreateOrUpdateResult contains the result from method InterfaceTapConfigurationsClient.CreateOrUpdate.

type InterfaceTapConfigurationsClientDeletePoller added in v0.3.0 

type InterfaceTapConfigurationsClientDeletePoller struct {
	// contains filtered or unexported fields
}

InterfaceTapConfigurationsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*InterfaceTapConfigurationsClientDeletePoller) Done added in v0.3.0 

func (p *InterfaceTapConfigurationsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*InterfaceTapConfigurationsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *InterfaceTapConfigurationsClientDeletePoller) FinalResponse(ctx context.Context) (InterfaceTapConfigurationsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InterfaceTapConfigurationsClientDeleteResponse will be returned.

func (*InterfaceTapConfigurationsClientDeletePoller) Poll added in v0.3.0 

func (p *InterfaceTapConfigurationsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InterfaceTapConfigurationsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *InterfaceTapConfigurationsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InterfaceTapConfigurationsClientDeletePollerResponse added in v0.3.0 

type InterfaceTapConfigurationsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InterfaceTapConfigurationsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfaceTapConfigurationsClientDeletePollerResponse contains the response from method InterfaceTapConfigurationsClient.Delete.

func (InterfaceTapConfigurationsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l InterfaceTapConfigurationsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (InterfaceTapConfigurationsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InterfaceTapConfigurationsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *InterfaceTapConfigurationsClientDeletePollerResponse) Resume(ctx context.Context, client *InterfaceTapConfigurationsClient, token string) error

Resume rehydrates a InterfaceTapConfigurationsClientDeletePollerResponse from the provided client and resume token.

type InterfaceTapConfigurationsClientDeleteResponse added in v0.3.0 

type InterfaceTapConfigurationsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfaceTapConfigurationsClientDeleteResponse contains the response from method InterfaceTapConfigurationsClient.Delete.

type InterfaceTapConfigurationsClientGetOptions added in v0.3.0 

type InterfaceTapConfigurationsClientGetOptions struct {
}

InterfaceTapConfigurationsClientGetOptions contains the optional parameters for the InterfaceTapConfigurationsClient.Get method.

type InterfaceTapConfigurationsClientGetResponse added in v0.3.0 

type InterfaceTapConfigurationsClientGetResponse struct {
	InterfaceTapConfigurationsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfaceTapConfigurationsClientGetResponse contains the response from method InterfaceTapConfigurationsClient.Get.

type InterfaceTapConfigurationsClientGetResult added in v0.3.0 

type InterfaceTapConfigurationsClientGetResult struct {
	InterfaceTapConfiguration
}

InterfaceTapConfigurationsClientGetResult contains the result from method InterfaceTapConfigurationsClient.Get.

type InterfaceTapConfigurationsClientListOptions added in v0.3.0 

type InterfaceTapConfigurationsClientListOptions struct {
}

InterfaceTapConfigurationsClientListOptions contains the optional parameters for the InterfaceTapConfigurationsClient.List method.

type InterfaceTapConfigurationsClientListPager added in v0.3.0 

type InterfaceTapConfigurationsClientListPager struct {
	// contains filtered or unexported fields
}

InterfaceTapConfigurationsClientListPager provides operations for iterating over paged responses.

func (*InterfaceTapConfigurationsClientListPager) Err added in v0.3.0 

func (p *InterfaceTapConfigurationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*InterfaceTapConfigurationsClientListPager) NextPage added in v0.3.0 

func (p *InterfaceTapConfigurationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InterfaceTapConfigurationsClientListPager) PageResponse added in v0.3.0 

func (p *InterfaceTapConfigurationsClientListPager) PageResponse() InterfaceTapConfigurationsClientListResponse

PageResponse returns the current InterfaceTapConfigurationsClientListResponse page.

type InterfaceTapConfigurationsClientListResponse added in v0.3.0 

type InterfaceTapConfigurationsClientListResponse struct {
	InterfaceTapConfigurationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfaceTapConfigurationsClientListResponse contains the response from method InterfaceTapConfigurationsClient.List.

type InterfaceTapConfigurationsClientListResult added in v0.3.0 

type InterfaceTapConfigurationsClientListResult struct {
	InterfaceTapConfigurationListResult
}

InterfaceTapConfigurationsClientListResult contains the result from method InterfaceTapConfigurationsClient.List.

type InterfacesClient added in v0.3.0 

type InterfacesClient struct {
	// contains filtered or unexported fields
}

InterfacesClient contains the methods for the NetworkInterfaces group. Don't use this type directly, use NewInterfacesClient() instead.

func NewInterfacesClient added in v0.3.0 

func NewInterfacesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *InterfacesClient

NewInterfacesClient creates a new instance of InterfacesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*InterfacesClient) BeginCreateOrUpdate added in v0.3.0 

func (client *InterfacesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkInterfaceName string, parameters Interface, options *InterfacesClientBeginCreateOrUpdateOptions) (InterfacesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a network interface. If the operation fails it returns an *azcore.ResponseError type. 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. options - InterfacesClientBeginCreateOrUpdateOptions contains the optional parameters for the InterfacesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-interface-name>",
		armnetwork.Interface{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.InterfacePropertiesFormat{
				EnableAcceleratedNetworking: to.BoolPtr(true),
				IPConfigurations: []*armnetwork.InterfaceIPConfiguration{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.InterfaceIPConfigurationPropertiesFormat{
							PublicIPAddress: &armnetwork.PublicIPAddress{
								ID: to.StringPtr("<id>"),
							},
							Subnet: &armnetwork.Subnet{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InterfacesClientCreateOrUpdateResult)
}

Output:

func (*InterfacesClient) BeginDelete added in v0.3.0 

func (client *InterfacesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkInterfaceName string, options *InterfacesClientBeginDeleteOptions) (InterfacesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified network interface. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. options - InterfacesClientBeginDeleteOptions contains the optional parameters for the InterfacesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-interface-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*InterfacesClient) BeginGetEffectiveRouteTable added in v0.3.0 

func (client *InterfacesClient) BeginGetEffectiveRouteTable(ctx context.Context, resourceGroupName string, networkInterfaceName string, options *InterfacesClientBeginGetEffectiveRouteTableOptions) (InterfacesClientGetEffectiveRouteTablePollerResponse, error)

BeginGetEffectiveRouteTable - Gets all route tables applied to a network interface. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. options - InterfacesClientBeginGetEffectiveRouteTableOptions contains the optional parameters for the InterfacesClient.BeginGetEffectiveRouteTable method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceEffectiveRouteTableList.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetEffectiveRouteTable(ctx,
		"<resource-group-name>",
		"<network-interface-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InterfacesClientGetEffectiveRouteTableResult)
}

Output:

func (*InterfacesClient) BeginListEffectiveNetworkSecurityGroups added in v0.3.0 

func (client *InterfacesClient) BeginListEffectiveNetworkSecurityGroups(ctx context.Context, resourceGroupName string, networkInterfaceName string, options *InterfacesClientBeginListEffectiveNetworkSecurityGroupsOptions) (InterfacesClientListEffectiveNetworkSecurityGroupsPollerResponse, error)

BeginListEffectiveNetworkSecurityGroups - Gets all network security groups applied to a network interface. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. options - InterfacesClientBeginListEffectiveNetworkSecurityGroupsOptions contains the optional parameters for the InterfacesClient.BeginListEffectiveNetworkSecurityGroups method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceEffectiveNSGList.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListEffectiveNetworkSecurityGroups(ctx,
		"<resource-group-name>",
		"<network-interface-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InterfacesClientListEffectiveNetworkSecurityGroupsResult)
}

Output:

func (*InterfacesClient) Get added in v0.3.0 

func (client *InterfacesClient) Get(ctx context.Context, resourceGroupName string, networkInterfaceName string, options *InterfacesClientGetOptions) (InterfacesClientGetResponse, error)

Get - Gets information about the specified network interface. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. options - InterfacesClientGetOptions contains the optional parameters for the InterfacesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-interface-name>",
		&armnetwork.InterfacesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InterfacesClientGetResult)
}

Output:

func (*InterfacesClient) GetCloudServiceNetworkInterface added in v0.3.0 

func (client *InterfacesClient) GetCloudServiceNetworkInterface(ctx context.Context, resourceGroupName string, cloudServiceName string, roleInstanceName string, networkInterfaceName string, options *InterfacesClientGetCloudServiceNetworkInterfaceOptions) (InterfacesClientGetCloudServiceNetworkInterfaceResponse, error)

GetCloudServiceNetworkInterface - Get the specified network interface in a cloud service. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. cloudServiceName - The name of the cloud service. roleInstanceName - The name of role instance. networkInterfaceName - The name of the network interface. options - InterfacesClientGetCloudServiceNetworkInterfaceOptions contains the optional parameters for the InterfacesClient.GetCloudServiceNetworkInterface method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CloudServiceNetworkInterfaceGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	res, err := client.GetCloudServiceNetworkInterface(ctx,
		"<resource-group-name>",
		"<cloud-service-name>",
		"<role-instance-name>",
		"<network-interface-name>",
		&armnetwork.InterfacesClientGetCloudServiceNetworkInterfaceOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InterfacesClientGetCloudServiceNetworkInterfaceResult)
}

Output:

func (*InterfacesClient) GetVirtualMachineScaleSetIPConfiguration added in v0.3.0 

func (client *InterfacesClient) GetVirtualMachineScaleSetIPConfiguration(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, ipConfigurationName string, options *InterfacesClientGetVirtualMachineScaleSetIPConfigurationOptions) (InterfacesClientGetVirtualMachineScaleSetIPConfigurationResponse, error)

GetVirtualMachineScaleSetIPConfiguration - Get the specified network interface ip configuration in a virtual machine scale set. If the operation fails it returns an *azcore.ResponseError type. 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. ipConfigurationName - The name of the ip configuration. options - InterfacesClientGetVirtualMachineScaleSetIPConfigurationOptions contains the optional parameters for the InterfacesClient.GetVirtualMachineScaleSetIPConfiguration method.

func (*InterfacesClient) GetVirtualMachineScaleSetNetworkInterface added in v0.3.0 

func (client *InterfacesClient) GetVirtualMachineScaleSetNetworkInterface(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, options *InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceOptions) (InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResponse, error)

GetVirtualMachineScaleSetNetworkInterface - Get the specified network interface in a virtual machine scale set. If the operation fails it returns an *azcore.ResponseError type. 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. options - InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceOptions contains the optional parameters for the InterfacesClient.GetVirtualMachineScaleSetNetworkInterface method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VmssNetworkInterfaceGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	res, err := client.GetVirtualMachineScaleSetNetworkInterface(ctx,
		"<resource-group-name>",
		"<virtual-machine-scale-set-name>",
		"<virtualmachine-index>",
		"<network-interface-name>",
		&armnetwork.InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResult)
}

Output:

func (*InterfacesClient) List added in v0.3.0 

func (client *InterfacesClient) List(resourceGroupName string, options *InterfacesClientListOptions) *InterfacesClientListPager

List - Gets all network interfaces in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - InterfacesClientListOptions contains the optional parameters for the InterfacesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*InterfacesClient) ListAll added in v0.3.0 

func (client *InterfacesClient) ListAll(options *InterfacesClientListAllOptions) *InterfacesClientListAllPager

ListAll - Gets all network interfaces in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - InterfacesClientListAllOptions contains the optional parameters for the InterfacesClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*InterfacesClient) ListCloudServiceNetworkInterfaces added in v0.3.0 

func (client *InterfacesClient) ListCloudServiceNetworkInterfaces(resourceGroupName string, cloudServiceName string, options *InterfacesClientListCloudServiceNetworkInterfacesOptions) *InterfacesClientListCloudServiceNetworkInterfacesPager

ListCloudServiceNetworkInterfaces - Gets all network interfaces in a cloud service. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. cloudServiceName - The name of the cloud service. options - InterfacesClientListCloudServiceNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListCloudServiceNetworkInterfaces method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CloudServiceNetworkInterfaceList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	pager := client.ListCloudServiceNetworkInterfaces("<resource-group-name>",
		"<cloud-service-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*InterfacesClient) ListCloudServiceRoleInstanceNetworkInterfaces added in v0.3.0 

func (client *InterfacesClient) ListCloudServiceRoleInstanceNetworkInterfaces(resourceGroupName string, cloudServiceName string, roleInstanceName string, options *InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesOptions) *InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesPager

ListCloudServiceRoleInstanceNetworkInterfaces - Gets information about all network interfaces in a role instance in a cloud service. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. cloudServiceName - The name of the cloud service. roleInstanceName - The name of role instance. options - InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListCloudServiceRoleInstanceNetworkInterfaces method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CloudServiceRoleInstanceNetworkInterfaceList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	pager := client.ListCloudServiceRoleInstanceNetworkInterfaces("<resource-group-name>",
		"<cloud-service-name>",
		"<role-instance-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*InterfacesClient) ListVirtualMachineScaleSetIPConfigurations added in v0.3.0 

func (client *InterfacesClient) ListVirtualMachineScaleSetIPConfigurations(resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, options *InterfacesClientListVirtualMachineScaleSetIPConfigurationsOptions) *InterfacesClientListVirtualMachineScaleSetIPConfigurationsPager

ListVirtualMachineScaleSetIPConfigurations - Get the specified network interface ip configuration in a virtual machine scale set. If the operation fails it returns an *azcore.ResponseError type. 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. options - InterfacesClientListVirtualMachineScaleSetIPConfigurationsOptions contains the optional parameters for the InterfacesClient.ListVirtualMachineScaleSetIPConfigurations method.

func (*InterfacesClient) ListVirtualMachineScaleSetNetworkInterfaces added in v0.3.0 

func (client *InterfacesClient) ListVirtualMachineScaleSetNetworkInterfaces(resourceGroupName string, virtualMachineScaleSetName string, options *InterfacesClientListVirtualMachineScaleSetNetworkInterfacesOptions) *InterfacesClientListVirtualMachineScaleSetNetworkInterfacesPager

ListVirtualMachineScaleSetNetworkInterfaces - Gets all network interfaces in a virtual machine scale set. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualMachineScaleSetName - The name of the virtual machine scale set. options - InterfacesClientListVirtualMachineScaleSetNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListVirtualMachineScaleSetNetworkInterfaces method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VmssNetworkInterfaceList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	pager := client.ListVirtualMachineScaleSetNetworkInterfaces("<resource-group-name>",
		"<virtual-machine-scale-set-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*InterfacesClient) ListVirtualMachineScaleSetVMNetworkInterfaces added in v0.3.0 

func (client *InterfacesClient) ListVirtualMachineScaleSetVMNetworkInterfaces(resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, options *InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesOptions) *InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesPager

ListVirtualMachineScaleSetVMNetworkInterfaces - Gets information about all network interfaces in a virtual machine in a virtual machine scale set. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualMachineScaleSetName - The name of the virtual machine scale set. virtualmachineIndex - The virtual machine index. options - InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListVirtualMachineScaleSetVMNetworkInterfaces method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VmssVmNetworkInterfaceList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	pager := client.ListVirtualMachineScaleSetVMNetworkInterfaces("<resource-group-name>",
		"<virtual-machine-scale-set-name>",
		"<virtualmachine-index>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*InterfacesClient) UpdateTags added in v0.3.0 

func (client *InterfacesClient) UpdateTags(ctx context.Context, resourceGroupName string, networkInterfaceName string, parameters TagsObject, options *InterfacesClientUpdateTagsOptions) (InterfacesClientUpdateTagsResponse, error)

UpdateTags - Updates a network interface tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkInterfaceName - The name of the network interface. parameters - Parameters supplied to update network interface tags. options - InterfacesClientUpdateTagsOptions contains the optional parameters for the InterfacesClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkInterfaceUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewInterfacesClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<network-interface-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.InterfacesClientUpdateTagsResult)
}

Output:

type InterfacesClientBeginCreateOrUpdateOptions added in v0.3.0 

type InterfacesClientBeginCreateOrUpdateOptions struct {
}

InterfacesClientBeginCreateOrUpdateOptions contains the optional parameters for the InterfacesClient.BeginCreateOrUpdate method.

type InterfacesClientBeginDeleteOptions added in v0.3.0 

type InterfacesClientBeginDeleteOptions struct {
}

InterfacesClientBeginDeleteOptions contains the optional parameters for the InterfacesClient.BeginDelete method.

type InterfacesClientBeginGetEffectiveRouteTableOptions added in v0.3.0 

type InterfacesClientBeginGetEffectiveRouteTableOptions struct {
}

InterfacesClientBeginGetEffectiveRouteTableOptions contains the optional parameters for the InterfacesClient.BeginGetEffectiveRouteTable method.

type InterfacesClientBeginListEffectiveNetworkSecurityGroupsOptions added in v0.3.0 

type InterfacesClientBeginListEffectiveNetworkSecurityGroupsOptions struct {
}

InterfacesClientBeginListEffectiveNetworkSecurityGroupsOptions contains the optional parameters for the InterfacesClient.BeginListEffectiveNetworkSecurityGroups method.

type InterfacesClientCreateOrUpdatePoller added in v0.3.0 

type InterfacesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

InterfacesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*InterfacesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *InterfacesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*InterfacesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *InterfacesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (InterfacesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InterfacesClientCreateOrUpdateResponse will be returned.

func (*InterfacesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *InterfacesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InterfacesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *InterfacesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InterfacesClientCreateOrUpdatePollerResponse added in v0.3.0 

type InterfacesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InterfacesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientCreateOrUpdatePollerResponse contains the response from method InterfacesClient.CreateOrUpdate.

func (InterfacesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l InterfacesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (InterfacesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InterfacesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *InterfacesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *InterfacesClient, token string) error

Resume rehydrates a InterfacesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type InterfacesClientCreateOrUpdateResponse added in v0.3.0 

type InterfacesClientCreateOrUpdateResponse struct {
	InterfacesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientCreateOrUpdateResponse contains the response from method InterfacesClient.CreateOrUpdate.

type InterfacesClientCreateOrUpdateResult added in v0.3.0 

type InterfacesClientCreateOrUpdateResult struct {
	Interface
}

InterfacesClientCreateOrUpdateResult contains the result from method InterfacesClient.CreateOrUpdate.

type InterfacesClientDeletePoller added in v0.3.0 

type InterfacesClientDeletePoller struct {
	// contains filtered or unexported fields
}

InterfacesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*InterfacesClientDeletePoller) Done added in v0.3.0 

func (p *InterfacesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*InterfacesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *InterfacesClientDeletePoller) FinalResponse(ctx context.Context) (InterfacesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InterfacesClientDeleteResponse will be returned.

func (*InterfacesClientDeletePoller) Poll added in v0.3.0 

func (p *InterfacesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InterfacesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *InterfacesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InterfacesClientDeletePollerResponse added in v0.3.0 

type InterfacesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InterfacesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientDeletePollerResponse contains the response from method InterfacesClient.Delete.

func (InterfacesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l InterfacesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (InterfacesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InterfacesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *InterfacesClientDeletePollerResponse) Resume(ctx context.Context, client *InterfacesClient, token string) error

Resume rehydrates a InterfacesClientDeletePollerResponse from the provided client and resume token.

type InterfacesClientDeleteResponse added in v0.3.0 

type InterfacesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientDeleteResponse contains the response from method InterfacesClient.Delete.

type InterfacesClientGetCloudServiceNetworkInterfaceOptions added in v0.3.0 

type InterfacesClientGetCloudServiceNetworkInterfaceOptions struct {
	// Expands referenced resources.
	Expand *string
}

InterfacesClientGetCloudServiceNetworkInterfaceOptions contains the optional parameters for the InterfacesClient.GetCloudServiceNetworkInterface method.

type InterfacesClientGetCloudServiceNetworkInterfaceResponse added in v0.3.0 

type InterfacesClientGetCloudServiceNetworkInterfaceResponse struct {
	InterfacesClientGetCloudServiceNetworkInterfaceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientGetCloudServiceNetworkInterfaceResponse contains the response from method InterfacesClient.GetCloudServiceNetworkInterface.

type InterfacesClientGetCloudServiceNetworkInterfaceResult added in v0.3.0 

type InterfacesClientGetCloudServiceNetworkInterfaceResult struct {
	Interface
}

InterfacesClientGetCloudServiceNetworkInterfaceResult contains the result from method InterfacesClient.GetCloudServiceNetworkInterface.

type InterfacesClientGetEffectiveRouteTablePoller added in v0.3.0 

type InterfacesClientGetEffectiveRouteTablePoller struct {
	// contains filtered or unexported fields
}

InterfacesClientGetEffectiveRouteTablePoller provides polling facilities until the operation reaches a terminal state.

func (*InterfacesClientGetEffectiveRouteTablePoller) Done added in v0.3.0 

func (p *InterfacesClientGetEffectiveRouteTablePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*InterfacesClientGetEffectiveRouteTablePoller) FinalResponse added in v0.3.0 

func (p *InterfacesClientGetEffectiveRouteTablePoller) FinalResponse(ctx context.Context) (InterfacesClientGetEffectiveRouteTableResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InterfacesClientGetEffectiveRouteTableResponse will be returned.

func (*InterfacesClientGetEffectiveRouteTablePoller) Poll added in v0.3.0 

func (p *InterfacesClientGetEffectiveRouteTablePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InterfacesClientGetEffectiveRouteTablePoller) ResumeToken added in v0.3.0 

func (p *InterfacesClientGetEffectiveRouteTablePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InterfacesClientGetEffectiveRouteTablePollerResponse added in v0.3.0 

type InterfacesClientGetEffectiveRouteTablePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InterfacesClientGetEffectiveRouteTablePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientGetEffectiveRouteTablePollerResponse contains the response from method InterfacesClient.GetEffectiveRouteTable.

func (InterfacesClientGetEffectiveRouteTablePollerResponse) PollUntilDone added in v0.3.0 

func (l InterfacesClientGetEffectiveRouteTablePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (InterfacesClientGetEffectiveRouteTableResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InterfacesClientGetEffectiveRouteTablePollerResponse) Resume added in v0.3.0 

func (l *InterfacesClientGetEffectiveRouteTablePollerResponse) Resume(ctx context.Context, client *InterfacesClient, token string) error

Resume rehydrates a InterfacesClientGetEffectiveRouteTablePollerResponse from the provided client and resume token.

type InterfacesClientGetEffectiveRouteTableResponse added in v0.3.0 

type InterfacesClientGetEffectiveRouteTableResponse struct {
	InterfacesClientGetEffectiveRouteTableResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientGetEffectiveRouteTableResponse contains the response from method InterfacesClient.GetEffectiveRouteTable.

type InterfacesClientGetEffectiveRouteTableResult added in v0.3.0 

type InterfacesClientGetEffectiveRouteTableResult struct {
	EffectiveRouteListResult
}

InterfacesClientGetEffectiveRouteTableResult contains the result from method InterfacesClient.GetEffectiveRouteTable.

type InterfacesClientGetOptions added in v0.3.0 

type InterfacesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

InterfacesClientGetOptions contains the optional parameters for the InterfacesClient.Get method.

type InterfacesClientGetResponse added in v0.3.0 

type InterfacesClientGetResponse struct {
	InterfacesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientGetResponse contains the response from method InterfacesClient.Get.

type InterfacesClientGetResult added in v0.3.0 

type InterfacesClientGetResult struct {
	Interface
}

InterfacesClientGetResult contains the result from method InterfacesClient.Get.

type InterfacesClientGetVirtualMachineScaleSetIPConfigurationOptions added in v0.3.0 

type InterfacesClientGetVirtualMachineScaleSetIPConfigurationOptions struct {
	// Expands referenced resources.
	Expand *string
}

InterfacesClientGetVirtualMachineScaleSetIPConfigurationOptions contains the optional parameters for the InterfacesClient.GetVirtualMachineScaleSetIPConfiguration method.

type InterfacesClientGetVirtualMachineScaleSetIPConfigurationResponse added in v0.3.0 

type InterfacesClientGetVirtualMachineScaleSetIPConfigurationResponse struct {
	InterfacesClientGetVirtualMachineScaleSetIPConfigurationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientGetVirtualMachineScaleSetIPConfigurationResponse contains the response from method InterfacesClient.GetVirtualMachineScaleSetIPConfiguration.

type InterfacesClientGetVirtualMachineScaleSetIPConfigurationResult added in v0.3.0 

type InterfacesClientGetVirtualMachineScaleSetIPConfigurationResult struct {
	InterfaceIPConfiguration
}

InterfacesClientGetVirtualMachineScaleSetIPConfigurationResult contains the result from method InterfacesClient.GetVirtualMachineScaleSetIPConfiguration.

type InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceOptions added in v0.3.0 

type InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceOptions struct {
	// Expands referenced resources.
	Expand *string
}

InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceOptions contains the optional parameters for the InterfacesClient.GetVirtualMachineScaleSetNetworkInterface method.

type InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResponse added in v0.3.0 

type InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResponse struct {
	InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResponse contains the response from method InterfacesClient.GetVirtualMachineScaleSetNetworkInterface.

type InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResult added in v0.3.0 

type InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResult struct {
	Interface
}

InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResult contains the result from method InterfacesClient.GetVirtualMachineScaleSetNetworkInterface.

type InterfacesClientListAllOptions added in v0.3.0 

type InterfacesClientListAllOptions struct {
}

InterfacesClientListAllOptions contains the optional parameters for the InterfacesClient.ListAll method.

type InterfacesClientListAllPager added in v0.3.0 

type InterfacesClientListAllPager struct {
	// contains filtered or unexported fields
}

InterfacesClientListAllPager provides operations for iterating over paged responses.

func (*InterfacesClientListAllPager) Err added in v0.3.0 

func (p *InterfacesClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*InterfacesClientListAllPager) NextPage added in v0.3.0 

func (p *InterfacesClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InterfacesClientListAllPager) PageResponse added in v0.3.0 

func (p *InterfacesClientListAllPager) PageResponse() InterfacesClientListAllResponse

PageResponse returns the current InterfacesClientListAllResponse page.

type InterfacesClientListAllResponse added in v0.3.0 

type InterfacesClientListAllResponse struct {
	InterfacesClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientListAllResponse contains the response from method InterfacesClient.ListAll.

type InterfacesClientListAllResult added in v0.3.0 

type InterfacesClientListAllResult struct {
	InterfaceListResult
}

InterfacesClientListAllResult contains the result from method InterfacesClient.ListAll.

type InterfacesClientListCloudServiceNetworkInterfacesOptions added in v0.3.0 

type InterfacesClientListCloudServiceNetworkInterfacesOptions struct {
}

InterfacesClientListCloudServiceNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListCloudServiceNetworkInterfaces method.

type InterfacesClientListCloudServiceNetworkInterfacesPager added in v0.3.0 

type InterfacesClientListCloudServiceNetworkInterfacesPager struct {
	// contains filtered or unexported fields
}

InterfacesClientListCloudServiceNetworkInterfacesPager provides operations for iterating over paged responses.

func (*InterfacesClientListCloudServiceNetworkInterfacesPager) Err added in v0.3.0 

func (p *InterfacesClientListCloudServiceNetworkInterfacesPager) Err() error

Err returns the last error encountered while paging.

func (*InterfacesClientListCloudServiceNetworkInterfacesPager) NextPage added in v0.3.0 

func (p *InterfacesClientListCloudServiceNetworkInterfacesPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InterfacesClientListCloudServiceNetworkInterfacesPager) PageResponse added in v0.3.0 

func (p *InterfacesClientListCloudServiceNetworkInterfacesPager) PageResponse() InterfacesClientListCloudServiceNetworkInterfacesResponse

PageResponse returns the current InterfacesClientListCloudServiceNetworkInterfacesResponse page.

type InterfacesClientListCloudServiceNetworkInterfacesResponse added in v0.3.0 

type InterfacesClientListCloudServiceNetworkInterfacesResponse struct {
	InterfacesClientListCloudServiceNetworkInterfacesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientListCloudServiceNetworkInterfacesResponse contains the response from method InterfacesClient.ListCloudServiceNetworkInterfaces.

type InterfacesClientListCloudServiceNetworkInterfacesResult added in v0.3.0 

type InterfacesClientListCloudServiceNetworkInterfacesResult struct {
	InterfaceListResult
}

InterfacesClientListCloudServiceNetworkInterfacesResult contains the result from method InterfacesClient.ListCloudServiceNetworkInterfaces.

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesOptions added in v0.3.0 

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesOptions struct {
}

InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListCloudServiceRoleInstanceNetworkInterfaces method.

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesPager added in v0.3.0 

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesPager struct {
	// contains filtered or unexported fields
}

InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesPager provides operations for iterating over paged responses.

func (*InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesPager) Err added in v0.3.0 

func (p *InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesPager) Err() error

Err returns the last error encountered while paging.

func (*InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesPager) NextPage added in v0.3.0 

func (p *InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesPager) PageResponse added in v0.3.0 

func (p *InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesPager) PageResponse() InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResponse

PageResponse returns the current InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResponse page.

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResponse added in v0.3.0 

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResponse struct {
	InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResponse contains the response from method InterfacesClient.ListCloudServiceRoleInstanceNetworkInterfaces.

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResult added in v0.3.0 

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResult struct {
	InterfaceListResult
}

InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResult contains the result from method InterfacesClient.ListCloudServiceRoleInstanceNetworkInterfaces.

type InterfacesClientListEffectiveNetworkSecurityGroupsPoller added in v0.3.0 

type InterfacesClientListEffectiveNetworkSecurityGroupsPoller struct {
	// contains filtered or unexported fields
}

InterfacesClientListEffectiveNetworkSecurityGroupsPoller provides polling facilities until the operation reaches a terminal state.

func (*InterfacesClientListEffectiveNetworkSecurityGroupsPoller) Done added in v0.3.0 

func (p *InterfacesClientListEffectiveNetworkSecurityGroupsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*InterfacesClientListEffectiveNetworkSecurityGroupsPoller) FinalResponse added in v0.3.0 

func (p *InterfacesClientListEffectiveNetworkSecurityGroupsPoller) FinalResponse(ctx context.Context) (InterfacesClientListEffectiveNetworkSecurityGroupsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final InterfacesClientListEffectiveNetworkSecurityGroupsResponse will be returned.

func (*InterfacesClientListEffectiveNetworkSecurityGroupsPoller) Poll added in v0.3.0 

func (p *InterfacesClientListEffectiveNetworkSecurityGroupsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*InterfacesClientListEffectiveNetworkSecurityGroupsPoller) ResumeToken added in v0.3.0 

func (p *InterfacesClientListEffectiveNetworkSecurityGroupsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type InterfacesClientListEffectiveNetworkSecurityGroupsPollerResponse added in v0.3.0 

type InterfacesClientListEffectiveNetworkSecurityGroupsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *InterfacesClientListEffectiveNetworkSecurityGroupsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientListEffectiveNetworkSecurityGroupsPollerResponse contains the response from method InterfacesClient.ListEffectiveNetworkSecurityGroups.

func (InterfacesClientListEffectiveNetworkSecurityGroupsPollerResponse) PollUntilDone added in v0.3.0 

func (l InterfacesClientListEffectiveNetworkSecurityGroupsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (InterfacesClientListEffectiveNetworkSecurityGroupsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*InterfacesClientListEffectiveNetworkSecurityGroupsPollerResponse) Resume added in v0.3.0 

func (l *InterfacesClientListEffectiveNetworkSecurityGroupsPollerResponse) Resume(ctx context.Context, client *InterfacesClient, token string) error

Resume rehydrates a InterfacesClientListEffectiveNetworkSecurityGroupsPollerResponse from the provided client and resume token.

type InterfacesClientListEffectiveNetworkSecurityGroupsResponse added in v0.3.0 

type InterfacesClientListEffectiveNetworkSecurityGroupsResponse struct {
	InterfacesClientListEffectiveNetworkSecurityGroupsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientListEffectiveNetworkSecurityGroupsResponse contains the response from method InterfacesClient.ListEffectiveNetworkSecurityGroups.

type InterfacesClientListEffectiveNetworkSecurityGroupsResult added in v0.3.0 

type InterfacesClientListEffectiveNetworkSecurityGroupsResult struct {
	EffectiveNetworkSecurityGroupListResult
}

InterfacesClientListEffectiveNetworkSecurityGroupsResult contains the result from method InterfacesClient.ListEffectiveNetworkSecurityGroups.

type InterfacesClientListOptions added in v0.3.0 

type InterfacesClientListOptions struct {
}

InterfacesClientListOptions contains the optional parameters for the InterfacesClient.List method.

type InterfacesClientListPager added in v0.3.0 

type InterfacesClientListPager struct {
	// contains filtered or unexported fields
}

InterfacesClientListPager provides operations for iterating over paged responses.

func (*InterfacesClientListPager) Err added in v0.3.0 

func (p *InterfacesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*InterfacesClientListPager) NextPage added in v0.3.0 

func (p *InterfacesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InterfacesClientListPager) PageResponse added in v0.3.0 

func (p *InterfacesClientListPager) PageResponse() InterfacesClientListResponse

PageResponse returns the current InterfacesClientListResponse page.

type InterfacesClientListResponse added in v0.3.0 

type InterfacesClientListResponse struct {
	InterfacesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientListResponse contains the response from method InterfacesClient.List.

type InterfacesClientListResult added in v0.3.0 

type InterfacesClientListResult struct {
	InterfaceListResult
}

InterfacesClientListResult contains the result from method InterfacesClient.List.

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsOptions added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsOptions struct {
	// Expands referenced resources.
	Expand *string
}

InterfacesClientListVirtualMachineScaleSetIPConfigurationsOptions contains the optional parameters for the InterfacesClient.ListVirtualMachineScaleSetIPConfigurations method.

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsPager added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsPager struct {
	// contains filtered or unexported fields
}

InterfacesClientListVirtualMachineScaleSetIPConfigurationsPager provides operations for iterating over paged responses.

func (*InterfacesClientListVirtualMachineScaleSetIPConfigurationsPager) Err added in v0.3.0 

func (p *InterfacesClientListVirtualMachineScaleSetIPConfigurationsPager) Err() error

Err returns the last error encountered while paging.

func (*InterfacesClientListVirtualMachineScaleSetIPConfigurationsPager) NextPage added in v0.3.0 

func (p *InterfacesClientListVirtualMachineScaleSetIPConfigurationsPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InterfacesClientListVirtualMachineScaleSetIPConfigurationsPager) PageResponse added in v0.3.0 

func (p *InterfacesClientListVirtualMachineScaleSetIPConfigurationsPager) PageResponse() InterfacesClientListVirtualMachineScaleSetIPConfigurationsResponse

PageResponse returns the current InterfacesClientListVirtualMachineScaleSetIPConfigurationsResponse page.

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsResponse added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsResponse struct {
	InterfacesClientListVirtualMachineScaleSetIPConfigurationsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientListVirtualMachineScaleSetIPConfigurationsResponse contains the response from method InterfacesClient.ListVirtualMachineScaleSetIPConfigurations.

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsResult added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsResult struct {
	InterfaceIPConfigurationListResult
}

InterfacesClientListVirtualMachineScaleSetIPConfigurationsResult contains the result from method InterfacesClient.ListVirtualMachineScaleSetIPConfigurations.

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesOptions added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesOptions struct {
}

InterfacesClientListVirtualMachineScaleSetNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListVirtualMachineScaleSetNetworkInterfaces method.

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesPager added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesPager struct {
	// contains filtered or unexported fields
}

InterfacesClientListVirtualMachineScaleSetNetworkInterfacesPager provides operations for iterating over paged responses.

func (*InterfacesClientListVirtualMachineScaleSetNetworkInterfacesPager) Err added in v0.3.0 

func (p *InterfacesClientListVirtualMachineScaleSetNetworkInterfacesPager) Err() error

Err returns the last error encountered while paging.

func (*InterfacesClientListVirtualMachineScaleSetNetworkInterfacesPager) NextPage added in v0.3.0 

func (p *InterfacesClientListVirtualMachineScaleSetNetworkInterfacesPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InterfacesClientListVirtualMachineScaleSetNetworkInterfacesPager) PageResponse added in v0.3.0 

func (p *InterfacesClientListVirtualMachineScaleSetNetworkInterfacesPager) PageResponse() InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResponse

PageResponse returns the current InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResponse page.

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResponse added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResponse struct {
	InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResponse contains the response from method InterfacesClient.ListVirtualMachineScaleSetNetworkInterfaces.

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResult added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResult struct {
	InterfaceListResult
}

InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResult contains the result from method InterfacesClient.ListVirtualMachineScaleSetNetworkInterfaces.

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesOptions added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesOptions struct {
}

InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListVirtualMachineScaleSetVMNetworkInterfaces method.

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesPager added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesPager struct {
	// contains filtered or unexported fields
}

InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesPager provides operations for iterating over paged responses.

func (*InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesPager) Err added in v0.3.0 

func (p *InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesPager) Err() error

Err returns the last error encountered while paging.

func (*InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesPager) NextPage added in v0.3.0 

func (p *InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesPager) PageResponse added in v0.3.0 

func (p *InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesPager) PageResponse() InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResponse

PageResponse returns the current InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResponse page.

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResponse added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResponse struct {
	InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResponse contains the response from method InterfacesClient.ListVirtualMachineScaleSetVMNetworkInterfaces.

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResult added in v0.3.0 

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResult struct {
	InterfaceListResult
}

InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResult contains the result from method InterfacesClient.ListVirtualMachineScaleSetVMNetworkInterfaces.

type InterfacesClientUpdateTagsOptions added in v0.3.0 

type InterfacesClientUpdateTagsOptions struct {
}

InterfacesClientUpdateTagsOptions contains the optional parameters for the InterfacesClient.UpdateTags method.

type InterfacesClientUpdateTagsResponse added in v0.3.0 

type InterfacesClientUpdateTagsResponse struct {
	InterfacesClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

InterfacesClientUpdateTagsResponse contains the response from method InterfacesClient.UpdateTags.

type InterfacesClientUpdateTagsResult added in v0.3.0 

type InterfacesClientUpdateTagsResult struct {
	Interface
}

InterfacesClientUpdateTagsResult contains the result from method InterfacesClient.UpdateTags.

type IssueType 

type IssueType string

IssueType - The type of issue. 

const (
	IssueTypeAgentStopped        IssueType = "AgentStopped"
	IssueTypeDNSResolution       IssueType = "DnsResolution"
	IssueTypeGuestFirewall       IssueType = "GuestFirewall"
	IssueTypeNetworkSecurityRule IssueType = "NetworkSecurityRule"
	IssueTypePlatform            IssueType = "Platform"
	IssueTypePortThrottled       IssueType = "PortThrottled"
	IssueTypeSocketBind          IssueType = "SocketBind"
	IssueTypeUnknown             IssueType = "Unknown"
	IssueTypeUserDefinedRoute    IssueType = "UserDefinedRoute"
)

func PossibleIssueTypeValues 

func PossibleIssueTypeValues() []IssueType

PossibleIssueTypeValues returns the possible values for the IssueType const type.

func (IssueType) ToPtr 

func (c IssueType) ToPtr() *IssueType

ToPtr returns a *IssueType pointing to the current value.

type ListHubRouteTablesResult 

type ListHubRouteTablesResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of RouteTables.
	Value []*HubRouteTable `json:"value,omitempty"`
}

ListHubRouteTablesResult - List of RouteTables and a URL nextLink to get the next set of results.

func (ListHubRouteTablesResult) MarshalJSON 

func (l ListHubRouteTablesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListHubRouteTablesResult.

type ListHubVirtualNetworkConnectionsResult 

type ListHubVirtualNetworkConnectionsResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of HubVirtualNetworkConnections.
	Value []*HubVirtualNetworkConnection `json:"value,omitempty"`
}

ListHubVirtualNetworkConnectionsResult - List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results.

func (ListHubVirtualNetworkConnectionsResult) MarshalJSON 

func (l ListHubVirtualNetworkConnectionsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListHubVirtualNetworkConnectionsResult.

type ListP2SVPNGatewaysResult 

type ListP2SVPNGatewaysResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of P2SVpnGateways.
	Value []*P2SVPNGateway `json:"value,omitempty"`
}

ListP2SVPNGatewaysResult - Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results.

func (ListP2SVPNGatewaysResult) MarshalJSON 

func (l ListP2SVPNGatewaysResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListP2SVPNGatewaysResult.

type ListRoutingIntentResult added in v0.2.0 

type ListRoutingIntentResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of RoutingIntent resource.
	Value []*RoutingIntent `json:"value,omitempty"`
}

ListRoutingIntentResult - List of the routing intent result and a URL nextLink to get the next set of results.

func (ListRoutingIntentResult) MarshalJSON added in v0.2.0 

func (l ListRoutingIntentResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListRoutingIntentResult.

type ListVPNConnectionsResult 

type ListVPNConnectionsResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Vpn Connections.
	Value []*VPNConnection `json:"value,omitempty"`
}

ListVPNConnectionsResult - Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.

func (ListVPNConnectionsResult) MarshalJSON 

func (l ListVPNConnectionsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVPNConnectionsResult.

type ListVPNGatewayNatRulesResult 

type ListVPNGatewayNatRulesResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Nat Rules.
	Value []*VPNGatewayNatRule `json:"value,omitempty"`
}

ListVPNGatewayNatRulesResult - Result of the request to list all nat rules to a virtual wan vpn gateway. It contains a list of Nat rules and a URL nextLink to get the next set of results.

func (ListVPNGatewayNatRulesResult) MarshalJSON 

func (l ListVPNGatewayNatRulesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVPNGatewayNatRulesResult.

type ListVPNGatewaysResult 

type ListVPNGatewaysResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of VpnGateways.
	Value []*VPNGateway `json:"value,omitempty"`
}

ListVPNGatewaysResult - Result of the request to list VpnGateways. It contains a list of VpnGateways and a URL nextLink to get the next set of results.

func (ListVPNGatewaysResult) MarshalJSON 

func (l ListVPNGatewaysResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVPNGatewaysResult.

type ListVPNServerConfigurationsResult 

type ListVPNServerConfigurationsResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of VpnServerConfigurations.
	Value []*VPNServerConfiguration `json:"value,omitempty"`
}

ListVPNServerConfigurationsResult - Result of the request to list all VpnServerConfigurations. It contains a list of VpnServerConfigurations and a URL nextLink to get the next set of results.

func (ListVPNServerConfigurationsResult) MarshalJSON 

func (l ListVPNServerConfigurationsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVPNServerConfigurationsResult.

type ListVPNSiteLinkConnectionsResult 

type ListVPNSiteLinkConnectionsResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of VpnSiteLinkConnections.
	Value []*VPNSiteLinkConnection `json:"value,omitempty"`
}

ListVPNSiteLinkConnectionsResult - Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.

func (ListVPNSiteLinkConnectionsResult) MarshalJSON 

func (l ListVPNSiteLinkConnectionsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVPNSiteLinkConnectionsResult.

type ListVPNSiteLinksResult 

type ListVPNSiteLinksResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of VpnSitesLinks.
	Value []*VPNSiteLink `json:"value,omitempty"`
}

ListVPNSiteLinksResult - Result of the request to list VpnSiteLinks. It contains a list of VpnSiteLinks and a URL nextLink to get the next set of results.

func (ListVPNSiteLinksResult) MarshalJSON 

func (l ListVPNSiteLinksResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVPNSiteLinksResult.

type ListVPNSitesResult 

type ListVPNSitesResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of VpnSites.
	Value []*VPNSite `json:"value,omitempty"`
}

ListVPNSitesResult - Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results.

func (ListVPNSitesResult) MarshalJSON 

func (l ListVPNSitesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVPNSitesResult.

type ListVirtualHubBgpConnectionResults 

type ListVirtualHubBgpConnectionResults struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of VirtualHubBgpConnections.
	Value []*BgpConnection `json:"value,omitempty"`
}

ListVirtualHubBgpConnectionResults - VirtualHubBgpConnections list.

func (ListVirtualHubBgpConnectionResults) MarshalJSON 

func (l ListVirtualHubBgpConnectionResults) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVirtualHubBgpConnectionResults.

type ListVirtualHubIPConfigurationResults 

type ListVirtualHubIPConfigurationResults struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of VirtualHubIpConfigurations.
	Value []*HubIPConfiguration `json:"value,omitempty"`
}

ListVirtualHubIPConfigurationResults - VirtualHubIpConfigurations list.

func (ListVirtualHubIPConfigurationResults) MarshalJSON 

func (l ListVirtualHubIPConfigurationResults) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVirtualHubIPConfigurationResults.

type ListVirtualHubRouteTableV2SResult 

type ListVirtualHubRouteTableV2SResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of VirtualHubRouteTableV2s.
	Value []*VirtualHubRouteTableV2 `json:"value,omitempty"`
}

ListVirtualHubRouteTableV2SResult - List of VirtualHubRouteTableV2s and a URL nextLink to get the next set of results.

func (ListVirtualHubRouteTableV2SResult) MarshalJSON 

func (l ListVirtualHubRouteTableV2SResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVirtualHubRouteTableV2SResult.

type ListVirtualHubsResult 

type ListVirtualHubsResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of VirtualHubs.
	Value []*VirtualHub `json:"value,omitempty"`
}

ListVirtualHubsResult - Result of the request to list VirtualHubs. It contains a list of VirtualHubs and a URL nextLink to get the next set of results.

func (ListVirtualHubsResult) MarshalJSON 

func (l ListVirtualHubsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVirtualHubsResult.

type ListVirtualNetworkGatewayNatRulesResult 

type ListVirtualNetworkGatewayNatRulesResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Nat Rules.
	Value []*VirtualNetworkGatewayNatRule `json:"value,omitempty"`
}

ListVirtualNetworkGatewayNatRulesResult - Result of the request to list all nat rules to a virtual network gateway. It contains a list of Nat rules and a URL nextLink to get the next set of results.

func (ListVirtualNetworkGatewayNatRulesResult) MarshalJSON 

func (l ListVirtualNetworkGatewayNatRulesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVirtualNetworkGatewayNatRulesResult.

type ListVirtualWANsResult 

type ListVirtualWANsResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of VirtualWANs.
	Value []*VirtualWAN `json:"value,omitempty"`
}

ListVirtualWANsResult - Result of the request to list VirtualWANs. It contains a list of VirtualWANs and a URL nextLink to get the next set of results.

func (ListVirtualWANsResult) MarshalJSON 

func (l ListVirtualWANsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListVirtualWANsResult.

type LoadBalancer 

type LoadBalancer struct {
	// The extended location of the load balancer.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of load balancer.
	Properties *LoadBalancerPropertiesFormat `json:"properties,omitempty"`

	// The load balancer SKU.
	SKU *LoadBalancerSKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

LoadBalancer resource.

func (LoadBalancer) MarshalJSON 

func (l LoadBalancer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancer.

type LoadBalancerBackendAddress 

type LoadBalancerBackendAddress struct {
	// Name of the backend address.
	Name *string `json:"name,omitempty"`

	// Properties of load balancer backend address pool.
	Properties *LoadBalancerBackendAddressPropertiesFormat `json:"properties,omitempty"`
}

LoadBalancerBackendAddress - Load balancer backend addresses.

type LoadBalancerBackendAddressPoolListResult 

type LoadBalancerBackendAddressPoolListResult struct {
	// A list of backend address pools in a load balancer.
	Value []*BackendAddressPool `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

LoadBalancerBackendAddressPoolListResult - Response for ListBackendAddressPool API service call.

func (LoadBalancerBackendAddressPoolListResult) MarshalJSON 

func (l LoadBalancerBackendAddressPoolListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerBackendAddressPoolListResult.

type LoadBalancerBackendAddressPoolsClient 

type LoadBalancerBackendAddressPoolsClient struct {
	// contains filtered or unexported fields
}

LoadBalancerBackendAddressPoolsClient contains the methods for the LoadBalancerBackendAddressPools group. Don't use this type directly, use NewLoadBalancerBackendAddressPoolsClient() instead.

func NewLoadBalancerBackendAddressPoolsClient 

func NewLoadBalancerBackendAddressPoolsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LoadBalancerBackendAddressPoolsClient

NewLoadBalancerBackendAddressPoolsClient creates a new instance of LoadBalancerBackendAddressPoolsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LoadBalancerBackendAddressPoolsClient) BeginCreateOrUpdate 

func (client *LoadBalancerBackendAddressPoolsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, loadBalancerName string, backendAddressPoolName string, parameters BackendAddressPool, options *LoadBalancerBackendAddressPoolsClientBeginCreateOrUpdateOptions) (LoadBalancerBackendAddressPoolsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a load balancer backend address pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. backendAddressPoolName - The name of the backend address pool. parameters - Parameters supplied to the create or update load balancer backend address pool operation. options - LoadBalancerBackendAddressPoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerBackendAddressPoolsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		"<backend-address-pool-name>",
		armnetwork.BackendAddressPool{
			Properties: &armnetwork.BackendAddressPoolPropertiesFormat{
				LoadBalancerBackendAddresses: []*armnetwork.LoadBalancerBackendAddress{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.LoadBalancerBackendAddressPropertiesFormat{
							IPAddress: to.StringPtr("<ipaddress>"),
							VirtualNetwork: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
						},
					},
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.LoadBalancerBackendAddressPropertiesFormat{
							IPAddress: to.StringPtr("<ipaddress>"),
							VirtualNetwork: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LoadBalancerBackendAddressPoolsClientCreateOrUpdateResult)
}

Output:

func (*LoadBalancerBackendAddressPoolsClient) BeginDelete 

func (client *LoadBalancerBackendAddressPoolsClient) BeginDelete(ctx context.Context, resourceGroupName string, loadBalancerName string, backendAddressPoolName string, options *LoadBalancerBackendAddressPoolsClientBeginDeleteOptions) (LoadBalancerBackendAddressPoolsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified load balancer backend address pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. backendAddressPoolName - The name of the backend address pool. options - LoadBalancerBackendAddressPoolsClientBeginDeleteOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerBackendAddressPoolDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerBackendAddressPoolsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		"<backend-address-pool-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*LoadBalancerBackendAddressPoolsClient) Get 

func (client *LoadBalancerBackendAddressPoolsClient) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, backendAddressPoolName string, options *LoadBalancerBackendAddressPoolsClientGetOptions) (LoadBalancerBackendAddressPoolsClientGetResponse, error)

Get - Gets load balancer backend address pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. backendAddressPoolName - The name of the backend address pool. options - LoadBalancerBackendAddressPoolsClientGetOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerBackendAddressPoolsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		"<backend-address-pool-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LoadBalancerBackendAddressPoolsClientGetResult)
}

Output:

func (*LoadBalancerBackendAddressPoolsClient) List 

func (client *LoadBalancerBackendAddressPoolsClient) List(resourceGroupName string, loadBalancerName string, options *LoadBalancerBackendAddressPoolsClientListOptions) *LoadBalancerBackendAddressPoolsClientListPager

List - Gets all the load balancer backed address pools. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. options - LoadBalancerBackendAddressPoolsClientListOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerBackendAddressPoolsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<load-balancer-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type LoadBalancerBackendAddressPoolsClientBeginCreateOrUpdateOptions added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientBeginCreateOrUpdateOptions struct {
}

LoadBalancerBackendAddressPoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.BeginCreateOrUpdate method.

type LoadBalancerBackendAddressPoolsClientBeginDeleteOptions added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientBeginDeleteOptions struct {
}

LoadBalancerBackendAddressPoolsClientBeginDeleteOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.BeginDelete method.

type LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (LoadBalancerBackendAddressPoolsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final LoadBalancerBackendAddressPoolsClientCreateOrUpdateResponse will be returned.

func (*LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type LoadBalancerBackendAddressPoolsClientCreateOrUpdatePollerResponse added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *LoadBalancerBackendAddressPoolsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerBackendAddressPoolsClientCreateOrUpdatePollerResponse contains the response from method LoadBalancerBackendAddressPoolsClient.CreateOrUpdate.

func (LoadBalancerBackendAddressPoolsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l LoadBalancerBackendAddressPoolsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (LoadBalancerBackendAddressPoolsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*LoadBalancerBackendAddressPoolsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *LoadBalancerBackendAddressPoolsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *LoadBalancerBackendAddressPoolsClient, token string) error

Resume rehydrates a LoadBalancerBackendAddressPoolsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type LoadBalancerBackendAddressPoolsClientCreateOrUpdateResponse added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientCreateOrUpdateResponse struct {
	LoadBalancerBackendAddressPoolsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerBackendAddressPoolsClientCreateOrUpdateResponse contains the response from method LoadBalancerBackendAddressPoolsClient.CreateOrUpdate.

type LoadBalancerBackendAddressPoolsClientCreateOrUpdateResult added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientCreateOrUpdateResult struct {
	BackendAddressPool
}

LoadBalancerBackendAddressPoolsClientCreateOrUpdateResult contains the result from method LoadBalancerBackendAddressPoolsClient.CreateOrUpdate.

type LoadBalancerBackendAddressPoolsClientDeletePoller added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientDeletePoller struct {
	// contains filtered or unexported fields
}

LoadBalancerBackendAddressPoolsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*LoadBalancerBackendAddressPoolsClientDeletePoller) Done added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*LoadBalancerBackendAddressPoolsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientDeletePoller) FinalResponse(ctx context.Context) (LoadBalancerBackendAddressPoolsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final LoadBalancerBackendAddressPoolsClientDeleteResponse will be returned.

func (*LoadBalancerBackendAddressPoolsClientDeletePoller) Poll added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*LoadBalancerBackendAddressPoolsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type LoadBalancerBackendAddressPoolsClientDeletePollerResponse added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *LoadBalancerBackendAddressPoolsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerBackendAddressPoolsClientDeletePollerResponse contains the response from method LoadBalancerBackendAddressPoolsClient.Delete.

func (LoadBalancerBackendAddressPoolsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l LoadBalancerBackendAddressPoolsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (LoadBalancerBackendAddressPoolsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*LoadBalancerBackendAddressPoolsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *LoadBalancerBackendAddressPoolsClientDeletePollerResponse) Resume(ctx context.Context, client *LoadBalancerBackendAddressPoolsClient, token string) error

Resume rehydrates a LoadBalancerBackendAddressPoolsClientDeletePollerResponse from the provided client and resume token.

type LoadBalancerBackendAddressPoolsClientDeleteResponse added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerBackendAddressPoolsClientDeleteResponse contains the response from method LoadBalancerBackendAddressPoolsClient.Delete.

type LoadBalancerBackendAddressPoolsClientGetOptions added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientGetOptions struct {
}

LoadBalancerBackendAddressPoolsClientGetOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.Get method.

type LoadBalancerBackendAddressPoolsClientGetResponse added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientGetResponse struct {
	LoadBalancerBackendAddressPoolsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerBackendAddressPoolsClientGetResponse contains the response from method LoadBalancerBackendAddressPoolsClient.Get.

type LoadBalancerBackendAddressPoolsClientGetResult added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientGetResult struct {
	BackendAddressPool
}

LoadBalancerBackendAddressPoolsClientGetResult contains the result from method LoadBalancerBackendAddressPoolsClient.Get.

type LoadBalancerBackendAddressPoolsClientListOptions added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientListOptions struct {
}

LoadBalancerBackendAddressPoolsClientListOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.List method.

type LoadBalancerBackendAddressPoolsClientListPager added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientListPager struct {
	// contains filtered or unexported fields
}

LoadBalancerBackendAddressPoolsClientListPager provides operations for iterating over paged responses.

func (*LoadBalancerBackendAddressPoolsClientListPager) Err added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*LoadBalancerBackendAddressPoolsClientListPager) NextPage added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LoadBalancerBackendAddressPoolsClientListPager) PageResponse added in v0.3.0 

func (p *LoadBalancerBackendAddressPoolsClientListPager) PageResponse() LoadBalancerBackendAddressPoolsClientListResponse

PageResponse returns the current LoadBalancerBackendAddressPoolsClientListResponse page.

type LoadBalancerBackendAddressPoolsClientListResponse added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientListResponse struct {
	LoadBalancerBackendAddressPoolsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerBackendAddressPoolsClientListResponse contains the response from method LoadBalancerBackendAddressPoolsClient.List.

type LoadBalancerBackendAddressPoolsClientListResult added in v0.3.0 

type LoadBalancerBackendAddressPoolsClientListResult struct {
	LoadBalancerBackendAddressPoolListResult
}

LoadBalancerBackendAddressPoolsClientListResult contains the result from method LoadBalancerBackendAddressPoolsClient.List.

type LoadBalancerBackendAddressPropertiesFormat 

type LoadBalancerBackendAddressPropertiesFormat struct {
	// IP Address belonging to the referenced virtual network.
	IPAddress *string `json:"ipAddress,omitempty"`

	// Reference to the frontend ip address configuration defined in regional loadbalancer.
	LoadBalancerFrontendIPConfiguration *SubResource `json:"loadBalancerFrontendIPConfiguration,omitempty"`

	// Reference to an existing subnet.
	Subnet *SubResource `json:"subnet,omitempty"`

	// Reference to an existing virtual network.
	VirtualNetwork *SubResource `json:"virtualNetwork,omitempty"`

	// READ-ONLY; Collection of inbound NAT rule port mappings.
	InboundNatRulesPortMapping []*NatRulePortMapping `json:"inboundNatRulesPortMapping,omitempty" azure:"ro"`

	// READ-ONLY; Reference to IP address defined in network interfaces.
	NetworkInterfaceIPConfiguration *SubResource `json:"networkInterfaceIPConfiguration,omitempty" azure:"ro"`
}

LoadBalancerBackendAddressPropertiesFormat - Properties of the load balancer backend addresses.

func (LoadBalancerBackendAddressPropertiesFormat) MarshalJSON added in v0.2.0 

func (l LoadBalancerBackendAddressPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerBackendAddressPropertiesFormat.

type LoadBalancerFrontendIPConfigurationListResult 

type LoadBalancerFrontendIPConfigurationListResult struct {
	// A list of frontend IP configurations in a load balancer.
	Value []*FrontendIPConfiguration `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

LoadBalancerFrontendIPConfigurationListResult - Response for ListFrontendIPConfiguration API service call.

func (LoadBalancerFrontendIPConfigurationListResult) MarshalJSON 

func (l LoadBalancerFrontendIPConfigurationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerFrontendIPConfigurationListResult.

type LoadBalancerFrontendIPConfigurationsClient 

type LoadBalancerFrontendIPConfigurationsClient struct {
	// contains filtered or unexported fields
}

LoadBalancerFrontendIPConfigurationsClient contains the methods for the LoadBalancerFrontendIPConfigurations group. Don't use this type directly, use NewLoadBalancerFrontendIPConfigurationsClient() instead.

func NewLoadBalancerFrontendIPConfigurationsClient 

func NewLoadBalancerFrontendIPConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LoadBalancerFrontendIPConfigurationsClient

NewLoadBalancerFrontendIPConfigurationsClient creates a new instance of LoadBalancerFrontendIPConfigurationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LoadBalancerFrontendIPConfigurationsClient) Get 

func (client *LoadBalancerFrontendIPConfigurationsClient) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, frontendIPConfigurationName string, options *LoadBalancerFrontendIPConfigurationsClientGetOptions) (LoadBalancerFrontendIPConfigurationsClientGetResponse, error)

Get - Gets load balancer frontend IP configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. frontendIPConfigurationName - The name of the frontend IP configuration. options - LoadBalancerFrontendIPConfigurationsClientGetOptions contains the optional parameters for the LoadBalancerFrontendIPConfigurationsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerFrontendIPConfigurationGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerFrontendIPConfigurationsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		"<frontend-ipconfiguration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LoadBalancerFrontendIPConfigurationsClientGetResult)
}

Output:

func (*LoadBalancerFrontendIPConfigurationsClient) List 

func (client *LoadBalancerFrontendIPConfigurationsClient) List(resourceGroupName string, loadBalancerName string, options *LoadBalancerFrontendIPConfigurationsClientListOptions) *LoadBalancerFrontendIPConfigurationsClientListPager

List - Gets all the load balancer frontend IP configurations. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. options - LoadBalancerFrontendIPConfigurationsClientListOptions contains the optional parameters for the LoadBalancerFrontendIPConfigurationsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerFrontendIPConfigurationList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerFrontendIPConfigurationsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<load-balancer-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type LoadBalancerFrontendIPConfigurationsClientGetOptions added in v0.3.0 

type LoadBalancerFrontendIPConfigurationsClientGetOptions struct {
}

LoadBalancerFrontendIPConfigurationsClientGetOptions contains the optional parameters for the LoadBalancerFrontendIPConfigurationsClient.Get method.

type LoadBalancerFrontendIPConfigurationsClientGetResponse added in v0.3.0 

type LoadBalancerFrontendIPConfigurationsClientGetResponse struct {
	LoadBalancerFrontendIPConfigurationsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerFrontendIPConfigurationsClientGetResponse contains the response from method LoadBalancerFrontendIPConfigurationsClient.Get.

type LoadBalancerFrontendIPConfigurationsClientGetResult added in v0.3.0 

type LoadBalancerFrontendIPConfigurationsClientGetResult struct {
	FrontendIPConfiguration
}

LoadBalancerFrontendIPConfigurationsClientGetResult contains the result from method LoadBalancerFrontendIPConfigurationsClient.Get.

type LoadBalancerFrontendIPConfigurationsClientListOptions added in v0.3.0 

type LoadBalancerFrontendIPConfigurationsClientListOptions struct {
}

LoadBalancerFrontendIPConfigurationsClientListOptions contains the optional parameters for the LoadBalancerFrontendIPConfigurationsClient.List method.

type LoadBalancerFrontendIPConfigurationsClientListPager added in v0.3.0 

type LoadBalancerFrontendIPConfigurationsClientListPager struct {
	// contains filtered or unexported fields
}

LoadBalancerFrontendIPConfigurationsClientListPager provides operations for iterating over paged responses.

func (*LoadBalancerFrontendIPConfigurationsClientListPager) Err added in v0.3.0 

func (p *LoadBalancerFrontendIPConfigurationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*LoadBalancerFrontendIPConfigurationsClientListPager) NextPage added in v0.3.0 

func (p *LoadBalancerFrontendIPConfigurationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LoadBalancerFrontendIPConfigurationsClientListPager) PageResponse added in v0.3.0 

func (p *LoadBalancerFrontendIPConfigurationsClientListPager) PageResponse() LoadBalancerFrontendIPConfigurationsClientListResponse

PageResponse returns the current LoadBalancerFrontendIPConfigurationsClientListResponse page.

type LoadBalancerFrontendIPConfigurationsClientListResponse added in v0.3.0 

type LoadBalancerFrontendIPConfigurationsClientListResponse struct {
	LoadBalancerFrontendIPConfigurationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerFrontendIPConfigurationsClientListResponse contains the response from method LoadBalancerFrontendIPConfigurationsClient.List.

type LoadBalancerFrontendIPConfigurationsClientListResult added in v0.3.0 

type LoadBalancerFrontendIPConfigurationsClientListResult struct {
	LoadBalancerFrontendIPConfigurationListResult
}

LoadBalancerFrontendIPConfigurationsClientListResult contains the result from method LoadBalancerFrontendIPConfigurationsClient.List.

type LoadBalancerListResult 

type LoadBalancerListResult struct {
	// A list of load balancers in a resource group.
	Value []*LoadBalancer `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

LoadBalancerListResult - Response for ListLoadBalancers API service call.

func (LoadBalancerListResult) MarshalJSON 

func (l LoadBalancerListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerListResult.

type LoadBalancerLoadBalancingRuleListResult 

type LoadBalancerLoadBalancingRuleListResult struct {
	// A list of load balancing rules in a load balancer.
	Value []*LoadBalancingRule `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

LoadBalancerLoadBalancingRuleListResult - Response for ListLoadBalancingRule API service call.

func (LoadBalancerLoadBalancingRuleListResult) MarshalJSON 

func (l LoadBalancerLoadBalancingRuleListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerLoadBalancingRuleListResult.

type LoadBalancerLoadBalancingRulesClient 

type LoadBalancerLoadBalancingRulesClient struct {
	// contains filtered or unexported fields
}

LoadBalancerLoadBalancingRulesClient contains the methods for the LoadBalancerLoadBalancingRules group. Don't use this type directly, use NewLoadBalancerLoadBalancingRulesClient() instead.

func NewLoadBalancerLoadBalancingRulesClient 

func NewLoadBalancerLoadBalancingRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LoadBalancerLoadBalancingRulesClient

NewLoadBalancerLoadBalancingRulesClient creates a new instance of LoadBalancerLoadBalancingRulesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LoadBalancerLoadBalancingRulesClient) Get 

func (client *LoadBalancerLoadBalancingRulesClient) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, loadBalancingRuleName string, options *LoadBalancerLoadBalancingRulesClientGetOptions) (LoadBalancerLoadBalancingRulesClientGetResponse, error)

Get - Gets the specified load balancer load balancing rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. loadBalancingRuleName - The name of the load balancing rule. options - LoadBalancerLoadBalancingRulesClientGetOptions contains the optional parameters for the LoadBalancerLoadBalancingRulesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerLoadBalancingRuleGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerLoadBalancingRulesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		"<load-balancing-rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LoadBalancerLoadBalancingRulesClientGetResult)
}

Output:

func (*LoadBalancerLoadBalancingRulesClient) List 

func (client *LoadBalancerLoadBalancingRulesClient) List(resourceGroupName string, loadBalancerName string, options *LoadBalancerLoadBalancingRulesClientListOptions) *LoadBalancerLoadBalancingRulesClientListPager

List - Gets all the load balancing rules in a load balancer. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. options - LoadBalancerLoadBalancingRulesClientListOptions contains the optional parameters for the LoadBalancerLoadBalancingRulesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerLoadBalancingRuleList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerLoadBalancingRulesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<load-balancer-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type LoadBalancerLoadBalancingRulesClientGetOptions added in v0.3.0 

type LoadBalancerLoadBalancingRulesClientGetOptions struct {
}

LoadBalancerLoadBalancingRulesClientGetOptions contains the optional parameters for the LoadBalancerLoadBalancingRulesClient.Get method.

type LoadBalancerLoadBalancingRulesClientGetResponse added in v0.3.0 

type LoadBalancerLoadBalancingRulesClientGetResponse struct {
	LoadBalancerLoadBalancingRulesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerLoadBalancingRulesClientGetResponse contains the response from method LoadBalancerLoadBalancingRulesClient.Get.

type LoadBalancerLoadBalancingRulesClientGetResult added in v0.3.0 

type LoadBalancerLoadBalancingRulesClientGetResult struct {
	LoadBalancingRule
}

LoadBalancerLoadBalancingRulesClientGetResult contains the result from method LoadBalancerLoadBalancingRulesClient.Get.

type LoadBalancerLoadBalancingRulesClientListOptions added in v0.3.0 

type LoadBalancerLoadBalancingRulesClientListOptions struct {
}

LoadBalancerLoadBalancingRulesClientListOptions contains the optional parameters for the LoadBalancerLoadBalancingRulesClient.List method.

type LoadBalancerLoadBalancingRulesClientListPager added in v0.3.0 

type LoadBalancerLoadBalancingRulesClientListPager struct {
	// contains filtered or unexported fields
}

LoadBalancerLoadBalancingRulesClientListPager provides operations for iterating over paged responses.

func (*LoadBalancerLoadBalancingRulesClientListPager) Err added in v0.3.0 

func (p *LoadBalancerLoadBalancingRulesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*LoadBalancerLoadBalancingRulesClientListPager) NextPage added in v0.3.0 

func (p *LoadBalancerLoadBalancingRulesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LoadBalancerLoadBalancingRulesClientListPager) PageResponse added in v0.3.0 

func (p *LoadBalancerLoadBalancingRulesClientListPager) PageResponse() LoadBalancerLoadBalancingRulesClientListResponse

PageResponse returns the current LoadBalancerLoadBalancingRulesClientListResponse page.

type LoadBalancerLoadBalancingRulesClientListResponse added in v0.3.0 

type LoadBalancerLoadBalancingRulesClientListResponse struct {
	LoadBalancerLoadBalancingRulesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerLoadBalancingRulesClientListResponse contains the response from method LoadBalancerLoadBalancingRulesClient.List.

type LoadBalancerLoadBalancingRulesClientListResult added in v0.3.0 

type LoadBalancerLoadBalancingRulesClientListResult struct {
	LoadBalancerLoadBalancingRuleListResult
}

LoadBalancerLoadBalancingRulesClientListResult contains the result from method LoadBalancerLoadBalancingRulesClient.List.

type LoadBalancerNetworkInterfacesClient 

type LoadBalancerNetworkInterfacesClient struct {
	// contains filtered or unexported fields
}

LoadBalancerNetworkInterfacesClient contains the methods for the LoadBalancerNetworkInterfaces group. Don't use this type directly, use NewLoadBalancerNetworkInterfacesClient() instead.

func NewLoadBalancerNetworkInterfacesClient 

func NewLoadBalancerNetworkInterfacesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LoadBalancerNetworkInterfacesClient

NewLoadBalancerNetworkInterfacesClient creates a new instance of LoadBalancerNetworkInterfacesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LoadBalancerNetworkInterfacesClient) List 

func (client *LoadBalancerNetworkInterfacesClient) List(resourceGroupName string, loadBalancerName string, options *LoadBalancerNetworkInterfacesClientListOptions) *LoadBalancerNetworkInterfacesClientListPager

List - Gets associated load balancer network interfaces. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. options - LoadBalancerNetworkInterfacesClientListOptions contains the optional parameters for the LoadBalancerNetworkInterfacesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerNetworkInterfaceListSimple.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerNetworkInterfacesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<load-balancer-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type LoadBalancerNetworkInterfacesClientListOptions added in v0.3.0 

type LoadBalancerNetworkInterfacesClientListOptions struct {
}

LoadBalancerNetworkInterfacesClientListOptions contains the optional parameters for the LoadBalancerNetworkInterfacesClient.List method.

type LoadBalancerNetworkInterfacesClientListPager added in v0.3.0 

type LoadBalancerNetworkInterfacesClientListPager struct {
	// contains filtered or unexported fields
}

LoadBalancerNetworkInterfacesClientListPager provides operations for iterating over paged responses.

func (*LoadBalancerNetworkInterfacesClientListPager) Err added in v0.3.0 

func (p *LoadBalancerNetworkInterfacesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*LoadBalancerNetworkInterfacesClientListPager) NextPage added in v0.3.0 

func (p *LoadBalancerNetworkInterfacesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LoadBalancerNetworkInterfacesClientListPager) PageResponse added in v0.3.0 

func (p *LoadBalancerNetworkInterfacesClientListPager) PageResponse() LoadBalancerNetworkInterfacesClientListResponse

PageResponse returns the current LoadBalancerNetworkInterfacesClientListResponse page.

type LoadBalancerNetworkInterfacesClientListResponse added in v0.3.0 

type LoadBalancerNetworkInterfacesClientListResponse struct {
	LoadBalancerNetworkInterfacesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerNetworkInterfacesClientListResponse contains the response from method LoadBalancerNetworkInterfacesClient.List.

type LoadBalancerNetworkInterfacesClientListResult added in v0.3.0 

type LoadBalancerNetworkInterfacesClientListResult struct {
	InterfaceListResult
}

LoadBalancerNetworkInterfacesClientListResult contains the result from method LoadBalancerNetworkInterfacesClient.List.

type LoadBalancerOutboundRuleListResult 

type LoadBalancerOutboundRuleListResult struct {
	// A list of outbound rules in a load balancer.
	Value []*OutboundRule `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

LoadBalancerOutboundRuleListResult - Response for ListOutboundRule API service call.

func (LoadBalancerOutboundRuleListResult) MarshalJSON 

func (l LoadBalancerOutboundRuleListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerOutboundRuleListResult.

type LoadBalancerOutboundRuleProtocol 

type LoadBalancerOutboundRuleProtocol string

LoadBalancerOutboundRuleProtocol - The protocol for the outbound rule in load balancer. 

const (
	LoadBalancerOutboundRuleProtocolAll LoadBalancerOutboundRuleProtocol = "All"
	LoadBalancerOutboundRuleProtocolTCP LoadBalancerOutboundRuleProtocol = "Tcp"
	LoadBalancerOutboundRuleProtocolUDP LoadBalancerOutboundRuleProtocol = "Udp"
)

func PossibleLoadBalancerOutboundRuleProtocolValues 

func PossibleLoadBalancerOutboundRuleProtocolValues() []LoadBalancerOutboundRuleProtocol

PossibleLoadBalancerOutboundRuleProtocolValues returns the possible values for the LoadBalancerOutboundRuleProtocol const type.

func (LoadBalancerOutboundRuleProtocol) ToPtr 

func (c LoadBalancerOutboundRuleProtocol) ToPtr() *LoadBalancerOutboundRuleProtocol

ToPtr returns a *LoadBalancerOutboundRuleProtocol pointing to the current value.

type LoadBalancerOutboundRulesClient 

type LoadBalancerOutboundRulesClient struct {
	// contains filtered or unexported fields
}

LoadBalancerOutboundRulesClient contains the methods for the LoadBalancerOutboundRules group. Don't use this type directly, use NewLoadBalancerOutboundRulesClient() instead.

func NewLoadBalancerOutboundRulesClient 

func NewLoadBalancerOutboundRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LoadBalancerOutboundRulesClient

NewLoadBalancerOutboundRulesClient creates a new instance of LoadBalancerOutboundRulesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LoadBalancerOutboundRulesClient) Get 

func (client *LoadBalancerOutboundRulesClient) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, outboundRuleName string, options *LoadBalancerOutboundRulesClientGetOptions) (LoadBalancerOutboundRulesClientGetResponse, error)

Get - Gets the specified load balancer outbound rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. outboundRuleName - The name of the outbound rule. options - LoadBalancerOutboundRulesClientGetOptions contains the optional parameters for the LoadBalancerOutboundRulesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerOutboundRuleGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerOutboundRulesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		"<outbound-rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LoadBalancerOutboundRulesClientGetResult)
}

Output:

func (*LoadBalancerOutboundRulesClient) List 

func (client *LoadBalancerOutboundRulesClient) List(resourceGroupName string, loadBalancerName string, options *LoadBalancerOutboundRulesClientListOptions) *LoadBalancerOutboundRulesClientListPager

List - Gets all the outbound rules in a load balancer. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. options - LoadBalancerOutboundRulesClientListOptions contains the optional parameters for the LoadBalancerOutboundRulesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerOutboundRuleList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerOutboundRulesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<load-balancer-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type LoadBalancerOutboundRulesClientGetOptions added in v0.3.0 

type LoadBalancerOutboundRulesClientGetOptions struct {
}

LoadBalancerOutboundRulesClientGetOptions contains the optional parameters for the LoadBalancerOutboundRulesClient.Get method.

type LoadBalancerOutboundRulesClientGetResponse added in v0.3.0 

type LoadBalancerOutboundRulesClientGetResponse struct {
	LoadBalancerOutboundRulesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerOutboundRulesClientGetResponse contains the response from method LoadBalancerOutboundRulesClient.Get.

type LoadBalancerOutboundRulesClientGetResult added in v0.3.0 

type LoadBalancerOutboundRulesClientGetResult struct {
	OutboundRule
}

LoadBalancerOutboundRulesClientGetResult contains the result from method LoadBalancerOutboundRulesClient.Get.

type LoadBalancerOutboundRulesClientListOptions added in v0.3.0 

type LoadBalancerOutboundRulesClientListOptions struct {
}

LoadBalancerOutboundRulesClientListOptions contains the optional parameters for the LoadBalancerOutboundRulesClient.List method.

type LoadBalancerOutboundRulesClientListPager added in v0.3.0 

type LoadBalancerOutboundRulesClientListPager struct {
	// contains filtered or unexported fields
}

LoadBalancerOutboundRulesClientListPager provides operations for iterating over paged responses.

func (*LoadBalancerOutboundRulesClientListPager) Err added in v0.3.0 

func (p *LoadBalancerOutboundRulesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*LoadBalancerOutboundRulesClientListPager) NextPage added in v0.3.0 

func (p *LoadBalancerOutboundRulesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LoadBalancerOutboundRulesClientListPager) PageResponse added in v0.3.0 

func (p *LoadBalancerOutboundRulesClientListPager) PageResponse() LoadBalancerOutboundRulesClientListResponse

PageResponse returns the current LoadBalancerOutboundRulesClientListResponse page.

type LoadBalancerOutboundRulesClientListResponse added in v0.3.0 

type LoadBalancerOutboundRulesClientListResponse struct {
	LoadBalancerOutboundRulesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerOutboundRulesClientListResponse contains the response from method LoadBalancerOutboundRulesClient.List.

type LoadBalancerOutboundRulesClientListResult added in v0.3.0 

type LoadBalancerOutboundRulesClientListResult struct {
	LoadBalancerOutboundRuleListResult
}

LoadBalancerOutboundRulesClientListResult contains the result from method LoadBalancerOutboundRulesClient.List.

type LoadBalancerProbeListResult 

type LoadBalancerProbeListResult struct {
	// A list of probes in a load balancer.
	Value []*Probe `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

LoadBalancerProbeListResult - Response for ListProbe API service call.

func (LoadBalancerProbeListResult) MarshalJSON 

func (l LoadBalancerProbeListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerProbeListResult.

type LoadBalancerProbesClient 

type LoadBalancerProbesClient struct {
	// contains filtered or unexported fields
}

LoadBalancerProbesClient contains the methods for the LoadBalancerProbes group. Don't use this type directly, use NewLoadBalancerProbesClient() instead.

func NewLoadBalancerProbesClient 

func NewLoadBalancerProbesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LoadBalancerProbesClient

NewLoadBalancerProbesClient creates a new instance of LoadBalancerProbesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LoadBalancerProbesClient) Get 

func (client *LoadBalancerProbesClient) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, probeName string, options *LoadBalancerProbesClientGetOptions) (LoadBalancerProbesClientGetResponse, error)

Get - Gets load balancer probe. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. probeName - The name of the probe. options - LoadBalancerProbesClientGetOptions contains the optional parameters for the LoadBalancerProbesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerProbeGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerProbesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		"<probe-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LoadBalancerProbesClientGetResult)
}

Output:

func (*LoadBalancerProbesClient) List 

func (client *LoadBalancerProbesClient) List(resourceGroupName string, loadBalancerName string, options *LoadBalancerProbesClientListOptions) *LoadBalancerProbesClientListPager

List - Gets all the load balancer probes. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. options - LoadBalancerProbesClientListOptions contains the optional parameters for the LoadBalancerProbesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerProbeList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancerProbesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<load-balancer-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type LoadBalancerProbesClientGetOptions added in v0.3.0 

type LoadBalancerProbesClientGetOptions struct {
}

LoadBalancerProbesClientGetOptions contains the optional parameters for the LoadBalancerProbesClient.Get method.

type LoadBalancerProbesClientGetResponse added in v0.3.0 

type LoadBalancerProbesClientGetResponse struct {
	LoadBalancerProbesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerProbesClientGetResponse contains the response from method LoadBalancerProbesClient.Get.

type LoadBalancerProbesClientGetResult added in v0.3.0 

type LoadBalancerProbesClientGetResult struct {
	Probe
}

LoadBalancerProbesClientGetResult contains the result from method LoadBalancerProbesClient.Get.

type LoadBalancerProbesClientListOptions added in v0.3.0 

type LoadBalancerProbesClientListOptions struct {
}

LoadBalancerProbesClientListOptions contains the optional parameters for the LoadBalancerProbesClient.List method.

type LoadBalancerProbesClientListPager added in v0.3.0 

type LoadBalancerProbesClientListPager struct {
	// contains filtered or unexported fields
}

LoadBalancerProbesClientListPager provides operations for iterating over paged responses.

func (*LoadBalancerProbesClientListPager) Err added in v0.3.0 

func (p *LoadBalancerProbesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*LoadBalancerProbesClientListPager) NextPage added in v0.3.0 

func (p *LoadBalancerProbesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LoadBalancerProbesClientListPager) PageResponse added in v0.3.0 

func (p *LoadBalancerProbesClientListPager) PageResponse() LoadBalancerProbesClientListResponse

PageResponse returns the current LoadBalancerProbesClientListResponse page.

type LoadBalancerProbesClientListResponse added in v0.3.0 

type LoadBalancerProbesClientListResponse struct {
	LoadBalancerProbesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancerProbesClientListResponse contains the response from method LoadBalancerProbesClient.List.

type LoadBalancerProbesClientListResult added in v0.3.0 

type LoadBalancerProbesClientListResult struct {
	LoadBalancerProbeListResult
}

LoadBalancerProbesClientListResult contains the result from method LoadBalancerProbesClient.List.

type LoadBalancerPropertiesFormat 

type LoadBalancerPropertiesFormat struct {
	// Collection of backend address pools used by a load balancer.
	BackendAddressPools []*BackendAddressPool `json:"backendAddressPools,omitempty"`

	// Object representing the frontend IPs to be used for the load balancer.
	FrontendIPConfigurations []*FrontendIPConfiguration `json:"frontendIPConfigurations,omitempty"`

	// 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"`

	// 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"`

	// Object collection representing the load balancing rules Gets the provisioning.
	LoadBalancingRules []*LoadBalancingRule `json:"loadBalancingRules,omitempty"`

	// The outbound rules.
	OutboundRules []*OutboundRule `json:"outboundRules,omitempty"`

	// Collection of probe objects used in the load balancer.
	Probes []*Probe `json:"probes,omitempty"`

	// READ-ONLY; The provisioning state of the load balancer resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the load balancer resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

LoadBalancerPropertiesFormat - Properties of the load balancer.

func (LoadBalancerPropertiesFormat) MarshalJSON 

func (l LoadBalancerPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerPropertiesFormat.

type LoadBalancerSKU 

type LoadBalancerSKU struct {
	// Name of a load balancer SKU.
	Name *LoadBalancerSKUName `json:"name,omitempty"`

	// Tier of a load balancer SKU.
	Tier *LoadBalancerSKUTier `json:"tier,omitempty"`
}

LoadBalancerSKU - SKU of a load balancer.

type LoadBalancerSKUName 

type LoadBalancerSKUName string

LoadBalancerSKUName - Name of a load balancer SKU. 

const (
	LoadBalancerSKUNameBasic    LoadBalancerSKUName = "Basic"
	LoadBalancerSKUNameGateway  LoadBalancerSKUName = "Gateway"
	LoadBalancerSKUNameStandard LoadBalancerSKUName = "Standard"
)

func PossibleLoadBalancerSKUNameValues 

func PossibleLoadBalancerSKUNameValues() []LoadBalancerSKUName

PossibleLoadBalancerSKUNameValues returns the possible values for the LoadBalancerSKUName const type.

func (LoadBalancerSKUName) ToPtr 

func (c LoadBalancerSKUName) ToPtr() *LoadBalancerSKUName

ToPtr returns a *LoadBalancerSKUName pointing to the current value.

type LoadBalancerSKUTier 

type LoadBalancerSKUTier string

LoadBalancerSKUTier - Tier of a load balancer SKU. 

const (
	LoadBalancerSKUTierGlobal   LoadBalancerSKUTier = "Global"
	LoadBalancerSKUTierRegional LoadBalancerSKUTier = "Regional"
)

func PossibleLoadBalancerSKUTierValues 

func PossibleLoadBalancerSKUTierValues() []LoadBalancerSKUTier

PossibleLoadBalancerSKUTierValues returns the possible values for the LoadBalancerSKUTier const type.

func (LoadBalancerSKUTier) ToPtr 

func (c LoadBalancerSKUTier) ToPtr() *LoadBalancerSKUTier

ToPtr returns a *LoadBalancerSKUTier pointing to the current value.

type LoadBalancerVipSwapRequest 

type LoadBalancerVipSwapRequest struct {
	// A list of frontend IP configuration resources that should swap VIPs.
	FrontendIPConfigurations []*LoadBalancerVipSwapRequestFrontendIPConfiguration `json:"frontendIPConfigurations,omitempty"`
}

LoadBalancerVipSwapRequest - The request for a VIP swap.

func (LoadBalancerVipSwapRequest) MarshalJSON 

func (l LoadBalancerVipSwapRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerVipSwapRequest.

type LoadBalancerVipSwapRequestFrontendIPConfiguration 

type LoadBalancerVipSwapRequestFrontendIPConfiguration struct {
	// The ID of frontend IP configuration resource.
	ID *string `json:"id,omitempty"`

	// The properties of VIP swap request's frontend IP configuration object.
	Properties *LoadBalancerVipSwapRequestFrontendIPConfigurationProperties `json:"properties,omitempty"`
}

LoadBalancerVipSwapRequestFrontendIPConfiguration - VIP swap request's frontend IP configuration object.

type LoadBalancerVipSwapRequestFrontendIPConfigurationProperties 

type LoadBalancerVipSwapRequestFrontendIPConfigurationProperties struct {
	// A reference to public IP address resource.
	PublicIPAddress *SubResource `json:"publicIPAddress,omitempty"`
}

LoadBalancerVipSwapRequestFrontendIPConfigurationProperties - The properties of VIP swap request's frontend IP configuration object.

type LoadBalancersClient 

type LoadBalancersClient struct {
	// contains filtered or unexported fields
}

LoadBalancersClient contains the methods for the LoadBalancers group. Don't use this type directly, use NewLoadBalancersClient() instead.

func NewLoadBalancersClient 

func NewLoadBalancersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LoadBalancersClient

NewLoadBalancersClient creates a new instance of LoadBalancersClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LoadBalancersClient) BeginCreateOrUpdate 

func (client *LoadBalancersClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, loadBalancerName string, parameters LoadBalancer, options *LoadBalancersClientBeginCreateOrUpdateOptions) (LoadBalancersClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a load balancer. If the operation fails it returns an *azcore.ResponseError type. 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. options - LoadBalancersClientBeginCreateOrUpdateOptions contains the optional parameters for the LoadBalancersClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		armnetwork.LoadBalancer{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.LoadBalancerPropertiesFormat{
				BackendAddressPools: []*armnetwork.BackendAddressPool{
					{
						Name:       to.StringPtr("<name>"),
						Properties: &armnetwork.BackendAddressPoolPropertiesFormat{},
					}},
				FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
							Subnet: &armnetwork.Subnet{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
				InboundNatPools: []*armnetwork.InboundNatPool{},
				InboundNatRules: []*armnetwork.InboundNatRule{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.InboundNatRulePropertiesFormat{
							BackendPort:      to.Int32Ptr(3389),
							EnableFloatingIP: to.BoolPtr(true),
							EnableTCPReset:   to.BoolPtr(false),
							FrontendIPConfiguration: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							FrontendPort:         to.Int32Ptr(3389),
							IdleTimeoutInMinutes: to.Int32Ptr(15),
							Protocol:             armnetwork.TransportProtocol("Tcp").ToPtr(),
						},
					}},
				LoadBalancingRules: []*armnetwork.LoadBalancingRule{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.LoadBalancingRulePropertiesFormat{
							BackendAddressPool: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							BackendPort:      to.Int32Ptr(80),
							EnableFloatingIP: to.BoolPtr(true),
							EnableTCPReset:   to.BoolPtr(false),
							FrontendIPConfiguration: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							FrontendPort:         to.Int32Ptr(80),
							IdleTimeoutInMinutes: to.Int32Ptr(15),
							LoadDistribution:     armnetwork.LoadDistribution("Default").ToPtr(),
							Probe: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							Protocol: armnetwork.TransportProtocol("Tcp").ToPtr(),
						},
					}},
				Probes: []*armnetwork.Probe{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ProbePropertiesFormat{
							IntervalInSeconds: to.Int32Ptr(15),
							NumberOfProbes:    to.Int32Ptr(2),
							Port:              to.Int32Ptr(80),
							RequestPath:       to.StringPtr("<request-path>"),
							Protocol:          armnetwork.ProbeProtocol("Http").ToPtr(),
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LoadBalancersClientCreateOrUpdateResult)
}

Output:

func (*LoadBalancersClient) BeginDelete 

func (client *LoadBalancersClient) BeginDelete(ctx context.Context, resourceGroupName string, loadBalancerName string, options *LoadBalancersClientBeginDeleteOptions) (LoadBalancersClientDeletePollerResponse, error)

BeginDelete - Deletes the specified load balancer. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. options - LoadBalancersClientBeginDeleteOptions contains the optional parameters for the LoadBalancersClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*LoadBalancersClient) BeginListInboundNatRulePortMappings added in v0.2.0 

func (client *LoadBalancersClient) BeginListInboundNatRulePortMappings(ctx context.Context, groupName string, loadBalancerName string, backendPoolName string, parameters QueryInboundNatRulePortMappingRequest, options *LoadBalancersClientBeginListInboundNatRulePortMappingsOptions) (LoadBalancersClientListInboundNatRulePortMappingsPollerResponse, error)

BeginListInboundNatRulePortMappings - List of inbound NAT rule port mappings. If the operation fails it returns an *azcore.ResponseError type. groupName - The name of the resource group. loadBalancerName - The name of the load balancer. backendPoolName - The name of the load balancer backend address pool. parameters - Query inbound NAT rule port mapping request. options - LoadBalancersClientBeginListInboundNatRulePortMappingsOptions contains the optional parameters for the LoadBalancersClient.BeginListInboundNatRulePortMappings method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/QueryInboundNatRulePortMapping.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListInboundNatRulePortMappings(ctx,
		"<group-name>",
		"<load-balancer-name>",
		"<backend-pool-name>",
		armnetwork.QueryInboundNatRulePortMappingRequest{
			IPAddress: to.StringPtr("<ipaddress>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LoadBalancersClientListInboundNatRulePortMappingsResult)
}

Output:

func (*LoadBalancersClient) BeginSwapPublicIPAddresses 

func (client *LoadBalancersClient) BeginSwapPublicIPAddresses(ctx context.Context, location string, parameters LoadBalancerVipSwapRequest, options *LoadBalancersClientBeginSwapPublicIPAddressesOptions) (LoadBalancersClientSwapPublicIPAddressesPollerResponse, error)

BeginSwapPublicIPAddresses - Swaps VIPs between two load balancers. If the operation fails it returns an *azcore.ResponseError type. location - The region where load balancers are located at. parameters - Parameters that define which VIPs should be swapped. options - LoadBalancersClientBeginSwapPublicIPAddressesOptions contains the optional parameters for the LoadBalancersClient.BeginSwapPublicIPAddresses method.

func (*LoadBalancersClient) Get 

func (client *LoadBalancersClient) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, options *LoadBalancersClientGetOptions) (LoadBalancersClientGetResponse, error)

Get - Gets the specified load balancer. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. options - LoadBalancersClientGetOptions contains the optional parameters for the LoadBalancersClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancersClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		&armnetwork.LoadBalancersClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LoadBalancersClientGetResult)
}

Output:

func (*LoadBalancersClient) List 

func (client *LoadBalancersClient) List(resourceGroupName string, options *LoadBalancersClientListOptions) *LoadBalancersClientListPager

List - Gets all the load balancers in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - LoadBalancersClientListOptions contains the optional parameters for the LoadBalancersClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancersClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*LoadBalancersClient) ListAll 

func (client *LoadBalancersClient) ListAll(options *LoadBalancersClientListAllOptions) *LoadBalancersClientListAllPager

ListAll - Gets all the load balancers in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - LoadBalancersClientListAllOptions contains the optional parameters for the LoadBalancersClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancersClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*LoadBalancersClient) UpdateTags 

func (client *LoadBalancersClient) UpdateTags(ctx context.Context, resourceGroupName string, loadBalancerName string, parameters TagsObject, options *LoadBalancersClientUpdateTagsOptions) (LoadBalancersClientUpdateTagsResponse, error)

UpdateTags - Updates a load balancer tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. loadBalancerName - The name of the load balancer. parameters - Parameters supplied to update load balancer tags. options - LoadBalancersClientUpdateTagsOptions contains the optional parameters for the LoadBalancersClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LoadBalancerUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLoadBalancersClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<load-balancer-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LoadBalancersClientUpdateTagsResult)
}

Output:

type LoadBalancersClientBeginCreateOrUpdateOptions added in v0.3.0 

type LoadBalancersClientBeginCreateOrUpdateOptions struct {
}

LoadBalancersClientBeginCreateOrUpdateOptions contains the optional parameters for the LoadBalancersClient.BeginCreateOrUpdate method.

type LoadBalancersClientBeginDeleteOptions added in v0.3.0 

type LoadBalancersClientBeginDeleteOptions struct {
}

LoadBalancersClientBeginDeleteOptions contains the optional parameters for the LoadBalancersClient.BeginDelete method.

type LoadBalancersClientBeginListInboundNatRulePortMappingsOptions added in v0.3.0 

type LoadBalancersClientBeginListInboundNatRulePortMappingsOptions struct {
}

LoadBalancersClientBeginListInboundNatRulePortMappingsOptions contains the optional parameters for the LoadBalancersClient.BeginListInboundNatRulePortMappings method.

type LoadBalancersClientBeginSwapPublicIPAddressesOptions added in v0.3.0 

type LoadBalancersClientBeginSwapPublicIPAddressesOptions struct {
}

LoadBalancersClientBeginSwapPublicIPAddressesOptions contains the optional parameters for the LoadBalancersClient.BeginSwapPublicIPAddresses method.

type LoadBalancersClientCreateOrUpdatePoller added in v0.3.0 

type LoadBalancersClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

LoadBalancersClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*LoadBalancersClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *LoadBalancersClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*LoadBalancersClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *LoadBalancersClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (LoadBalancersClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final LoadBalancersClientCreateOrUpdateResponse will be returned.

func (*LoadBalancersClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *LoadBalancersClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*LoadBalancersClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *LoadBalancersClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type LoadBalancersClientCreateOrUpdatePollerResponse added in v0.3.0 

type LoadBalancersClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *LoadBalancersClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientCreateOrUpdatePollerResponse contains the response from method LoadBalancersClient.CreateOrUpdate.

func (LoadBalancersClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l LoadBalancersClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (LoadBalancersClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*LoadBalancersClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *LoadBalancersClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *LoadBalancersClient, token string) error

Resume rehydrates a LoadBalancersClientCreateOrUpdatePollerResponse from the provided client and resume token.

type LoadBalancersClientCreateOrUpdateResponse added in v0.3.0 

type LoadBalancersClientCreateOrUpdateResponse struct {
	LoadBalancersClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientCreateOrUpdateResponse contains the response from method LoadBalancersClient.CreateOrUpdate.

type LoadBalancersClientCreateOrUpdateResult added in v0.3.0 

type LoadBalancersClientCreateOrUpdateResult struct {
	LoadBalancer
}

LoadBalancersClientCreateOrUpdateResult contains the result from method LoadBalancersClient.CreateOrUpdate.

type LoadBalancersClientDeletePoller added in v0.3.0 

type LoadBalancersClientDeletePoller struct {
	// contains filtered or unexported fields
}

LoadBalancersClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*LoadBalancersClientDeletePoller) Done added in v0.3.0 

func (p *LoadBalancersClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*LoadBalancersClientDeletePoller) FinalResponse added in v0.3.0 

func (p *LoadBalancersClientDeletePoller) FinalResponse(ctx context.Context) (LoadBalancersClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final LoadBalancersClientDeleteResponse will be returned.

func (*LoadBalancersClientDeletePoller) Poll added in v0.3.0 

func (p *LoadBalancersClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*LoadBalancersClientDeletePoller) ResumeToken added in v0.3.0 

func (p *LoadBalancersClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type LoadBalancersClientDeletePollerResponse added in v0.3.0 

type LoadBalancersClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *LoadBalancersClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientDeletePollerResponse contains the response from method LoadBalancersClient.Delete.

func (LoadBalancersClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l LoadBalancersClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (LoadBalancersClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*LoadBalancersClientDeletePollerResponse) Resume added in v0.3.0 

func (l *LoadBalancersClientDeletePollerResponse) Resume(ctx context.Context, client *LoadBalancersClient, token string) error

Resume rehydrates a LoadBalancersClientDeletePollerResponse from the provided client and resume token.

type LoadBalancersClientDeleteResponse added in v0.3.0 

type LoadBalancersClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientDeleteResponse contains the response from method LoadBalancersClient.Delete.

type LoadBalancersClientGetOptions added in v0.3.0 

type LoadBalancersClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

LoadBalancersClientGetOptions contains the optional parameters for the LoadBalancersClient.Get method.

type LoadBalancersClientGetResponse added in v0.3.0 

type LoadBalancersClientGetResponse struct {
	LoadBalancersClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientGetResponse contains the response from method LoadBalancersClient.Get.

type LoadBalancersClientGetResult added in v0.3.0 

type LoadBalancersClientGetResult struct {
	LoadBalancer
}

LoadBalancersClientGetResult contains the result from method LoadBalancersClient.Get.

type LoadBalancersClientListAllOptions added in v0.3.0 

type LoadBalancersClientListAllOptions struct {
}

LoadBalancersClientListAllOptions contains the optional parameters for the LoadBalancersClient.ListAll method.

type LoadBalancersClientListAllPager added in v0.3.0 

type LoadBalancersClientListAllPager struct {
	// contains filtered or unexported fields
}

LoadBalancersClientListAllPager provides operations for iterating over paged responses.

func (*LoadBalancersClientListAllPager) Err added in v0.3.0 

func (p *LoadBalancersClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*LoadBalancersClientListAllPager) NextPage added in v0.3.0 

func (p *LoadBalancersClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LoadBalancersClientListAllPager) PageResponse added in v0.3.0 

func (p *LoadBalancersClientListAllPager) PageResponse() LoadBalancersClientListAllResponse

PageResponse returns the current LoadBalancersClientListAllResponse page.

type LoadBalancersClientListAllResponse added in v0.3.0 

type LoadBalancersClientListAllResponse struct {
	LoadBalancersClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientListAllResponse contains the response from method LoadBalancersClient.ListAll.

type LoadBalancersClientListAllResult added in v0.3.0 

type LoadBalancersClientListAllResult struct {
	LoadBalancerListResult
}

LoadBalancersClientListAllResult contains the result from method LoadBalancersClient.ListAll.

type LoadBalancersClientListInboundNatRulePortMappingsPoller added in v0.3.0 

type LoadBalancersClientListInboundNatRulePortMappingsPoller struct {
	// contains filtered or unexported fields
}

LoadBalancersClientListInboundNatRulePortMappingsPoller provides polling facilities until the operation reaches a terminal state.

func (*LoadBalancersClientListInboundNatRulePortMappingsPoller) Done added in v0.3.0 

func (p *LoadBalancersClientListInboundNatRulePortMappingsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*LoadBalancersClientListInboundNatRulePortMappingsPoller) FinalResponse added in v0.3.0 

func (p *LoadBalancersClientListInboundNatRulePortMappingsPoller) FinalResponse(ctx context.Context) (LoadBalancersClientListInboundNatRulePortMappingsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final LoadBalancersClientListInboundNatRulePortMappingsResponse will be returned.

func (*LoadBalancersClientListInboundNatRulePortMappingsPoller) Poll added in v0.3.0 

func (p *LoadBalancersClientListInboundNatRulePortMappingsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*LoadBalancersClientListInboundNatRulePortMappingsPoller) ResumeToken added in v0.3.0 

func (p *LoadBalancersClientListInboundNatRulePortMappingsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type LoadBalancersClientListInboundNatRulePortMappingsPollerResponse added in v0.3.0 

type LoadBalancersClientListInboundNatRulePortMappingsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *LoadBalancersClientListInboundNatRulePortMappingsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientListInboundNatRulePortMappingsPollerResponse contains the response from method LoadBalancersClient.ListInboundNatRulePortMappings.

func (LoadBalancersClientListInboundNatRulePortMappingsPollerResponse) PollUntilDone added in v0.3.0 

func (l LoadBalancersClientListInboundNatRulePortMappingsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (LoadBalancersClientListInboundNatRulePortMappingsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*LoadBalancersClientListInboundNatRulePortMappingsPollerResponse) Resume added in v0.3.0 

func (l *LoadBalancersClientListInboundNatRulePortMappingsPollerResponse) Resume(ctx context.Context, client *LoadBalancersClient, token string) error

Resume rehydrates a LoadBalancersClientListInboundNatRulePortMappingsPollerResponse from the provided client and resume token.

type LoadBalancersClientListInboundNatRulePortMappingsResponse added in v0.3.0 

type LoadBalancersClientListInboundNatRulePortMappingsResponse struct {
	LoadBalancersClientListInboundNatRulePortMappingsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientListInboundNatRulePortMappingsResponse contains the response from method LoadBalancersClient.ListInboundNatRulePortMappings.

type LoadBalancersClientListInboundNatRulePortMappingsResult added in v0.3.0 

type LoadBalancersClientListInboundNatRulePortMappingsResult struct {
	BackendAddressInboundNatRulePortMappings
}

LoadBalancersClientListInboundNatRulePortMappingsResult contains the result from method LoadBalancersClient.ListInboundNatRulePortMappings.

type LoadBalancersClientListOptions added in v0.3.0 

type LoadBalancersClientListOptions struct {
}

LoadBalancersClientListOptions contains the optional parameters for the LoadBalancersClient.List method.

type LoadBalancersClientListPager added in v0.3.0 

type LoadBalancersClientListPager struct {
	// contains filtered or unexported fields
}

LoadBalancersClientListPager provides operations for iterating over paged responses.

func (*LoadBalancersClientListPager) Err added in v0.3.0 

func (p *LoadBalancersClientListPager) Err() error

Err returns the last error encountered while paging.

func (*LoadBalancersClientListPager) NextPage added in v0.3.0 

func (p *LoadBalancersClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LoadBalancersClientListPager) PageResponse added in v0.3.0 

func (p *LoadBalancersClientListPager) PageResponse() LoadBalancersClientListResponse

PageResponse returns the current LoadBalancersClientListResponse page.

type LoadBalancersClientListResponse added in v0.3.0 

type LoadBalancersClientListResponse struct {
	LoadBalancersClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientListResponse contains the response from method LoadBalancersClient.List.

type LoadBalancersClientListResult added in v0.3.0 

type LoadBalancersClientListResult struct {
	LoadBalancerListResult
}

LoadBalancersClientListResult contains the result from method LoadBalancersClient.List.

type LoadBalancersClientSwapPublicIPAddressesPoller added in v0.3.0 

type LoadBalancersClientSwapPublicIPAddressesPoller struct {
	// contains filtered or unexported fields
}

LoadBalancersClientSwapPublicIPAddressesPoller provides polling facilities until the operation reaches a terminal state.

func (*LoadBalancersClientSwapPublicIPAddressesPoller) Done added in v0.3.0 

func (p *LoadBalancersClientSwapPublicIPAddressesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*LoadBalancersClientSwapPublicIPAddressesPoller) FinalResponse added in v0.3.0 

func (p *LoadBalancersClientSwapPublicIPAddressesPoller) FinalResponse(ctx context.Context) (LoadBalancersClientSwapPublicIPAddressesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final LoadBalancersClientSwapPublicIPAddressesResponse will be returned.

func (*LoadBalancersClientSwapPublicIPAddressesPoller) Poll added in v0.3.0 

func (p *LoadBalancersClientSwapPublicIPAddressesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*LoadBalancersClientSwapPublicIPAddressesPoller) ResumeToken added in v0.3.0 

func (p *LoadBalancersClientSwapPublicIPAddressesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type LoadBalancersClientSwapPublicIPAddressesPollerResponse added in v0.3.0 

type LoadBalancersClientSwapPublicIPAddressesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *LoadBalancersClientSwapPublicIPAddressesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientSwapPublicIPAddressesPollerResponse contains the response from method LoadBalancersClient.SwapPublicIPAddresses.

func (LoadBalancersClientSwapPublicIPAddressesPollerResponse) PollUntilDone added in v0.3.0 

func (l LoadBalancersClientSwapPublicIPAddressesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (LoadBalancersClientSwapPublicIPAddressesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*LoadBalancersClientSwapPublicIPAddressesPollerResponse) Resume added in v0.3.0 

func (l *LoadBalancersClientSwapPublicIPAddressesPollerResponse) Resume(ctx context.Context, client *LoadBalancersClient, token string) error

Resume rehydrates a LoadBalancersClientSwapPublicIPAddressesPollerResponse from the provided client and resume token.

type LoadBalancersClientSwapPublicIPAddressesResponse added in v0.3.0 

type LoadBalancersClientSwapPublicIPAddressesResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientSwapPublicIPAddressesResponse contains the response from method LoadBalancersClient.SwapPublicIPAddresses.

type LoadBalancersClientUpdateTagsOptions added in v0.3.0 

type LoadBalancersClientUpdateTagsOptions struct {
}

LoadBalancersClientUpdateTagsOptions contains the optional parameters for the LoadBalancersClient.UpdateTags method.

type LoadBalancersClientUpdateTagsResponse added in v0.3.0 

type LoadBalancersClientUpdateTagsResponse struct {
	LoadBalancersClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LoadBalancersClientUpdateTagsResponse contains the response from method LoadBalancersClient.UpdateTags.

type LoadBalancersClientUpdateTagsResult added in v0.3.0 

type LoadBalancersClientUpdateTagsResult struct {
	LoadBalancer
}

LoadBalancersClientUpdateTagsResult contains the result from method LoadBalancersClient.UpdateTags.

type LoadBalancingRule 

type LoadBalancingRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can
	// be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of load balancer load balancing rule.
	Properties *LoadBalancingRulePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

LoadBalancingRule - A load balancing rule for a load balancer.

type LoadBalancingRulePropertiesFormat 

type LoadBalancingRulePropertiesFormat struct {
	// REQUIRED; The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable
	// values are between 0 and 65534. Note that value 0 enables "Any Port".
	FrontendPort *int32 `json:"frontendPort,omitempty"`

	// REQUIRED; The reference to the transport protocol used by the load balancing rule.
	Protocol *TransportProtocol `json:"protocol,omitempty"`

	// A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.
	BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`

	// An array of references to pool of DIPs.
	BackendAddressPools []*SubResource `json:"backendAddressPools,omitempty"`

	// The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables
	// "Any Port".
	BackendPort *int32 `json:"backendPort,omitempty"`

	// Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing
	// rule.
	DisableOutboundSnat *bool `json:"disableOutboundSnat,omitempty"`

	// 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"`

	// Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used
	// when the protocol is set to TCP.
	EnableTCPReset *bool `json:"enableTcpReset,omitempty"`

	// A reference to frontend IP addresses.
	FrontendIPConfiguration *SubResource `json:"frontendIPConfiguration,omitempty"`

	// 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"`

	// The load distribution policy for this rule.
	LoadDistribution *LoadDistribution `json:"loadDistribution,omitempty"`

	// The reference to the load balancer probe used by the load balancing rule.
	Probe *SubResource `json:"probe,omitempty"`

	// READ-ONLY; The provisioning state of the load balancing rule resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

LoadBalancingRulePropertiesFormat - Properties of the load balancer.

func (LoadBalancingRulePropertiesFormat) MarshalJSON 

func (l LoadBalancingRulePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancingRulePropertiesFormat.

type LoadDistribution 

type LoadDistribution string

LoadDistribution - The load distribution policy for this rule. 

const (
	LoadDistributionDefault          LoadDistribution = "Default"
	LoadDistributionSourceIP         LoadDistribution = "SourceIP"
	LoadDistributionSourceIPProtocol LoadDistribution = "SourceIPProtocol"
)

func PossibleLoadDistributionValues 

func PossibleLoadDistributionValues() []LoadDistribution

PossibleLoadDistributionValues returns the possible values for the LoadDistribution const type.

func (LoadDistribution) ToPtr 

func (c LoadDistribution) ToPtr() *LoadDistribution

ToPtr returns a *LoadDistribution pointing to the current value.

type LocalNetworkGateway 

type LocalNetworkGateway struct {
	// REQUIRED; Properties of the local network gateway.
	Properties *LocalNetworkGatewayPropertiesFormat `json:"properties,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

LocalNetworkGateway - A common class for general resource information.

func (LocalNetworkGateway) MarshalJSON 

func (l LocalNetworkGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocalNetworkGateway.

type LocalNetworkGatewayListResult 

type LocalNetworkGatewayListResult struct {
	// A list of local network gateways that exists in a resource group.
	Value []*LocalNetworkGateway `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

LocalNetworkGatewayListResult - Response for ListLocalNetworkGateways API service call.

func (LocalNetworkGatewayListResult) MarshalJSON 

func (l LocalNetworkGatewayListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocalNetworkGatewayListResult.

type LocalNetworkGatewayPropertiesFormat 

type LocalNetworkGatewayPropertiesFormat struct {
	// Local network gateway's BGP speaker settings.
	BgpSettings *BgpSettings `json:"bgpSettings,omitempty"`

	// FQDN of local network gateway.
	Fqdn *string `json:"fqdn,omitempty"`

	// IP address of local network gateway.
	GatewayIPAddress *string `json:"gatewayIpAddress,omitempty"`

	// Local network site address space.
	LocalNetworkAddressSpace *AddressSpace `json:"localNetworkAddressSpace,omitempty"`

	// READ-ONLY; The provisioning state of the local network gateway resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the local network gateway resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

LocalNetworkGatewayPropertiesFormat - LocalNetworkGateway properties.

type LocalNetworkGatewaysClient 

type LocalNetworkGatewaysClient struct {
	// contains filtered or unexported fields
}

LocalNetworkGatewaysClient contains the methods for the LocalNetworkGateways group. Don't use this type directly, use NewLocalNetworkGatewaysClient() instead.

func NewLocalNetworkGatewaysClient 

func NewLocalNetworkGatewaysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LocalNetworkGatewaysClient

NewLocalNetworkGatewaysClient creates a new instance of LocalNetworkGatewaysClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LocalNetworkGatewaysClient) BeginCreateOrUpdate 

func (client *LocalNetworkGatewaysClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, localNetworkGatewayName string, parameters LocalNetworkGateway, options *LocalNetworkGatewaysClientBeginCreateOrUpdateOptions) (LocalNetworkGatewaysClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a local network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. 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. options - LocalNetworkGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the LocalNetworkGatewaysClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LocalNetworkGatewayCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLocalNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<local-network-gateway-name>",
		armnetwork.LocalNetworkGateway{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.LocalNetworkGatewayPropertiesFormat{
				Fqdn:             to.StringPtr("<fqdn>"),
				GatewayIPAddress: to.StringPtr("<gateway-ipaddress>"),
				LocalNetworkAddressSpace: &armnetwork.AddressSpace{
					AddressPrefixes: []*string{
						to.StringPtr("10.1.0.0/16")},
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LocalNetworkGatewaysClientCreateOrUpdateResult)
}

Output:

func (*LocalNetworkGatewaysClient) BeginDelete 

func (client *LocalNetworkGatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, localNetworkGatewayName string, options *LocalNetworkGatewaysClientBeginDeleteOptions) (LocalNetworkGatewaysClientDeletePollerResponse, error)

BeginDelete - Deletes the specified local network gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. localNetworkGatewayName - The name of the local network gateway. options - LocalNetworkGatewaysClientBeginDeleteOptions contains the optional parameters for the LocalNetworkGatewaysClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LocalNetworkGatewayDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLocalNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<local-network-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*LocalNetworkGatewaysClient) Get 

func (client *LocalNetworkGatewaysClient) Get(ctx context.Context, resourceGroupName string, localNetworkGatewayName string, options *LocalNetworkGatewaysClientGetOptions) (LocalNetworkGatewaysClientGetResponse, error)

Get - Gets the specified local network gateway in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. localNetworkGatewayName - The name of the local network gateway. options - LocalNetworkGatewaysClientGetOptions contains the optional parameters for the LocalNetworkGatewaysClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LocalNetworkGatewayGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLocalNetworkGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<local-network-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LocalNetworkGatewaysClientGetResult)
}

Output:

func (*LocalNetworkGatewaysClient) List 

func (client *LocalNetworkGatewaysClient) List(resourceGroupName string, options *LocalNetworkGatewaysClientListOptions) *LocalNetworkGatewaysClientListPager

List - Gets all the local network gateways in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - LocalNetworkGatewaysClientListOptions contains the optional parameters for the LocalNetworkGatewaysClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LocalNetworkGatewayList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLocalNetworkGatewaysClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*LocalNetworkGatewaysClient) UpdateTags 

func (client *LocalNetworkGatewaysClient) UpdateTags(ctx context.Context, resourceGroupName string, localNetworkGatewayName string, parameters TagsObject, options *LocalNetworkGatewaysClientUpdateTagsOptions) (LocalNetworkGatewaysClientUpdateTagsResponse, error)

UpdateTags - Updates a local network gateway tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. localNetworkGatewayName - The name of the local network gateway. parameters - Parameters supplied to update local network gateway tags. options - LocalNetworkGatewaysClientUpdateTagsOptions contains the optional parameters for the LocalNetworkGatewaysClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/LocalNetworkGatewayUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewLocalNetworkGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<local-network-gateway-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.LocalNetworkGatewaysClientUpdateTagsResult)
}

Output:

type LocalNetworkGatewaysClientBeginCreateOrUpdateOptions added in v0.3.0 

type LocalNetworkGatewaysClientBeginCreateOrUpdateOptions struct {
}

LocalNetworkGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the LocalNetworkGatewaysClient.BeginCreateOrUpdate method.

type LocalNetworkGatewaysClientBeginDeleteOptions added in v0.3.0 

type LocalNetworkGatewaysClientBeginDeleteOptions struct {
}

LocalNetworkGatewaysClientBeginDeleteOptions contains the optional parameters for the LocalNetworkGatewaysClient.BeginDelete method.

type LocalNetworkGatewaysClientCreateOrUpdatePoller added in v0.3.0 

type LocalNetworkGatewaysClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

LocalNetworkGatewaysClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*LocalNetworkGatewaysClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *LocalNetworkGatewaysClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*LocalNetworkGatewaysClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *LocalNetworkGatewaysClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (LocalNetworkGatewaysClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final LocalNetworkGatewaysClientCreateOrUpdateResponse will be returned.

func (*LocalNetworkGatewaysClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *LocalNetworkGatewaysClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*LocalNetworkGatewaysClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *LocalNetworkGatewaysClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type LocalNetworkGatewaysClientCreateOrUpdatePollerResponse added in v0.3.0 

type LocalNetworkGatewaysClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *LocalNetworkGatewaysClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LocalNetworkGatewaysClientCreateOrUpdatePollerResponse contains the response from method LocalNetworkGatewaysClient.CreateOrUpdate.

func (LocalNetworkGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l LocalNetworkGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (LocalNetworkGatewaysClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*LocalNetworkGatewaysClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *LocalNetworkGatewaysClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *LocalNetworkGatewaysClient, token string) error

Resume rehydrates a LocalNetworkGatewaysClientCreateOrUpdatePollerResponse from the provided client and resume token.

type LocalNetworkGatewaysClientCreateOrUpdateResponse added in v0.3.0 

type LocalNetworkGatewaysClientCreateOrUpdateResponse struct {
	LocalNetworkGatewaysClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LocalNetworkGatewaysClientCreateOrUpdateResponse contains the response from method LocalNetworkGatewaysClient.CreateOrUpdate.

type LocalNetworkGatewaysClientCreateOrUpdateResult added in v0.3.0 

type LocalNetworkGatewaysClientCreateOrUpdateResult struct {
	LocalNetworkGateway
}

LocalNetworkGatewaysClientCreateOrUpdateResult contains the result from method LocalNetworkGatewaysClient.CreateOrUpdate.

type LocalNetworkGatewaysClientDeletePoller added in v0.3.0 

type LocalNetworkGatewaysClientDeletePoller struct {
	// contains filtered or unexported fields
}

LocalNetworkGatewaysClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*LocalNetworkGatewaysClientDeletePoller) Done added in v0.3.0 

func (p *LocalNetworkGatewaysClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*LocalNetworkGatewaysClientDeletePoller) FinalResponse added in v0.3.0 

func (p *LocalNetworkGatewaysClientDeletePoller) FinalResponse(ctx context.Context) (LocalNetworkGatewaysClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final LocalNetworkGatewaysClientDeleteResponse will be returned.

func (*LocalNetworkGatewaysClientDeletePoller) Poll added in v0.3.0 

func (p *LocalNetworkGatewaysClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*LocalNetworkGatewaysClientDeletePoller) ResumeToken added in v0.3.0 

func (p *LocalNetworkGatewaysClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type LocalNetworkGatewaysClientDeletePollerResponse added in v0.3.0 

type LocalNetworkGatewaysClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *LocalNetworkGatewaysClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LocalNetworkGatewaysClientDeletePollerResponse contains the response from method LocalNetworkGatewaysClient.Delete.

func (LocalNetworkGatewaysClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l LocalNetworkGatewaysClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (LocalNetworkGatewaysClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*LocalNetworkGatewaysClientDeletePollerResponse) Resume added in v0.3.0 

func (l *LocalNetworkGatewaysClientDeletePollerResponse) Resume(ctx context.Context, client *LocalNetworkGatewaysClient, token string) error

Resume rehydrates a LocalNetworkGatewaysClientDeletePollerResponse from the provided client and resume token.

type LocalNetworkGatewaysClientDeleteResponse added in v0.3.0 

type LocalNetworkGatewaysClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LocalNetworkGatewaysClientDeleteResponse contains the response from method LocalNetworkGatewaysClient.Delete.

type LocalNetworkGatewaysClientGetOptions added in v0.3.0 

type LocalNetworkGatewaysClientGetOptions struct {
}

LocalNetworkGatewaysClientGetOptions contains the optional parameters for the LocalNetworkGatewaysClient.Get method.

type LocalNetworkGatewaysClientGetResponse added in v0.3.0 

type LocalNetworkGatewaysClientGetResponse struct {
	LocalNetworkGatewaysClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LocalNetworkGatewaysClientGetResponse contains the response from method LocalNetworkGatewaysClient.Get.

type LocalNetworkGatewaysClientGetResult added in v0.3.0 

type LocalNetworkGatewaysClientGetResult struct {
	LocalNetworkGateway
}

LocalNetworkGatewaysClientGetResult contains the result from method LocalNetworkGatewaysClient.Get.

type LocalNetworkGatewaysClientListOptions added in v0.3.0 

type LocalNetworkGatewaysClientListOptions struct {
}

LocalNetworkGatewaysClientListOptions contains the optional parameters for the LocalNetworkGatewaysClient.List method.

type LocalNetworkGatewaysClientListPager added in v0.3.0 

type LocalNetworkGatewaysClientListPager struct {
	// contains filtered or unexported fields
}

LocalNetworkGatewaysClientListPager provides operations for iterating over paged responses.

func (*LocalNetworkGatewaysClientListPager) Err added in v0.3.0 

func (p *LocalNetworkGatewaysClientListPager) Err() error

Err returns the last error encountered while paging.

func (*LocalNetworkGatewaysClientListPager) NextPage added in v0.3.0 

func (p *LocalNetworkGatewaysClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LocalNetworkGatewaysClientListPager) PageResponse added in v0.3.0 

func (p *LocalNetworkGatewaysClientListPager) PageResponse() LocalNetworkGatewaysClientListResponse

PageResponse returns the current LocalNetworkGatewaysClientListResponse page.

type LocalNetworkGatewaysClientListResponse added in v0.3.0 

type LocalNetworkGatewaysClientListResponse struct {
	LocalNetworkGatewaysClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LocalNetworkGatewaysClientListResponse contains the response from method LocalNetworkGatewaysClient.List.

type LocalNetworkGatewaysClientListResult added in v0.3.0 

type LocalNetworkGatewaysClientListResult struct {
	LocalNetworkGatewayListResult
}

LocalNetworkGatewaysClientListResult contains the result from method LocalNetworkGatewaysClient.List.

type LocalNetworkGatewaysClientUpdateTagsOptions added in v0.3.0 

type LocalNetworkGatewaysClientUpdateTagsOptions struct {
}

LocalNetworkGatewaysClientUpdateTagsOptions contains the optional parameters for the LocalNetworkGatewaysClient.UpdateTags method.

type LocalNetworkGatewaysClientUpdateTagsResponse added in v0.3.0 

type LocalNetworkGatewaysClientUpdateTagsResponse struct {
	LocalNetworkGatewaysClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LocalNetworkGatewaysClientUpdateTagsResponse contains the response from method LocalNetworkGatewaysClient.UpdateTags.

type LocalNetworkGatewaysClientUpdateTagsResult added in v0.3.0 

type LocalNetworkGatewaysClientUpdateTagsResult struct {
	LocalNetworkGateway
}

LocalNetworkGatewaysClientUpdateTagsResult contains the result from method LocalNetworkGatewaysClient.UpdateTags.

type LogSpecification 

type LogSpecification struct {
	// Duration of the blob.
	BlobDuration *string `json:"blobDuration,omitempty"`

	// The display name of the specification.
	DisplayName *string `json:"displayName,omitempty"`

	// The name of the specification.
	Name *string `json:"name,omitempty"`
}

LogSpecification - Description of logging specification.

type ManagedRuleEnabledState 

type ManagedRuleEnabledState string

ManagedRuleEnabledState - The state of the managed rule. Defaults to Disabled if not specified. 

const (
	ManagedRuleEnabledStateDisabled ManagedRuleEnabledState = "Disabled"
)

func PossibleManagedRuleEnabledStateValues 

func PossibleManagedRuleEnabledStateValues() []ManagedRuleEnabledState

PossibleManagedRuleEnabledStateValues returns the possible values for the ManagedRuleEnabledState const type.

func (ManagedRuleEnabledState) ToPtr 

func (c ManagedRuleEnabledState) ToPtr() *ManagedRuleEnabledState

ToPtr returns a *ManagedRuleEnabledState pointing to the current value.

type ManagedRuleGroupOverride 

type ManagedRuleGroupOverride struct {
	// REQUIRED; The managed rule group to override.
	RuleGroupName *string `json:"ruleGroupName,omitempty"`

	// List of rules that will be disabled. If none specified, all rules in the group will be disabled.
	Rules []*ManagedRuleOverride `json:"rules,omitempty"`
}

ManagedRuleGroupOverride - Defines a managed rule group override setting.

func (ManagedRuleGroupOverride) MarshalJSON 

func (m ManagedRuleGroupOverride) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedRuleGroupOverride.

type ManagedRuleOverride 

type ManagedRuleOverride struct {
	// REQUIRED; Identifier for the managed rule.
	RuleID *string `json:"ruleId,omitempty"`

	// The state of the managed rule. Defaults to Disabled if not specified.
	State *ManagedRuleEnabledState `json:"state,omitempty"`
}

ManagedRuleOverride - Defines a managed rule group override setting.

type ManagedRuleSet 

type ManagedRuleSet struct {
	// REQUIRED; Defines the rule set type to use.
	RuleSetType *string `json:"ruleSetType,omitempty"`

	// REQUIRED; Defines the version of the rule set to use.
	RuleSetVersion *string `json:"ruleSetVersion,omitempty"`

	// Defines the rule group overrides to apply to the rule set.
	RuleGroupOverrides []*ManagedRuleGroupOverride `json:"ruleGroupOverrides,omitempty"`
}

ManagedRuleSet - Defines a managed rule set.

func (ManagedRuleSet) MarshalJSON 

func (m ManagedRuleSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedRuleSet.

type ManagedRulesDefinition 

type ManagedRulesDefinition struct {
	// REQUIRED; The managed rule sets that are associated with the policy.
	ManagedRuleSets []*ManagedRuleSet `json:"managedRuleSets,omitempty"`

	// The Exclusions that are applied on the policy.
	Exclusions []*OwaspCrsExclusionEntry `json:"exclusions,omitempty"`
}

ManagedRulesDefinition - Allow to exclude some variable satisfy the condition for the WAF check.

func (ManagedRulesDefinition) MarshalJSON 

func (m ManagedRulesDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedRulesDefinition.

type ManagedServiceIdentity 

type ManagedServiceIdentity struct {
	// The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created
	// identity and a set of user assigned identities. The type 'None' will remove any
	// identities from the virtual machine.
	Type *ResourceIdentityType `json:"type,omitempty"`

	// The list of user identities associated with resource. The user identity dictionary key references will be ARM resource
	// ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentities map[string]*Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The principal id of the system assigned identity. This property will only be provided for a system assigned
	// identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

ManagedServiceIdentity - Identity for the resource.

func (ManagedServiceIdentity) MarshalJSON 

func (m ManagedServiceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedServiceIdentity.

type ManagementClient added in v0.3.0 

type ManagementClient struct {
	// contains filtered or unexported fields
}

ManagementClient contains the methods for the NetworkManagementClient group. Don't use this type directly, use NewManagementClient() instead.

func NewManagementClient added in v0.3.0 

func NewManagementClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ManagementClient

NewManagementClient creates a new instance of ManagementClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values. 

func (client *ManagementClient) BeginDeleteBastionShareableLink(ctx context.Context, resourceGroupName string, bastionHostName string, bslRequest BastionShareableLinkListRequest, options *ManagementClientBeginDeleteBastionShareableLinkOptions) (ManagementClientDeleteBastionShareableLinkPollerResponse, error)

BeginDeleteBastionShareableLink - Deletes the Bastion Shareable Links for all the VMs specified in the request. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. bastionHostName - The name of the Bastion Host. bslRequest - Post request for all the Bastion Shareable Link endpoints. options - ManagementClientBeginDeleteBastionShareableLinkOptions contains the optional parameters for the ManagementClient.BeginDeleteBastionShareableLink method.

func (*ManagementClient) BeginGeneratevirtualwanvpnserverconfigurationvpnprofile added in v0.3.0 

func (client *ManagementClient) BeginGeneratevirtualwanvpnserverconfigurationvpnprofile(ctx context.Context, resourceGroupName string, virtualWANName string, vpnClientParams VirtualWanVPNProfileParameters, options *ManagementClientBeginGeneratevirtualwanvpnserverconfigurationvpnprofileOptions) (ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePollerResponse, error)

BeginGeneratevirtualwanvpnserverconfigurationvpnprofile - Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name. virtualWANName - The name of the VirtualWAN whose associated VpnServerConfigurations is needed. vpnClientParams - Parameters supplied to the generate VirtualWan VPN profile generation operation. options - ManagementClientBeginGeneratevirtualwanvpnserverconfigurationvpnprofileOptions contains the optional parameters for the ManagementClient.BeginGeneratevirtualwanvpnserverconfigurationvpnprofile method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewManagementClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGeneratevirtualwanvpnserverconfigurationvpnprofile(ctx,
		"<resource-group-name>",
		"<virtual-wanname>",
		armnetwork.VirtualWanVPNProfileParameters{
			AuthenticationMethod:             armnetwork.AuthenticationMethod("EAPTLS").ToPtr(),
			VPNServerConfigurationResourceID: to.StringPtr("<vpnserver-configuration-resource-id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResult)
}

Output:

func (*ManagementClient) BeginGetActiveSessions added in v0.3.0 

func (client *ManagementClient) BeginGetActiveSessions(ctx context.Context, resourceGroupName string, bastionHostName string, options *ManagementClientBeginGetActiveSessionsOptions) (ManagementClientGetActiveSessionsPollerResponse, error)

BeginGetActiveSessions - Returns the list of currently active sessions on the Bastion. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. bastionHostName - The name of the Bastion Host. options - ManagementClientBeginGetActiveSessionsOptions contains the optional parameters for the ManagementClient.BeginGetActiveSessions method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/BastionSessionsList.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewManagementClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetActiveSessions(ctx,
		"<resource-group-name>",
		"<bastion-host-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	for {
		nextResult := res.NextPage(ctx)
		if err := res.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range res.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:


func (client *ManagementClient) BeginPutBastionShareableLink(ctx context.Context, resourceGroupName string, bastionHostName string, bslRequest BastionShareableLinkListRequest, options *ManagementClientBeginPutBastionShareableLinkOptions) (ManagementClientPutBastionShareableLinkPollerResponse, error)

BeginPutBastionShareableLink - Creates a Bastion Shareable Links for all the VMs specified in the request. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. bastionHostName - The name of the Bastion Host. bslRequest - Post request for all the Bastion Shareable Link endpoints. options - ManagementClientBeginPutBastionShareableLinkOptions contains the optional parameters for the ManagementClient.BeginPutBastionShareableLink method.

func (*ManagementClient) CheckDNSNameAvailability added in v0.3.0 

func (client *ManagementClient) CheckDNSNameAvailability(ctx context.Context, location string, domainNameLabel string, options *ManagementClientCheckDNSNameAvailabilityOptions) (ManagementClientCheckDNSNameAvailabilityResponse, error)

CheckDNSNameAvailability - Checks whether a domain name in the cloudapp.azure.com zone is available for use. If the operation fails it returns an *azcore.ResponseError type. 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]$. options - ManagementClientCheckDNSNameAvailabilityOptions contains the optional parameters for the ManagementClient.CheckDNSNameAvailability method.

func (*ManagementClient) DisconnectActiveSessions added in v0.3.0 

func (client *ManagementClient) DisconnectActiveSessions(resourceGroupName string, bastionHostName string, sessionIDs SessionIDs, options *ManagementClientDisconnectActiveSessionsOptions) *ManagementClientDisconnectActiveSessionsPager

DisconnectActiveSessions - Returns the list of currently active sessions on the Bastion. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. bastionHostName - The name of the Bastion Host. sessionIDs - The list of sessionids to disconnect. options - ManagementClientDisconnectActiveSessionsOptions contains the optional parameters for the ManagementClient.DisconnectActiveSessions method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/BastionSessionDelete.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewManagementClient("<subscription-id>", cred, nil)
	pager := client.DisconnectActiveSessions("<resource-group-name>",
		"<bastion-host-name>",
		armnetwork.SessionIDs{},
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:


func (client *ManagementClient) GetBastionShareableLink(resourceGroupName string, bastionHostName string, bslRequest BastionShareableLinkListRequest, options *ManagementClientGetBastionShareableLinkOptions) *ManagementClientGetBastionShareableLinkPager

GetBastionShareableLink - Return the Bastion Shareable Links for all the VMs specified in the request. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. bastionHostName - The name of the Bastion Host. bslRequest - Post request for all the Bastion Shareable Link endpoints. options - ManagementClientGetBastionShareableLinkOptions contains the optional parameters for the ManagementClient.GetBastionShareableLink method.

func (*ManagementClient) SupportedSecurityProviders added in v0.3.0 

func (client *ManagementClient) SupportedSecurityProviders(ctx context.Context, resourceGroupName string, virtualWANName string, options *ManagementClientSupportedSecurityProvidersOptions) (ManagementClientSupportedSecurityProvidersResponse, error)

SupportedSecurityProviders - Gives the supported security providers for the virtual wan. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name. virtualWANName - The name of the VirtualWAN for which supported security providers are needed. options - ManagementClientSupportedSecurityProvidersOptions contains the optional parameters for the ManagementClient.SupportedSecurityProviders method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualWanSupportedSecurityProviders.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewManagementClient("<subscription-id>", cred, nil)
	res, err := client.SupportedSecurityProviders(ctx,
		"<resource-group-name>",
		"<virtual-wanname>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ManagementClientSupportedSecurityProvidersResult)
}

Output:

type ManagementClientBeginDeleteBastionShareableLinkOptions added in v0.3.0 

type ManagementClientBeginDeleteBastionShareableLinkOptions struct {
}

ManagementClientBeginDeleteBastionShareableLinkOptions contains the optional parameters for the ManagementClient.BeginDeleteBastionShareableLink method.

type ManagementClientBeginGeneratevirtualwanvpnserverconfigurationvpnprofileOptions added in v0.3.0 

type ManagementClientBeginGeneratevirtualwanvpnserverconfigurationvpnprofileOptions struct {
}

ManagementClientBeginGeneratevirtualwanvpnserverconfigurationvpnprofileOptions contains the optional parameters for the ManagementClient.BeginGeneratevirtualwanvpnserverconfigurationvpnprofile method.

type ManagementClientBeginGetActiveSessionsOptions added in v0.3.0 

type ManagementClientBeginGetActiveSessionsOptions struct {
}

ManagementClientBeginGetActiveSessionsOptions contains the optional parameters for the ManagementClient.BeginGetActiveSessions method.

type ManagementClientBeginPutBastionShareableLinkOptions added in v0.3.0 

type ManagementClientBeginPutBastionShareableLinkOptions struct {
}

ManagementClientBeginPutBastionShareableLinkOptions contains the optional parameters for the ManagementClient.BeginPutBastionShareableLink method.

type ManagementClientCheckDNSNameAvailabilityOptions added in v0.3.0 

type ManagementClientCheckDNSNameAvailabilityOptions struct {
}

ManagementClientCheckDNSNameAvailabilityOptions contains the optional parameters for the ManagementClient.CheckDNSNameAvailability method.

type ManagementClientCheckDNSNameAvailabilityResponse added in v0.3.0 

type ManagementClientCheckDNSNameAvailabilityResponse struct {
	ManagementClientCheckDNSNameAvailabilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientCheckDNSNameAvailabilityResponse contains the response from method ManagementClient.CheckDNSNameAvailability.

type ManagementClientCheckDNSNameAvailabilityResult added in v0.3.0 

type ManagementClientCheckDNSNameAvailabilityResult struct {
	DNSNameAvailabilityResult
}

ManagementClientCheckDNSNameAvailabilityResult contains the result from method ManagementClient.CheckDNSNameAvailability.

type ManagementClientDeleteBastionShareableLinkPoller added in v0.3.0 

type ManagementClientDeleteBastionShareableLinkPoller struct {
	// contains filtered or unexported fields
}

ManagementClientDeleteBastionShareableLinkPoller provides polling facilities until the operation reaches a terminal state.

func (*ManagementClientDeleteBastionShareableLinkPoller) Done added in v0.3.0 

func (p *ManagementClientDeleteBastionShareableLinkPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ManagementClientDeleteBastionShareableLinkPoller) FinalResponse added in v0.3.0 

func (p *ManagementClientDeleteBastionShareableLinkPoller) FinalResponse(ctx context.Context) (ManagementClientDeleteBastionShareableLinkResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ManagementClientDeleteBastionShareableLinkResponse will be returned.

func (*ManagementClientDeleteBastionShareableLinkPoller) Poll added in v0.3.0 

func (p *ManagementClientDeleteBastionShareableLinkPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ManagementClientDeleteBastionShareableLinkPoller) ResumeToken added in v0.3.0 

func (p *ManagementClientDeleteBastionShareableLinkPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ManagementClientDeleteBastionShareableLinkPollerResponse added in v0.3.0 

type ManagementClientDeleteBastionShareableLinkPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ManagementClientDeleteBastionShareableLinkPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientDeleteBastionShareableLinkPollerResponse contains the response from method ManagementClient.DeleteBastionShareableLink.

func (ManagementClientDeleteBastionShareableLinkPollerResponse) PollUntilDone added in v0.3.0 

func (l ManagementClientDeleteBastionShareableLinkPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ManagementClientDeleteBastionShareableLinkResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ManagementClientDeleteBastionShareableLinkPollerResponse) Resume added in v0.3.0 

func (l *ManagementClientDeleteBastionShareableLinkPollerResponse) Resume(ctx context.Context, client *ManagementClient, token string) error

Resume rehydrates a ManagementClientDeleteBastionShareableLinkPollerResponse from the provided client and resume token.

type ManagementClientDeleteBastionShareableLinkResponse added in v0.3.0 

type ManagementClientDeleteBastionShareableLinkResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientDeleteBastionShareableLinkResponse contains the response from method ManagementClient.DeleteBastionShareableLink.

type ManagementClientDisconnectActiveSessionsOptions added in v0.3.0 

type ManagementClientDisconnectActiveSessionsOptions struct {
}

ManagementClientDisconnectActiveSessionsOptions contains the optional parameters for the ManagementClient.DisconnectActiveSessions method.

type ManagementClientDisconnectActiveSessionsPager added in v0.3.0 

type ManagementClientDisconnectActiveSessionsPager struct {
	// contains filtered or unexported fields
}

ManagementClientDisconnectActiveSessionsPager provides operations for iterating over paged responses.

func (*ManagementClientDisconnectActiveSessionsPager) Err added in v0.3.0 

func (p *ManagementClientDisconnectActiveSessionsPager) Err() error

Err returns the last error encountered while paging.

func (*ManagementClientDisconnectActiveSessionsPager) NextPage added in v0.3.0 

func (p *ManagementClientDisconnectActiveSessionsPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ManagementClientDisconnectActiveSessionsPager) PageResponse added in v0.3.0 

func (p *ManagementClientDisconnectActiveSessionsPager) PageResponse() ManagementClientDisconnectActiveSessionsResponse

PageResponse returns the current ManagementClientDisconnectActiveSessionsResponse page.

type ManagementClientDisconnectActiveSessionsResponse added in v0.3.0 

type ManagementClientDisconnectActiveSessionsResponse struct {
	ManagementClientDisconnectActiveSessionsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientDisconnectActiveSessionsResponse contains the response from method ManagementClient.DisconnectActiveSessions.

type ManagementClientDisconnectActiveSessionsResult added in v0.3.0 

type ManagementClientDisconnectActiveSessionsResult struct {
	BastionSessionDeleteResult
}

ManagementClientDisconnectActiveSessionsResult contains the result from method ManagementClient.DisconnectActiveSessions.

type ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller added in v0.3.0 

type ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller struct {
	// contains filtered or unexported fields
}

ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller provides polling facilities until the operation reaches a terminal state.

func (*ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller) Done added in v0.3.0 

func (p *ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller) FinalResponse added in v0.3.0 

func (p *ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller) FinalResponse(ctx context.Context) (ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResponse will be returned.

func (*ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller) Poll added in v0.3.0 

func (p *ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller) ResumeToken added in v0.3.0 

func (p *ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePollerResponse added in v0.3.0 

type ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePollerResponse contains the response from method ManagementClient.Generatevirtualwanvpnserverconfigurationvpnprofile.

func (ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePollerResponse) PollUntilDone added in v0.3.0 

func (l ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePollerResponse) Resume added in v0.3.0 

func (l *ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePollerResponse) Resume(ctx context.Context, client *ManagementClient, token string) error

Resume rehydrates a ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofilePollerResponse from the provided client and resume token.

type ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResponse added in v0.3.0 

type ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResponse struct {
	ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResponse contains the response from method ManagementClient.Generatevirtualwanvpnserverconfigurationvpnprofile.

type ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResult added in v0.3.0 

type ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResult struct {
	VPNProfileResponse
}

ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResult contains the result from method ManagementClient.Generatevirtualwanvpnserverconfigurationvpnprofile.

type ManagementClientGetActiveSessionsPager added in v0.3.0 

type ManagementClientGetActiveSessionsPager struct {
	// contains filtered or unexported fields
}

ManagementClientGetActiveSessionsPager provides operations for iterating over paged responses.

func (*ManagementClientGetActiveSessionsPager) Err added in v0.3.0 

func (p *ManagementClientGetActiveSessionsPager) Err() error

Err returns the last error encountered while paging.

func (*ManagementClientGetActiveSessionsPager) NextPage added in v0.3.0 

func (p *ManagementClientGetActiveSessionsPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ManagementClientGetActiveSessionsPager) PageResponse added in v0.3.0 

func (p *ManagementClientGetActiveSessionsPager) PageResponse() ManagementClientGetActiveSessionsResponse

PageResponse returns the current ManagementClientGetActiveSessionsResponse page.

type ManagementClientGetActiveSessionsPoller added in v0.3.0 

type ManagementClientGetActiveSessionsPoller struct {
	// contains filtered or unexported fields
}

ManagementClientGetActiveSessionsPoller provides polling facilities until the operation reaches a terminal state.

func (*ManagementClientGetActiveSessionsPoller) Done added in v0.3.0 

func (p *ManagementClientGetActiveSessionsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ManagementClientGetActiveSessionsPoller) FinalResponse added in v0.3.0 

func (p *ManagementClientGetActiveSessionsPoller) FinalResponse(ctx context.Context) (*ManagementClientGetActiveSessionsPager, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final *ManagementClientGetActiveSessionsPager will be returned.

func (*ManagementClientGetActiveSessionsPoller) Poll added in v0.3.0 

func (p *ManagementClientGetActiveSessionsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ManagementClientGetActiveSessionsPoller) ResumeToken added in v0.3.0 

func (p *ManagementClientGetActiveSessionsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ManagementClientGetActiveSessionsPollerResponse added in v0.3.0 

type ManagementClientGetActiveSessionsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ManagementClientGetActiveSessionsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientGetActiveSessionsPollerResponse contains the response from method ManagementClient.GetActiveSessions.

func (ManagementClientGetActiveSessionsPollerResponse) PollUntilDone added in v0.3.0 

func (l ManagementClientGetActiveSessionsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (*ManagementClientGetActiveSessionsPager, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ManagementClientGetActiveSessionsPollerResponse) Resume added in v0.3.0 

func (l *ManagementClientGetActiveSessionsPollerResponse) Resume(ctx context.Context, client *ManagementClient, token string) error

Resume rehydrates a ManagementClientGetActiveSessionsPollerResponse from the provided client and resume token.

type ManagementClientGetActiveSessionsResponse added in v0.3.0 

type ManagementClientGetActiveSessionsResponse struct {
	ManagementClientGetActiveSessionsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientGetActiveSessionsResponse contains the response from method ManagementClient.GetActiveSessions.

type ManagementClientGetActiveSessionsResult added in v0.3.0 

type ManagementClientGetActiveSessionsResult struct {
	BastionActiveSessionListResult
}

ManagementClientGetActiveSessionsResult contains the result from method ManagementClient.GetActiveSessions.

type ManagementClientGetBastionShareableLinkOptions added in v0.3.0 

type ManagementClientGetBastionShareableLinkOptions struct {
}

ManagementClientGetBastionShareableLinkOptions contains the optional parameters for the ManagementClient.GetBastionShareableLink method.

type ManagementClientGetBastionShareableLinkPager added in v0.3.0 

type ManagementClientGetBastionShareableLinkPager struct {
	// contains filtered or unexported fields
}

ManagementClientGetBastionShareableLinkPager provides operations for iterating over paged responses.

func (*ManagementClientGetBastionShareableLinkPager) Err added in v0.3.0 

func (p *ManagementClientGetBastionShareableLinkPager) Err() error

Err returns the last error encountered while paging.

func (*ManagementClientGetBastionShareableLinkPager) NextPage added in v0.3.0 

func (p *ManagementClientGetBastionShareableLinkPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ManagementClientGetBastionShareableLinkPager) PageResponse added in v0.3.0 

func (p *ManagementClientGetBastionShareableLinkPager) PageResponse() ManagementClientGetBastionShareableLinkResponse

PageResponse returns the current ManagementClientGetBastionShareableLinkResponse page.

type ManagementClientGetBastionShareableLinkResponse added in v0.3.0 

type ManagementClientGetBastionShareableLinkResponse struct {
	ManagementClientGetBastionShareableLinkResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientGetBastionShareableLinkResponse contains the response from method ManagementClient.GetBastionShareableLink.

type ManagementClientGetBastionShareableLinkResult added in v0.3.0 

type ManagementClientGetBastionShareableLinkResult struct {
	BastionShareableLinkListResult
}

ManagementClientGetBastionShareableLinkResult contains the result from method ManagementClient.GetBastionShareableLink.

type ManagementClientPutBastionShareableLinkPager added in v0.3.0 

type ManagementClientPutBastionShareableLinkPager struct {
	// contains filtered or unexported fields
}

ManagementClientPutBastionShareableLinkPager provides operations for iterating over paged responses.

func (*ManagementClientPutBastionShareableLinkPager) Err added in v0.3.0 

func (p *ManagementClientPutBastionShareableLinkPager) Err() error

Err returns the last error encountered while paging.

func (*ManagementClientPutBastionShareableLinkPager) NextPage added in v0.3.0 

func (p *ManagementClientPutBastionShareableLinkPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ManagementClientPutBastionShareableLinkPager) PageResponse added in v0.3.0 

func (p *ManagementClientPutBastionShareableLinkPager) PageResponse() ManagementClientPutBastionShareableLinkResponse

PageResponse returns the current ManagementClientPutBastionShareableLinkResponse page.

type ManagementClientPutBastionShareableLinkPoller added in v0.3.0 

type ManagementClientPutBastionShareableLinkPoller struct {
	// contains filtered or unexported fields
}

ManagementClientPutBastionShareableLinkPoller provides polling facilities until the operation reaches a terminal state.

func (*ManagementClientPutBastionShareableLinkPoller) Done added in v0.3.0 

func (p *ManagementClientPutBastionShareableLinkPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ManagementClientPutBastionShareableLinkPoller) FinalResponse added in v0.3.0 

func (p *ManagementClientPutBastionShareableLinkPoller) FinalResponse(ctx context.Context) (*ManagementClientPutBastionShareableLinkPager, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final *ManagementClientPutBastionShareableLinkPager will be returned.

func (*ManagementClientPutBastionShareableLinkPoller) Poll added in v0.3.0 

func (p *ManagementClientPutBastionShareableLinkPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ManagementClientPutBastionShareableLinkPoller) ResumeToken added in v0.3.0 

func (p *ManagementClientPutBastionShareableLinkPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ManagementClientPutBastionShareableLinkPollerResponse added in v0.3.0 

type ManagementClientPutBastionShareableLinkPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ManagementClientPutBastionShareableLinkPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientPutBastionShareableLinkPollerResponse contains the response from method ManagementClient.PutBastionShareableLink.

func (ManagementClientPutBastionShareableLinkPollerResponse) PollUntilDone added in v0.3.0 

func (l ManagementClientPutBastionShareableLinkPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (*ManagementClientPutBastionShareableLinkPager, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ManagementClientPutBastionShareableLinkPollerResponse) Resume added in v0.3.0 

func (l *ManagementClientPutBastionShareableLinkPollerResponse) Resume(ctx context.Context, client *ManagementClient, token string) error

Resume rehydrates a ManagementClientPutBastionShareableLinkPollerResponse from the provided client and resume token.

type ManagementClientPutBastionShareableLinkResponse added in v0.3.0 

type ManagementClientPutBastionShareableLinkResponse struct {
	ManagementClientPutBastionShareableLinkResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientPutBastionShareableLinkResponse contains the response from method ManagementClient.PutBastionShareableLink.

type ManagementClientPutBastionShareableLinkResult added in v0.3.0 

type ManagementClientPutBastionShareableLinkResult struct {
	BastionShareableLinkListResult
}

ManagementClientPutBastionShareableLinkResult contains the result from method ManagementClient.PutBastionShareableLink.

type ManagementClientSupportedSecurityProvidersOptions added in v0.3.0 

type ManagementClientSupportedSecurityProvidersOptions struct {
}

ManagementClientSupportedSecurityProvidersOptions contains the optional parameters for the ManagementClient.SupportedSecurityProviders method.

type ManagementClientSupportedSecurityProvidersResponse added in v0.3.0 

type ManagementClientSupportedSecurityProvidersResponse struct {
	ManagementClientSupportedSecurityProvidersResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagementClientSupportedSecurityProvidersResponse contains the response from method ManagementClient.SupportedSecurityProviders.

type ManagementClientSupportedSecurityProvidersResult added in v0.3.0 

type ManagementClientSupportedSecurityProvidersResult struct {
	VirtualWanSecurityProviders
}

ManagementClientSupportedSecurityProvidersResult contains the result from method ManagementClient.SupportedSecurityProviders.

type MatchCondition 

type MatchCondition struct {
	// REQUIRED; Match value.
	MatchValues []*string `json:"matchValues,omitempty"`

	// REQUIRED; List of match variables.
	MatchVariables []*MatchVariable `json:"matchVariables,omitempty"`

	// REQUIRED; The operator to be matched.
	Operator *WebApplicationFirewallOperator `json:"operator,omitempty"`

	// Whether this is negate condition or not.
	NegationConditon *bool `json:"negationConditon,omitempty"`

	// List of transforms.
	Transforms []*WebApplicationFirewallTransform `json:"transforms,omitempty"`
}

MatchCondition - Define match conditions.

func (MatchCondition) MarshalJSON 

func (m MatchCondition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MatchCondition.

type MatchVariable 

type MatchVariable struct {
	// REQUIRED; Match Variable.
	VariableName *WebApplicationFirewallMatchVariable `json:"variableName,omitempty"`

	// The selector of match variable.
	Selector *string `json:"selector,omitempty"`
}

MatchVariable - Define match variables.

type MatchedRule 

type MatchedRule struct {
	// The network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'.
	Action *string `json:"action,omitempty"`

	// Name of the matched network security rule.
	RuleName *string `json:"ruleName,omitempty"`
}

MatchedRule - Matched rule.

type MetricSpecification 

type MetricSpecification struct {
	// The aggregation type.
	AggregationType *string `json:"aggregationType,omitempty"`

	// List of availability.
	Availabilities []*Availability `json:"availabilities,omitempty"`

	// List of dimensions.
	Dimensions []*Dimension `json:"dimensions,omitempty"`

	// The description of the metric.
	DisplayDescription *string `json:"displayDescription,omitempty"`

	// The display name of the metric.
	DisplayName *string `json:"displayName,omitempty"`

	// Whether regional MDM account enabled.
	EnableRegionalMdmAccount *bool `json:"enableRegionalMdmAccount,omitempty"`

	// Whether gaps would be filled with zeros.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`

	// Whether the metric is internal.
	IsInternal *bool `json:"isInternal,omitempty"`

	// Pattern for the filter of the metric.
	MetricFilterPattern *string `json:"metricFilterPattern,omitempty"`

	// The name of the metric.
	Name *string `json:"name,omitempty"`

	// The resource Id dimension name override.
	ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"`

	// The source MDM account.
	SourceMdmAccount *string `json:"sourceMdmAccount,omitempty"`

	// The source MDM namespace.
	SourceMdmNamespace *string `json:"sourceMdmNamespace,omitempty"`

	// Units the metric to be displayed in.
	Unit *string `json:"unit,omitempty"`
}

MetricSpecification - Description of metrics specification.

func (MetricSpecification) MarshalJSON 

func (m MetricSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricSpecification.

type NatGateway 

type NatGateway struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Nat Gateway properties.
	Properties *NatGatewayPropertiesFormat `json:"properties,omitempty"`

	// The nat gateway SKU.
	SKU *NatGatewaySKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// A list of availability zones denoting the zone in which Nat Gateway should be deployed.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

NatGateway - Nat Gateway resource.

func (NatGateway) MarshalJSON 

func (n NatGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NatGateway.

type NatGatewayListResult 

type NatGatewayListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of Nat Gateways that exists in a resource group.
	Value []*NatGateway `json:"value,omitempty"`
}

NatGatewayListResult - Response for ListNatGateways API service call.

func (NatGatewayListResult) MarshalJSON 

func (n NatGatewayListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NatGatewayListResult.

type NatGatewayPropertiesFormat 

type NatGatewayPropertiesFormat struct {
	// The idle timeout of the nat gateway.
	IdleTimeoutInMinutes *int32 `json:"idleTimeoutInMinutes,omitempty"`

	// An array of public ip addresses associated with the nat gateway resource.
	PublicIPAddresses []*SubResource `json:"publicIpAddresses,omitempty"`

	// An array of public ip prefixes associated with the nat gateway resource.
	PublicIPPrefixes []*SubResource `json:"publicIpPrefixes,omitempty"`

	// READ-ONLY; The provisioning state of the NAT gateway resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the NAT gateway resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to the subnets using this nat gateway resource.
	Subnets []*SubResource `json:"subnets,omitempty" azure:"ro"`
}

NatGatewayPropertiesFormat - Nat Gateway properties.

func (NatGatewayPropertiesFormat) MarshalJSON 

func (n NatGatewayPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NatGatewayPropertiesFormat.

type NatGatewaySKU 

type NatGatewaySKU struct {
	// Name of Nat Gateway SKU.
	Name *NatGatewaySKUName `json:"name,omitempty"`
}

NatGatewaySKU - SKU of nat gateway.

type NatGatewaySKUName 

type NatGatewaySKUName string

NatGatewaySKUName - Name of Nat Gateway SKU. 

const (
	NatGatewaySKUNameStandard NatGatewaySKUName = "Standard"
)

func PossibleNatGatewaySKUNameValues 

func PossibleNatGatewaySKUNameValues() []NatGatewaySKUName

PossibleNatGatewaySKUNameValues returns the possible values for the NatGatewaySKUName const type.

func (NatGatewaySKUName) ToPtr 

func (c NatGatewaySKUName) ToPtr() *NatGatewaySKUName

ToPtr returns a *NatGatewaySKUName pointing to the current value.

type NatGatewaysClient 

type NatGatewaysClient struct {
	// contains filtered or unexported fields
}

NatGatewaysClient contains the methods for the NatGateways group. Don't use this type directly, use NewNatGatewaysClient() instead.

func NewNatGatewaysClient 

func NewNatGatewaysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *NatGatewaysClient

NewNatGatewaysClient creates a new instance of NatGatewaysClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*NatGatewaysClient) BeginCreateOrUpdate 

func (client *NatGatewaysClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, natGatewayName string, parameters NatGateway, options *NatGatewaysClientBeginCreateOrUpdateOptions) (NatGatewaysClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a nat gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. natGatewayName - The name of the nat gateway. parameters - Parameters supplied to the create or update nat gateway operation. options - NatGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the NatGatewaysClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NatGatewayCreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewNatGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<nat-gateway-name>",
		armnetwork.NatGateway{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.NatGatewayPropertiesFormat{
				PublicIPAddresses: []*armnetwork.SubResource{
					{
						ID: to.StringPtr("<id>"),
					}},
				PublicIPPrefixes: []*armnetwork.SubResource{
					{
						ID: to.StringPtr("<id>"),
					}},
			},
			SKU: &armnetwork.NatGatewaySKU{
				Name: armnetwork.NatGatewaySKUName("Standard").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.NatGatewaysClientCreateOrUpdateResult)
}

Output:

func (*NatGatewaysClient) BeginDelete 

func (client *NatGatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, natGatewayName string, options *NatGatewaysClientBeginDeleteOptions) (NatGatewaysClientDeletePollerResponse, error)

BeginDelete - Deletes the specified nat gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. natGatewayName - The name of the nat gateway. options - NatGatewaysClientBeginDeleteOptions contains the optional parameters for the NatGatewaysClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NatGatewayDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewNatGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<nat-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*NatGatewaysClient) Get 

func (client *NatGatewaysClient) Get(ctx context.Context, resourceGroupName string, natGatewayName string, options *NatGatewaysClientGetOptions) (NatGatewaysClientGetResponse, error)

Get - Gets the specified nat gateway in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. natGatewayName - The name of the nat gateway. options - NatGatewaysClientGetOptions contains the optional parameters for the NatGatewaysClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NatGatewayGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewNatGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<nat-gateway-name>",
		&armnetwork.NatGatewaysClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.NatGatewaysClientGetResult)
}

Output:

func (*NatGatewaysClient) List 

func (client *NatGatewaysClient) List(resourceGroupName string, options *NatGatewaysClientListOptions) *NatGatewaysClientListPager

List - Gets all nat gateways in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - NatGatewaysClientListOptions contains the optional parameters for the NatGatewaysClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NatGatewayList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewNatGatewaysClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*NatGatewaysClient) ListAll 

func (client *NatGatewaysClient) ListAll(options *NatGatewaysClientListAllOptions) *NatGatewaysClientListAllPager

ListAll - Gets all the Nat Gateways in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - NatGatewaysClientListAllOptions contains the optional parameters for the NatGatewaysClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NatGatewayListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewNatGatewaysClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*NatGatewaysClient) UpdateTags 

func (client *NatGatewaysClient) UpdateTags(ctx context.Context, resourceGroupName string, natGatewayName string, parameters TagsObject, options *NatGatewaysClientUpdateTagsOptions) (NatGatewaysClientUpdateTagsResponse, error)

UpdateTags - Updates nat gateway tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. natGatewayName - The name of the nat gateway. parameters - Parameters supplied to update nat gateway tags. options - NatGatewaysClientUpdateTagsOptions contains the optional parameters for the NatGatewaysClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NatGatewayUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewNatGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<nat-gateway-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.NatGatewaysClientUpdateTagsResult)
}

Output:

type NatGatewaysClientBeginCreateOrUpdateOptions added in v0.3.0 

type NatGatewaysClientBeginCreateOrUpdateOptions struct {
}

NatGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the NatGatewaysClient.BeginCreateOrUpdate method.

type NatGatewaysClientBeginDeleteOptions added in v0.3.0 

type NatGatewaysClientBeginDeleteOptions struct {
}

NatGatewaysClientBeginDeleteOptions contains the optional parameters for the NatGatewaysClient.BeginDelete method.

type NatGatewaysClientCreateOrUpdatePoller added in v0.3.0 

type NatGatewaysClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

NatGatewaysClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*NatGatewaysClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *NatGatewaysClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*NatGatewaysClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *NatGatewaysClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (NatGatewaysClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final NatGatewaysClientCreateOrUpdateResponse will be returned.

func (*NatGatewaysClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *NatGatewaysClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*NatGatewaysClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *NatGatewaysClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type NatGatewaysClientCreateOrUpdatePollerResponse added in v0.3.0 

type NatGatewaysClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *NatGatewaysClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatGatewaysClientCreateOrUpdatePollerResponse contains the response from method NatGatewaysClient.CreateOrUpdate.

func (NatGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l NatGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (NatGatewaysClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*NatGatewaysClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *NatGatewaysClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *NatGatewaysClient, token string) error

Resume rehydrates a NatGatewaysClientCreateOrUpdatePollerResponse from the provided client and resume token.

type NatGatewaysClientCreateOrUpdateResponse added in v0.3.0 

type NatGatewaysClientCreateOrUpdateResponse struct {
	NatGatewaysClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatGatewaysClientCreateOrUpdateResponse contains the response from method NatGatewaysClient.CreateOrUpdate.

type NatGatewaysClientCreateOrUpdateResult added in v0.3.0 

type NatGatewaysClientCreateOrUpdateResult struct {
	NatGateway
}

NatGatewaysClientCreateOrUpdateResult contains the result from method NatGatewaysClient.CreateOrUpdate.

type NatGatewaysClientDeletePoller added in v0.3.0 

type NatGatewaysClientDeletePoller struct {
	// contains filtered or unexported fields
}

NatGatewaysClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*NatGatewaysClientDeletePoller) Done added in v0.3.0 

func (p *NatGatewaysClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*NatGatewaysClientDeletePoller) FinalResponse added in v0.3.0 

func (p *NatGatewaysClientDeletePoller) FinalResponse(ctx context.Context) (NatGatewaysClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final NatGatewaysClientDeleteResponse will be returned.

func (*NatGatewaysClientDeletePoller) Poll added in v0.3.0 

func (p *NatGatewaysClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*NatGatewaysClientDeletePoller) ResumeToken added in v0.3.0 

func (p *NatGatewaysClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type NatGatewaysClientDeletePollerResponse added in v0.3.0 

type NatGatewaysClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *NatGatewaysClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatGatewaysClientDeletePollerResponse contains the response from method NatGatewaysClient.Delete.

func (NatGatewaysClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l NatGatewaysClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (NatGatewaysClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*NatGatewaysClientDeletePollerResponse) Resume added in v0.3.0 

func (l *NatGatewaysClientDeletePollerResponse) Resume(ctx context.Context, client *NatGatewaysClient, token string) error

Resume rehydrates a NatGatewaysClientDeletePollerResponse from the provided client and resume token.

type NatGatewaysClientDeleteResponse added in v0.3.0 

type NatGatewaysClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatGatewaysClientDeleteResponse contains the response from method NatGatewaysClient.Delete.

type NatGatewaysClientGetOptions added in v0.3.0 

type NatGatewaysClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

NatGatewaysClientGetOptions contains the optional parameters for the NatGatewaysClient.Get method.

type NatGatewaysClientGetResponse added in v0.3.0 

type NatGatewaysClientGetResponse struct {
	NatGatewaysClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatGatewaysClientGetResponse contains the response from method NatGatewaysClient.Get.

type NatGatewaysClientGetResult added in v0.3.0 

type NatGatewaysClientGetResult struct {
	NatGateway
}

NatGatewaysClientGetResult contains the result from method NatGatewaysClient.Get.

type NatGatewaysClientListAllOptions added in v0.3.0 

type NatGatewaysClientListAllOptions struct {
}

NatGatewaysClientListAllOptions contains the optional parameters for the NatGatewaysClient.ListAll method.

type NatGatewaysClientListAllPager added in v0.3.0 

type NatGatewaysClientListAllPager struct {
	// contains filtered or unexported fields
}

NatGatewaysClientListAllPager provides operations for iterating over paged responses.

func (*NatGatewaysClientListAllPager) Err added in v0.3.0 

func (p *NatGatewaysClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*NatGatewaysClientListAllPager) NextPage added in v0.3.0 

func (p *NatGatewaysClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*NatGatewaysClientListAllPager) PageResponse added in v0.3.0 

func (p *NatGatewaysClientListAllPager) PageResponse() NatGatewaysClientListAllResponse

PageResponse returns the current NatGatewaysClientListAllResponse page.

type NatGatewaysClientListAllResponse added in v0.3.0 

type NatGatewaysClientListAllResponse struct {
	NatGatewaysClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatGatewaysClientListAllResponse contains the response from method NatGatewaysClient.ListAll.

type NatGatewaysClientListAllResult added in v0.3.0 

type NatGatewaysClientListAllResult struct {
	NatGatewayListResult
}

NatGatewaysClientListAllResult contains the result from method NatGatewaysClient.ListAll.

type NatGatewaysClientListOptions added in v0.3.0 

type NatGatewaysClientListOptions struct {
}

NatGatewaysClientListOptions contains the optional parameters for the NatGatewaysClient.List method.

type NatGatewaysClientListPager added in v0.3.0 

type NatGatewaysClientListPager struct {
	// contains filtered or unexported fields
}

NatGatewaysClientListPager provides operations for iterating over paged responses.

func (*NatGatewaysClientListPager) Err added in v0.3.0 

func (p *NatGatewaysClientListPager) Err() error

Err returns the last error encountered while paging.

func (*NatGatewaysClientListPager) NextPage added in v0.3.0 

func (p *NatGatewaysClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*NatGatewaysClientListPager) PageResponse added in v0.3.0 

func (p *NatGatewaysClientListPager) PageResponse() NatGatewaysClientListResponse

PageResponse returns the current NatGatewaysClientListResponse page.

type NatGatewaysClientListResponse added in v0.3.0 

type NatGatewaysClientListResponse struct {
	NatGatewaysClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatGatewaysClientListResponse contains the response from method NatGatewaysClient.List.

type NatGatewaysClientListResult added in v0.3.0 

type NatGatewaysClientListResult struct {
	NatGatewayListResult
}

NatGatewaysClientListResult contains the result from method NatGatewaysClient.List.

type NatGatewaysClientUpdateTagsOptions added in v0.3.0 

type NatGatewaysClientUpdateTagsOptions struct {
}

NatGatewaysClientUpdateTagsOptions contains the optional parameters for the NatGatewaysClient.UpdateTags method.

type NatGatewaysClientUpdateTagsResponse added in v0.3.0 

type NatGatewaysClientUpdateTagsResponse struct {
	NatGatewaysClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatGatewaysClientUpdateTagsResponse contains the response from method NatGatewaysClient.UpdateTags.

type NatGatewaysClientUpdateTagsResult added in v0.3.0 

type NatGatewaysClientUpdateTagsResult struct {
	NatGateway
}

NatGatewaysClientUpdateTagsResult contains the result from method NatGatewaysClient.UpdateTags.

type NatRule 

type NatRule struct {
	// REQUIRED; Rule Type.
	RuleType *FirewallPolicyRuleType `json:"ruleType,omitempty"`

	// Description of the rule.
	Description *string `json:"description,omitempty"`

	// List of destination IP addresses or Service Tags.
	DestinationAddresses []*string `json:"destinationAddresses,omitempty"`

	// List of destination ports.
	DestinationPorts []*string `json:"destinationPorts,omitempty"`

	// Array of FirewallPolicyRuleNetworkProtocols.
	IPProtocols []*FirewallPolicyRuleNetworkProtocol `json:"ipProtocols,omitempty"`

	// Name of the rule.
	Name *string `json:"name,omitempty"`

	// List of source IP addresses for this rule.
	SourceAddresses []*string `json:"sourceAddresses,omitempty"`

	// List of source IpGroups for this rule.
	SourceIPGroups []*string `json:"sourceIpGroups,omitempty"`

	// The translated address for this NAT rule.
	TranslatedAddress *string `json:"translatedAddress,omitempty"`

	// The translated FQDN for this NAT rule.
	TranslatedFqdn *string `json:"translatedFqdn,omitempty"`

	// The translated port for this NAT rule.
	TranslatedPort *string `json:"translatedPort,omitempty"`
}

NatRule - Rule of type nat.

func (*NatRule) GetFirewallPolicyRule added in v0.3.0 

func (n *NatRule) GetFirewallPolicyRule() *FirewallPolicyRule

GetFirewallPolicyRule implements the FirewallPolicyRuleClassification interface for type NatRule.

func (NatRule) MarshalJSON 

func (n NatRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NatRule.

func (*NatRule) UnmarshalJSON 

func (n *NatRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NatRule.

type NatRulePortMapping added in v0.2.0 

type NatRulePortMapping struct {
	// Backend port.
	BackendPort *int32 `json:"backendPort,omitempty"`

	// Frontend port.
	FrontendPort *int32 `json:"frontendPort,omitempty"`

	// Name of inbound NAT rule.
	InboundNatRuleName *string `json:"inboundNatRuleName,omitempty"`
}

NatRulePortMapping - Individual port mappings for inbound NAT rule created for backend pool.

type NatRulesClient 

type NatRulesClient struct {
	// contains filtered or unexported fields
}

NatRulesClient contains the methods for the NatRules group. Don't use this type directly, use NewNatRulesClient() instead.

func NewNatRulesClient 

func NewNatRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *NatRulesClient

NewNatRulesClient creates a new instance of NatRulesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*NatRulesClient) BeginCreateOrUpdate 

func (client *NatRulesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, gatewayName string, natRuleName string, natRuleParameters VPNGatewayNatRule, options *NatRulesClientBeginCreateOrUpdateOptions) (NatRulesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. natRuleName - The name of the nat rule. natRuleParameters - Parameters supplied to create or Update a Nat Rule. options - NatRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the NatRulesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NatRulePut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewNatRulesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<nat-rule-name>",
		armnetwork.VPNGatewayNatRule{
			Properties: &armnetwork.VPNGatewayNatRuleProperties{
				Type: armnetwork.VPNNatRuleType("Static").ToPtr(),
				ExternalMappings: []*armnetwork.VPNNatRuleMapping{
					{
						AddressSpace: to.StringPtr("<address-space>"),
					}},
				InternalMappings: []*armnetwork.VPNNatRuleMapping{
					{
						AddressSpace: to.StringPtr("<address-space>"),
					}},
				IPConfigurationID: to.StringPtr("<ipconfiguration-id>"),
				Mode:              armnetwork.VPNNatRuleMode("EgressSnat").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.NatRulesClientCreateOrUpdateResult)
}

Output:

func (*NatRulesClient) BeginDelete 

func (client *NatRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, gatewayName string, natRuleName string, options *NatRulesClientBeginDeleteOptions) (NatRulesClientDeletePollerResponse, error)

BeginDelete - Deletes a nat rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. natRuleName - The name of the nat rule. options - NatRulesClientBeginDeleteOptions contains the optional parameters for the NatRulesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NatRuleDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewNatRulesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<nat-rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*NatRulesClient) Get 

func (client *NatRulesClient) Get(ctx context.Context, resourceGroupName string, gatewayName string, natRuleName string, options *NatRulesClientGetOptions) (NatRulesClientGetResponse, error)

Get - Retrieves the details of a nat ruleGet. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. natRuleName - The name of the nat rule. options - NatRulesClientGetOptions contains the optional parameters for the NatRulesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NatRuleGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewNatRulesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<nat-rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.NatRulesClientGetResult)
}

Output:

func (*NatRulesClient) ListByVPNGateway 

func (client *NatRulesClient) ListByVPNGateway(resourceGroupName string, gatewayName string, options *NatRulesClientListByVPNGatewayOptions) *NatRulesClientListByVPNGatewayPager

ListByVPNGateway - Retrieves all nat rules for a particular virtual wan vpn gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. options - NatRulesClientListByVPNGatewayOptions contains the optional parameters for the NatRulesClient.ListByVPNGateway method.

type NatRulesClientBeginCreateOrUpdateOptions added in v0.3.0 

type NatRulesClientBeginCreateOrUpdateOptions struct {
}

NatRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the NatRulesClient.BeginCreateOrUpdate method.

type NatRulesClientBeginDeleteOptions added in v0.3.0 

type NatRulesClientBeginDeleteOptions struct {
}

NatRulesClientBeginDeleteOptions contains the optional parameters for the NatRulesClient.BeginDelete method.

type NatRulesClientCreateOrUpdatePoller added in v0.3.0 

type NatRulesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

NatRulesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*NatRulesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *NatRulesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*NatRulesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *NatRulesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (NatRulesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final NatRulesClientCreateOrUpdateResponse will be returned.

func (*NatRulesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *NatRulesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*NatRulesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *NatRulesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type NatRulesClientCreateOrUpdatePollerResponse added in v0.3.0 

type NatRulesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *NatRulesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatRulesClientCreateOrUpdatePollerResponse contains the response from method NatRulesClient.CreateOrUpdate.

func (NatRulesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l NatRulesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (NatRulesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*NatRulesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *NatRulesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *NatRulesClient, token string) error

Resume rehydrates a NatRulesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type NatRulesClientCreateOrUpdateResponse added in v0.3.0 

type NatRulesClientCreateOrUpdateResponse struct {
	NatRulesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatRulesClientCreateOrUpdateResponse contains the response from method NatRulesClient.CreateOrUpdate.

type NatRulesClientCreateOrUpdateResult added in v0.3.0 

type NatRulesClientCreateOrUpdateResult struct {
	VPNGatewayNatRule
}

NatRulesClientCreateOrUpdateResult contains the result from method NatRulesClient.CreateOrUpdate.

type NatRulesClientDeletePoller added in v0.3.0 

type NatRulesClientDeletePoller struct {
	// contains filtered or unexported fields
}

NatRulesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*NatRulesClientDeletePoller) Done added in v0.3.0 

func (p *NatRulesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*NatRulesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *NatRulesClientDeletePoller) FinalResponse(ctx context.Context) (NatRulesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final NatRulesClientDeleteResponse will be returned.

func (*NatRulesClientDeletePoller) Poll added in v0.3.0 

func (p *NatRulesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*NatRulesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *NatRulesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type NatRulesClientDeletePollerResponse added in v0.3.0 

type NatRulesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *NatRulesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatRulesClientDeletePollerResponse contains the response from method NatRulesClient.Delete.

func (NatRulesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l NatRulesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (NatRulesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*NatRulesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *NatRulesClientDeletePollerResponse) Resume(ctx context.Context, client *NatRulesClient, token string) error

Resume rehydrates a NatRulesClientDeletePollerResponse from the provided client and resume token.

type NatRulesClientDeleteResponse added in v0.3.0 

type NatRulesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatRulesClientDeleteResponse contains the response from method NatRulesClient.Delete.

type NatRulesClientGetOptions added in v0.3.0 

type NatRulesClientGetOptions struct {
}

NatRulesClientGetOptions contains the optional parameters for the NatRulesClient.Get method.

type NatRulesClientGetResponse added in v0.3.0 

type NatRulesClientGetResponse struct {
	NatRulesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatRulesClientGetResponse contains the response from method NatRulesClient.Get.

type NatRulesClientGetResult added in v0.3.0 

type NatRulesClientGetResult struct {
	VPNGatewayNatRule
}

NatRulesClientGetResult contains the result from method NatRulesClient.Get.

type NatRulesClientListByVPNGatewayOptions added in v0.3.0 

type NatRulesClientListByVPNGatewayOptions struct {
}

NatRulesClientListByVPNGatewayOptions contains the optional parameters for the NatRulesClient.ListByVPNGateway method.

type NatRulesClientListByVPNGatewayPager added in v0.3.0 

type NatRulesClientListByVPNGatewayPager struct {
	// contains filtered or unexported fields
}

NatRulesClientListByVPNGatewayPager provides operations for iterating over paged responses.

func (*NatRulesClientListByVPNGatewayPager) Err added in v0.3.0 

func (p *NatRulesClientListByVPNGatewayPager) Err() error

Err returns the last error encountered while paging.

func (*NatRulesClientListByVPNGatewayPager) NextPage added in v0.3.0 

func (p *NatRulesClientListByVPNGatewayPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*NatRulesClientListByVPNGatewayPager) PageResponse added in v0.3.0 

func (p *NatRulesClientListByVPNGatewayPager) PageResponse() NatRulesClientListByVPNGatewayResponse

PageResponse returns the current NatRulesClientListByVPNGatewayResponse page.

type NatRulesClientListByVPNGatewayResponse added in v0.3.0 

type NatRulesClientListByVPNGatewayResponse struct {
	NatRulesClientListByVPNGatewayResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

NatRulesClientListByVPNGatewayResponse contains the response from method NatRulesClient.ListByVPNGateway.

type NatRulesClientListByVPNGatewayResult added in v0.3.0 

type NatRulesClientListByVPNGatewayResult struct {
	ListVPNGatewayNatRulesResult
}

NatRulesClientListByVPNGatewayResult contains the result from method NatRulesClient.ListByVPNGateway.

type NetworkInterfaceMigrationPhase 

type NetworkInterfaceMigrationPhase string

NetworkInterfaceMigrationPhase - Migration phase of Network Interface resource. 

const (
	NetworkInterfaceMigrationPhaseAbort     NetworkInterfaceMigrationPhase = "Abort"
	NetworkInterfaceMigrationPhaseCommit    NetworkInterfaceMigrationPhase = "Commit"
	NetworkInterfaceMigrationPhaseCommitted NetworkInterfaceMigrationPhase = "Committed"
	NetworkInterfaceMigrationPhaseNone      NetworkInterfaceMigrationPhase = "None"
	NetworkInterfaceMigrationPhasePrepare   NetworkInterfaceMigrationPhase = "Prepare"
)

func PossibleNetworkInterfaceMigrationPhaseValues 

func PossibleNetworkInterfaceMigrationPhaseValues() []NetworkInterfaceMigrationPhase

PossibleNetworkInterfaceMigrationPhaseValues returns the possible values for the NetworkInterfaceMigrationPhase const type.

func (NetworkInterfaceMigrationPhase) ToPtr 

func (c NetworkInterfaceMigrationPhase) ToPtr() *NetworkInterfaceMigrationPhase

ToPtr returns a *NetworkInterfaceMigrationPhase pointing to the current value.

type NetworkInterfaceNicType 

type NetworkInterfaceNicType string

NetworkInterfaceNicType - Type of Network Interface resource. 

const (
	NetworkInterfaceNicTypeElastic  NetworkInterfaceNicType = "Elastic"
	NetworkInterfaceNicTypeStandard NetworkInterfaceNicType = "Standard"
)

func PossibleNetworkInterfaceNicTypeValues 

func PossibleNetworkInterfaceNicTypeValues() []NetworkInterfaceNicType

PossibleNetworkInterfaceNicTypeValues returns the possible values for the NetworkInterfaceNicType const type.

func (NetworkInterfaceNicType) ToPtr 

func (c NetworkInterfaceNicType) ToPtr() *NetworkInterfaceNicType

ToPtr returns a *NetworkInterfaceNicType pointing to the current value.

type NetworkOperationStatus 

type NetworkOperationStatus string

NetworkOperationStatus - Status of the Azure async operation. 

const (
	NetworkOperationStatusFailed     NetworkOperationStatus = "Failed"
	NetworkOperationStatusInProgress NetworkOperationStatus = "InProgress"
	NetworkOperationStatusSucceeded  NetworkOperationStatus = "Succeeded"
)

func PossibleNetworkOperationStatusValues 

func PossibleNetworkOperationStatusValues() []NetworkOperationStatus

PossibleNetworkOperationStatusValues returns the possible values for the NetworkOperationStatus const type.

func (NetworkOperationStatus) ToPtr 

func (c NetworkOperationStatus) ToPtr() *NetworkOperationStatus

ToPtr returns a *NetworkOperationStatus pointing to the current value.

type NextHopParameters 

type NextHopParameters struct {
	// REQUIRED; The destination IP address.
	DestinationIPAddress *string `json:"destinationIPAddress,omitempty"`

	// REQUIRED; The source IP address.
	SourceIPAddress *string `json:"sourceIPAddress,omitempty"`

	// REQUIRED; The resource identifier of the target resource against which the action is to be performed.
	TargetResourceID *string `json:"targetResourceId,omitempty"`

	// The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified.
	// Otherwise optional).
	TargetNicResourceID *string `json:"targetNicResourceId,omitempty"`
}

NextHopParameters - Parameters that define the source and destination endpoint.

type NextHopResult 

type NextHopResult struct {
	// Next hop IP Address.
	NextHopIPAddress *string `json:"nextHopIpAddress,omitempty"`

	// Next hop type.
	NextHopType *NextHopType `json:"nextHopType,omitempty"`

	// The resource identifier for the route table associated with the route being returned. If the route being returned does
	// not correspond to any user created routes then this field will be the string
	// 'System Route'.
	RouteTableID *string `json:"routeTableId,omitempty"`
}

NextHopResult - The information about next hop from the specified VM.

type NextHopType 

type NextHopType string

NextHopType - Next hop type. 

const (
	NextHopTypeHyperNetGateway       NextHopType = "HyperNetGateway"
	NextHopTypeInternet              NextHopType = "Internet"
	NextHopTypeNone                  NextHopType = "None"
	NextHopTypeVirtualAppliance      NextHopType = "VirtualAppliance"
	NextHopTypeVirtualNetworkGateway NextHopType = "VirtualNetworkGateway"
	NextHopTypeVnetLocal             NextHopType = "VnetLocal"
)

func PossibleNextHopTypeValues 

func PossibleNextHopTypeValues() []NextHopType

PossibleNextHopTypeValues returns the possible values for the NextHopType const type.

func (NextHopType) ToPtr 

func (c NextHopType) ToPtr() *NextHopType

ToPtr returns a *NextHopType pointing to the current value.

type O365BreakOutCategoryPolicies 

type O365BreakOutCategoryPolicies struct {
	// Flag to control allow category.
	Allow *bool `json:"allow,omitempty"`

	// Flag to control default category.
	Default *bool `json:"default,omitempty"`

	// Flag to control optimize category.
	Optimize *bool `json:"optimize,omitempty"`
}

O365BreakOutCategoryPolicies - Office365 breakout categories.

type O365PolicyProperties 

type O365PolicyProperties struct {
	// Office365 breakout categories.
	BreakOutCategories *O365BreakOutCategoryPolicies `json:"breakOutCategories,omitempty"`
}

O365PolicyProperties - The Office365 breakout policy.

type Office365PolicyProperties 

type Office365PolicyProperties struct {
	// Office 365 breakout categories.
	BreakOutCategories *BreakOutCategoryPolicies `json:"breakOutCategories,omitempty"`
}

Office365PolicyProperties - Network Virtual Appliance Sku Properties.

type OfficeTrafficCategory 

type OfficeTrafficCategory string

OfficeTrafficCategory - The office traffic category. 

const (
	OfficeTrafficCategoryAll              OfficeTrafficCategory = "All"
	OfficeTrafficCategoryNone             OfficeTrafficCategory = "None"
	OfficeTrafficCategoryOptimize         OfficeTrafficCategory = "Optimize"
	OfficeTrafficCategoryOptimizeAndAllow OfficeTrafficCategory = "OptimizeAndAllow"
)

func PossibleOfficeTrafficCategoryValues 

func PossibleOfficeTrafficCategoryValues() []OfficeTrafficCategory

PossibleOfficeTrafficCategoryValues returns the possible values for the OfficeTrafficCategory const type.

func (OfficeTrafficCategory) ToPtr 

func (c OfficeTrafficCategory) ToPtr() *OfficeTrafficCategory

ToPtr returns a *OfficeTrafficCategory pointing to the current value.

type Operation 

type Operation struct {
	// Display metadata associated with the operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`

	// Origin of the operation.
	Origin *string `json:"origin,omitempty"`

	// Operation properties format.
	Properties *OperationPropertiesFormat `json:"properties,omitempty"`
}

Operation - Network REST API operation definition.

type OperationDisplay 

type OperationDisplay struct {
	// Description of the operation.
	Description *string `json:"description,omitempty"`

	// Type of the operation: get, read, delete, etc.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Microsoft Network.
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - Display metadata associated with the operation.

type OperationListResult 

type OperationListResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Network operations supported by the Network resource provider.
	Value []*Operation `json:"value,omitempty"`
}

OperationListResult - Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) MarshalJSON 

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationPropertiesFormat 

type OperationPropertiesFormat struct {
	// Specification of the service.
	ServiceSpecification *OperationPropertiesFormatServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationPropertiesFormat - Description of operation properties format.

type OperationPropertiesFormatServiceSpecification 

type OperationPropertiesFormatServiceSpecification struct {
	// Operation log specification.
	LogSpecifications []*LogSpecification `json:"logSpecifications,omitempty"`

	// Operation service specification.
	MetricSpecifications []*MetricSpecification `json:"metricSpecifications,omitempty"`
}

OperationPropertiesFormatServiceSpecification - Specification of the service.

func (OperationPropertiesFormatServiceSpecification) MarshalJSON 

func (o OperationPropertiesFormatServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationPropertiesFormatServiceSpecification.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsClientListOptions) *OperationsClientListPager

List - Lists all of the available Network Rest API operations. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/OperationList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewOperationsClient(cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type OperationsClientListOptions added in v0.3.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListPager added in v0.3.0 

type OperationsClientListPager struct {
	// contains filtered or unexported fields
}

OperationsClientListPager provides operations for iterating over paged responses.

func (*OperationsClientListPager) Err added in v0.3.0 

func (p *OperationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsClientListPager) NextPage added in v0.3.0 

func (p *OperationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsClientListPager) PageResponse added in v0.3.0 

func (p *OperationsClientListPager) PageResponse() OperationsClientListResponse

PageResponse returns the current OperationsClientListResponse page.

type OperationsClientListResponse added in v0.3.0 

type OperationsClientListResponse struct {
	OperationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsClientListResult added in v0.3.0 

type OperationsClientListResult struct {
	OperationListResult
}

OperationsClientListResult contains the result from method OperationsClient.List.

type OrderBy added in v0.2.0 

type OrderBy struct {
	// Describes the actual column name to sort by
	Field *string `json:"field,omitempty"`

	// Describes if results should be in ascending/descending order
	Order *OrderByOrder `json:"order,omitempty"`
}

OrderBy - Describes a column to sort

type OrderByOrder added in v0.2.0 

type OrderByOrder string

OrderByOrder - Describes if results should be in ascending/descending order 

const (
	OrderByOrderAscending  OrderByOrder = "Ascending"
	OrderByOrderDescending OrderByOrder = "Descending"
)

func PossibleOrderByOrderValues added in v0.2.0 

func PossibleOrderByOrderValues() []OrderByOrder

PossibleOrderByOrderValues returns the possible values for the OrderByOrder const type.

func (OrderByOrder) ToPtr added in v0.2.0 

func (c OrderByOrder) ToPtr() *OrderByOrder

ToPtr returns a *OrderByOrder pointing to the current value.

type Origin 

type Origin string

Origin - The origin of the issue. 

const (
	OriginInbound  Origin = "Inbound"
	OriginLocal    Origin = "Local"
	OriginOutbound Origin = "Outbound"
)

func PossibleOriginValues 

func PossibleOriginValues() []Origin

PossibleOriginValues returns the possible values for the Origin const type.

func (Origin) ToPtr 

func (c Origin) ToPtr() *Origin

ToPtr returns a *Origin pointing to the current value.

type OutboundRule 

type OutboundRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used
	// to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of load balancer outbound rule.
	Properties *OutboundRulePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

OutboundRule - Outbound rule of the load balancer.

type OutboundRulePropertiesFormat 

type OutboundRulePropertiesFormat struct {
	// REQUIRED; A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.
	BackendAddressPool *SubResource `json:"backendAddressPool,omitempty"`

	// REQUIRED; The Frontend IP addresses of the load balancer.
	FrontendIPConfigurations []*SubResource `json:"frontendIPConfigurations,omitempty"`

	// REQUIRED; The protocol for the outbound rule in load balancer.
	Protocol *LoadBalancerOutboundRuleProtocol `json:"protocol,omitempty"`

	// The number of outbound ports to be used for NAT.
	AllocatedOutboundPorts *int32 `json:"allocatedOutboundPorts,omitempty"`

	// Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used
	// when the protocol is set to TCP.
	EnableTCPReset *bool `json:"enableTcpReset,omitempty"`

	// The timeout for the TCP idle connection.
	IdleTimeoutInMinutes *int32 `json:"idleTimeoutInMinutes,omitempty"`

	// READ-ONLY; The provisioning state of the outbound rule resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

OutboundRulePropertiesFormat - Outbound rule of the load balancer.

func (OutboundRulePropertiesFormat) MarshalJSON 

func (o OutboundRulePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundRulePropertiesFormat.

type OutputType 

type OutputType string

OutputType - Connection monitor output destination type. Currently, only "Workspace" is supported. 

const (
	OutputTypeWorkspace OutputType = "Workspace"
)

func PossibleOutputTypeValues 

func PossibleOutputTypeValues() []OutputType

PossibleOutputTypeValues returns the possible values for the OutputType const type.

func (OutputType) ToPtr 

func (c OutputType) ToPtr() *OutputType

ToPtr returns a *OutputType pointing to the current value.

type OwaspCrsExclusionEntry 

type OwaspCrsExclusionEntry struct {
	// REQUIRED; The variable to be excluded.
	MatchVariable *OwaspCrsExclusionEntryMatchVariable `json:"matchVariable,omitempty"`

	// REQUIRED; When matchVariable is a collection, operator used to specify which elements in the collection this exclusion
	// applies to.
	Selector *string `json:"selector,omitempty"`

	// REQUIRED; When matchVariable is a collection, operate on the selector to specify which elements in the collection this
	// exclusion applies to.
	SelectorMatchOperator *OwaspCrsExclusionEntrySelectorMatchOperator `json:"selectorMatchOperator,omitempty"`

	// The managed rule sets that are associated with the exclusion.
	ExclusionManagedRuleSets []*ExclusionManagedRuleSet `json:"exclusionManagedRuleSets,omitempty"`
}

OwaspCrsExclusionEntry - Allow to exclude some variable satisfy the condition for the WAF check.

func (OwaspCrsExclusionEntry) MarshalJSON added in v0.2.0 

func (o OwaspCrsExclusionEntry) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OwaspCrsExclusionEntry.

type OwaspCrsExclusionEntryMatchVariable 

type OwaspCrsExclusionEntryMatchVariable string

OwaspCrsExclusionEntryMatchVariable - The variable to be excluded. 

const (
	OwaspCrsExclusionEntryMatchVariableRequestArgKeys      OwaspCrsExclusionEntryMatchVariable = "RequestArgKeys"
	OwaspCrsExclusionEntryMatchVariableRequestArgNames     OwaspCrsExclusionEntryMatchVariable = "RequestArgNames"
	OwaspCrsExclusionEntryMatchVariableRequestArgValues    OwaspCrsExclusionEntryMatchVariable = "RequestArgValues"
	OwaspCrsExclusionEntryMatchVariableRequestCookieKeys   OwaspCrsExclusionEntryMatchVariable = "RequestCookieKeys"
	OwaspCrsExclusionEntryMatchVariableRequestCookieNames  OwaspCrsExclusionEntryMatchVariable = "RequestCookieNames"
	OwaspCrsExclusionEntryMatchVariableRequestCookieValues OwaspCrsExclusionEntryMatchVariable = "RequestCookieValues"
	OwaspCrsExclusionEntryMatchVariableRequestHeaderKeys   OwaspCrsExclusionEntryMatchVariable = "RequestHeaderKeys"
	OwaspCrsExclusionEntryMatchVariableRequestHeaderNames  OwaspCrsExclusionEntryMatchVariable = "RequestHeaderNames"
	OwaspCrsExclusionEntryMatchVariableRequestHeaderValues OwaspCrsExclusionEntryMatchVariable = "RequestHeaderValues"
)

func PossibleOwaspCrsExclusionEntryMatchVariableValues 

func PossibleOwaspCrsExclusionEntryMatchVariableValues() []OwaspCrsExclusionEntryMatchVariable

PossibleOwaspCrsExclusionEntryMatchVariableValues returns the possible values for the OwaspCrsExclusionEntryMatchVariable const type.

func (OwaspCrsExclusionEntryMatchVariable) ToPtr 

func (c OwaspCrsExclusionEntryMatchVariable) ToPtr() *OwaspCrsExclusionEntryMatchVariable

ToPtr returns a *OwaspCrsExclusionEntryMatchVariable pointing to the current value.

type OwaspCrsExclusionEntrySelectorMatchOperator 

type OwaspCrsExclusionEntrySelectorMatchOperator string

OwaspCrsExclusionEntrySelectorMatchOperator - When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. 

const (
	OwaspCrsExclusionEntrySelectorMatchOperatorContains   OwaspCrsExclusionEntrySelectorMatchOperator = "Contains"
	OwaspCrsExclusionEntrySelectorMatchOperatorEndsWith   OwaspCrsExclusionEntrySelectorMatchOperator = "EndsWith"
	OwaspCrsExclusionEntrySelectorMatchOperatorEquals     OwaspCrsExclusionEntrySelectorMatchOperator = "Equals"
	OwaspCrsExclusionEntrySelectorMatchOperatorEqualsAny  OwaspCrsExclusionEntrySelectorMatchOperator = "EqualsAny"
	OwaspCrsExclusionEntrySelectorMatchOperatorStartsWith OwaspCrsExclusionEntrySelectorMatchOperator = "StartsWith"
)

func PossibleOwaspCrsExclusionEntrySelectorMatchOperatorValues 

func PossibleOwaspCrsExclusionEntrySelectorMatchOperatorValues() []OwaspCrsExclusionEntrySelectorMatchOperator

PossibleOwaspCrsExclusionEntrySelectorMatchOperatorValues returns the possible values for the OwaspCrsExclusionEntrySelectorMatchOperator const type.

func (OwaspCrsExclusionEntrySelectorMatchOperator) ToPtr 

func (c OwaspCrsExclusionEntrySelectorMatchOperator) ToPtr() *OwaspCrsExclusionEntrySelectorMatchOperator

ToPtr returns a *OwaspCrsExclusionEntrySelectorMatchOperator pointing to the current value.

type P2SConnectionConfiguration 

type P2SConnectionConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the P2S connection configuration.
	Properties *P2SConnectionConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

P2SConnectionConfiguration Resource.

type P2SConnectionConfigurationProperties 

type P2SConnectionConfigurationProperties struct {
	// Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.
	EnableInternetSecurity *bool `json:"enableInternetSecurity,omitempty"`

	// The Routing Configuration indicating the associated and propagated route tables on this connection.
	RoutingConfiguration *RoutingConfiguration `json:"routingConfiguration,omitempty"`

	// The reference to the address space resource which represents Address space for P2S VpnClient.
	VPNClientAddressPool *AddressSpace `json:"vpnClientAddressPool,omitempty"`

	// READ-ONLY; The provisioning state of the P2SConnectionConfiguration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

P2SConnectionConfigurationProperties - Parameters for P2SConnectionConfiguration.

type P2SVPNConnectionHealth 

type P2SVPNConnectionHealth struct {
	// Returned sas url of the blob to which the p2s vpn connection detailed health will be written.
	SasURL *string `json:"sasUrl,omitempty"`
}

P2SVPNConnectionHealth - P2S Vpn connection detailed health written to sas url.

type P2SVPNConnectionHealthRequest 

type P2SVPNConnectionHealthRequest struct {
	// The sas-url to download the P2S Vpn connection health detail.
	OutputBlobSasURL *string `json:"outputBlobSasUrl,omitempty"`

	// The list of p2s vpn user names whose p2s vpn connection detailed health to retrieve for.
	VPNUserNamesFilter []*string `json:"vpnUserNamesFilter,omitempty"`
}

P2SVPNConnectionHealthRequest - List of P2S Vpn connection health request.

func (P2SVPNConnectionHealthRequest) MarshalJSON 

func (p P2SVPNConnectionHealthRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type P2SVPNConnectionHealthRequest.

type P2SVPNConnectionRequest 

type P2SVPNConnectionRequest struct {
	// List of p2s vpn connection Ids.
	VPNConnectionIDs []*string `json:"vpnConnectionIds,omitempty"`
}

P2SVPNConnectionRequest - List of p2s vpn connections to be disconnected.

func (P2SVPNConnectionRequest) MarshalJSON 

func (p P2SVPNConnectionRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type P2SVPNConnectionRequest.

type P2SVPNGateway 

type P2SVPNGateway struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the P2SVpnGateway.
	Properties *P2SVPNGatewayProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

P2SVPNGateway - P2SVpnGateway Resource.

func (P2SVPNGateway) MarshalJSON 

func (p P2SVPNGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type P2SVPNGateway.

type P2SVPNGatewayProperties 

type P2SVPNGatewayProperties struct {
	// List of all customer specified DNS servers IP addresses.
	CustomDNSServers []*string `json:"customDnsServers,omitempty"`

	// Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
	IsRoutingPreferenceInternet *bool `json:"isRoutingPreferenceInternet,omitempty"`

	// List of all p2s connection configurations of the gateway.
	P2SConnectionConfigurations []*P2SConnectionConfiguration `json:"p2SConnectionConfigurations,omitempty"`

	// The scale unit for this p2s vpn gateway.
	VPNGatewayScaleUnit *int32 `json:"vpnGatewayScaleUnit,omitempty"`

	// The VpnServerConfiguration to which the p2sVpnGateway is attached to.
	VPNServerConfiguration *SubResource `json:"vpnServerConfiguration,omitempty"`

	// The VirtualHub to which the gateway belongs.
	VirtualHub *SubResource `json:"virtualHub,omitempty"`

	// READ-ONLY; The provisioning state of the P2S VPN gateway resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; All P2S VPN clients' connection health status.
	VPNClientConnectionHealth *VPNClientConnectionHealth `json:"vpnClientConnectionHealth,omitempty" azure:"ro"`
}

P2SVPNGatewayProperties - Parameters for P2SVpnGateway.

func (P2SVPNGatewayProperties) MarshalJSON 

func (p P2SVPNGatewayProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type P2SVPNGatewayProperties.

type P2SVPNGatewaysClient 

type P2SVPNGatewaysClient struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClient contains the methods for the P2SVPNGateways group. Don't use this type directly, use NewP2SVPNGatewaysClient() instead.

func NewP2SVPNGatewaysClient 

func NewP2SVPNGatewaysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *P2SVPNGatewaysClient

NewP2SVPNGatewaysClient creates a new instance of P2SVPNGatewaysClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*P2SVPNGatewaysClient) BeginCreateOrUpdate 

func (client *P2SVPNGatewaysClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, gatewayName string, p2SVPNGatewayParameters P2SVPNGateway, options *P2SVPNGatewaysClientBeginCreateOrUpdateOptions) (P2SVPNGatewaysClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the P2SVpnGateway. gatewayName - The name of the gateway. p2SVPNGatewayParameters - Parameters supplied to create or Update a virtual wan p2s vpn gateway. options - P2SVPNGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/P2SVpnGatewayPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewP2SVPNGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		armnetwork.P2SVPNGateway{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.P2SVPNGatewayProperties{
				CustomDNSServers: []*string{
					to.StringPtr("1.1.1.1"),
					to.StringPtr("2.2.2.2")},
				IsRoutingPreferenceInternet: to.BoolPtr(false),
				P2SConnectionConfigurations: []*armnetwork.P2SConnectionConfiguration{
					{
						ID:   to.StringPtr("<id>"),
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.P2SConnectionConfigurationProperties{
							RoutingConfiguration: &armnetwork.RoutingConfiguration{
								AssociatedRouteTable: &armnetwork.SubResource{
									ID: to.StringPtr("<id>"),
								},
								PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
									IDs: []*armnetwork.SubResource{
										{
											ID: to.StringPtr("<id>"),
										},
										{
											ID: to.StringPtr("<id>"),
										},
										{
											ID: to.StringPtr("<id>"),
										}},
									Labels: []*string{
										to.StringPtr("label1"),
										to.StringPtr("label2")},
								},
								VnetRoutes: &armnetwork.VnetRoute{
									StaticRoutes: []*armnetwork.StaticRoute{},
								},
							},
							VPNClientAddressPool: &armnetwork.AddressSpace{
								AddressPrefixes: []*string{
									to.StringPtr("101.3.0.0/16")},
							},
						},
					}},
				VirtualHub: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
				VPNGatewayScaleUnit: to.Int32Ptr(1),
				VPNServerConfiguration: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.P2SVPNGatewaysClientCreateOrUpdateResult)
}

Output:

func (*P2SVPNGatewaysClient) BeginDelete 

func (client *P2SVPNGatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, gatewayName string, options *P2SVPNGatewaysClientBeginDeleteOptions) (P2SVPNGatewaysClientDeletePollerResponse, error)

BeginDelete - Deletes a virtual wan p2s vpn gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the P2SVpnGateway. gatewayName - The name of the gateway. options - P2SVPNGatewaysClientBeginDeleteOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/P2SVpnGatewayDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewP2SVPNGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*P2SVPNGatewaysClient) BeginDisconnectP2SVPNConnections 

func (client *P2SVPNGatewaysClient) BeginDisconnectP2SVPNConnections(ctx context.Context, resourceGroupName string, p2SVPNGatewayName string, request P2SVPNConnectionRequest, options *P2SVPNGatewaysClientBeginDisconnectP2SVPNConnectionsOptions) (P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPollerResponse, error)

BeginDisconnectP2SVPNConnections - Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. p2SVPNGatewayName - The name of the P2S Vpn Gateway. request - The parameters are supplied to disconnect p2s vpn connections. options - P2SVPNGatewaysClientBeginDisconnectP2SVPNConnectionsOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginDisconnectP2SVPNConnections method.

func (*P2SVPNGatewaysClient) BeginGenerateVPNProfile 

func (client *P2SVPNGatewaysClient) BeginGenerateVPNProfile(ctx context.Context, resourceGroupName string, gatewayName string, parameters P2SVPNProfileParameters, options *P2SVPNGatewaysClientBeginGenerateVPNProfileOptions) (P2SVPNGatewaysClientGenerateVPNProfilePollerResponse, error)

BeginGenerateVPNProfile - Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. gatewayName - The name of the P2SVpnGateway. parameters - Parameters supplied to the generate P2SVpnGateway VPN client package operation. options - P2SVPNGatewaysClientBeginGenerateVPNProfileOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginGenerateVPNProfile method.

func (*P2SVPNGatewaysClient) BeginGetP2SVPNConnectionHealth 

func (client *P2SVPNGatewaysClient) BeginGetP2SVPNConnectionHealth(ctx context.Context, resourceGroupName string, gatewayName string, options *P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthOptions) (P2SVPNGatewaysClientGetP2SVPNConnectionHealthPollerResponse, error)

BeginGetP2SVPNConnectionHealth - Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. gatewayName - The name of the P2SVpnGateway. options - P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginGetP2SVPNConnectionHealth method.

func (*P2SVPNGatewaysClient) BeginGetP2SVPNConnectionHealthDetailed 

func (client *P2SVPNGatewaysClient) BeginGetP2SVPNConnectionHealthDetailed(ctx context.Context, resourceGroupName string, gatewayName string, request P2SVPNConnectionHealthRequest, options *P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthDetailedOptions) (P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPollerResponse, error)

BeginGetP2SVPNConnectionHealthDetailed - Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. gatewayName - The name of the P2SVpnGateway. request - Request parameters supplied to get p2s vpn connections detailed health. options - P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthDetailedOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginGetP2SVPNConnectionHealthDetailed method.

func (*P2SVPNGatewaysClient) BeginReset 

func (client *P2SVPNGatewaysClient) BeginReset(ctx context.Context, resourceGroupName string, gatewayName string, options *P2SVPNGatewaysClientBeginResetOptions) (P2SVPNGatewaysClientResetPollerResponse, error)

BeginReset - Resets the primary of the p2s vpn gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the P2SVpnGateway. gatewayName - The name of the gateway. options - P2SVPNGatewaysClientBeginResetOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginReset method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/P2SVpnGatewayReset.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewP2SVPNGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginReset(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.P2SVPNGatewaysClientResetResult)
}

Output:

func (*P2SVPNGatewaysClient) BeginUpdateTags 

func (client *P2SVPNGatewaysClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, gatewayName string, p2SVPNGatewayParameters TagsObject, options *P2SVPNGatewaysClientBeginUpdateTagsOptions) (P2SVPNGatewaysClientUpdateTagsPollerResponse, error)

BeginUpdateTags - Updates virtual wan p2s vpn gateway tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the P2SVpnGateway. gatewayName - The name of the gateway. p2SVPNGatewayParameters - Parameters supplied to update a virtual wan p2s vpn gateway tags. options - P2SVPNGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginUpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/P2SVpnGatewayUpdateTags.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewP2SVPNGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdateTags(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.P2SVPNGatewaysClientUpdateTagsResult)
}

Output:

func (*P2SVPNGatewaysClient) Get 

func (client *P2SVPNGatewaysClient) Get(ctx context.Context, resourceGroupName string, gatewayName string, options *P2SVPNGatewaysClientGetOptions) (P2SVPNGatewaysClientGetResponse, error)

Get - Retrieves the details of a virtual wan p2s vpn gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the P2SVpnGateway. gatewayName - The name of the gateway. options - P2SVPNGatewaysClientGetOptions contains the optional parameters for the P2SVPNGatewaysClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/P2SVpnGatewayGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewP2SVPNGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.P2SVPNGatewaysClientGetResult)
}

Output:

func (*P2SVPNGatewaysClient) List 

func (client *P2SVPNGatewaysClient) List(options *P2SVPNGatewaysClientListOptions) *P2SVPNGatewaysClientListPager

List - Lists all the P2SVpnGateways in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - P2SVPNGatewaysClientListOptions contains the optional parameters for the P2SVPNGatewaysClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/P2SVpnGatewayList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewP2SVPNGatewaysClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*P2SVPNGatewaysClient) ListByResourceGroup 

func (client *P2SVPNGatewaysClient) ListByResourceGroup(resourceGroupName string, options *P2SVPNGatewaysClientListByResourceGroupOptions) *P2SVPNGatewaysClientListByResourceGroupPager

ListByResourceGroup - Lists all the P2SVpnGateways in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the P2SVpnGateway. options - P2SVPNGatewaysClientListByResourceGroupOptions contains the optional parameters for the P2SVPNGatewaysClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/P2SVpnGatewayListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewP2SVPNGatewaysClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type P2SVPNGatewaysClientBeginCreateOrUpdateOptions added in v0.3.0 

type P2SVPNGatewaysClientBeginCreateOrUpdateOptions struct {
}

P2SVPNGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginCreateOrUpdate method.

type P2SVPNGatewaysClientBeginDeleteOptions added in v0.3.0 

type P2SVPNGatewaysClientBeginDeleteOptions struct {
}

P2SVPNGatewaysClientBeginDeleteOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginDelete method.

type P2SVPNGatewaysClientBeginDisconnectP2SVPNConnectionsOptions added in v0.3.0 

type P2SVPNGatewaysClientBeginDisconnectP2SVPNConnectionsOptions struct {
}

P2SVPNGatewaysClientBeginDisconnectP2SVPNConnectionsOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginDisconnectP2SVPNConnections method.

type P2SVPNGatewaysClientBeginGenerateVPNProfileOptions added in v0.3.0 

type P2SVPNGatewaysClientBeginGenerateVPNProfileOptions struct {
}

P2SVPNGatewaysClientBeginGenerateVPNProfileOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginGenerateVPNProfile method.

type P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthDetailedOptions added in v0.3.0 

type P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthDetailedOptions struct {
}

P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthDetailedOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginGetP2SVPNConnectionHealthDetailed method.

type P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthOptions added in v0.3.0 

type P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthOptions struct {
}

P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginGetP2SVPNConnectionHealth method.

type P2SVPNGatewaysClientBeginResetOptions added in v0.3.0 

type P2SVPNGatewaysClientBeginResetOptions struct {
}

P2SVPNGatewaysClientBeginResetOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginReset method.

type P2SVPNGatewaysClientBeginUpdateTagsOptions added in v0.3.0 

type P2SVPNGatewaysClientBeginUpdateTagsOptions struct {
}

P2SVPNGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginUpdateTags method.

type P2SVPNGatewaysClientCreateOrUpdatePoller added in v0.3.0 

type P2SVPNGatewaysClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*P2SVPNGatewaysClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *P2SVPNGatewaysClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*P2SVPNGatewaysClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *P2SVPNGatewaysClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (P2SVPNGatewaysClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final P2SVPNGatewaysClientCreateOrUpdateResponse will be returned.

func (*P2SVPNGatewaysClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *P2SVPNGatewaysClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*P2SVPNGatewaysClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *P2SVPNGatewaysClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type P2SVPNGatewaysClientCreateOrUpdatePollerResponse added in v0.3.0 

type P2SVPNGatewaysClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *P2SVPNGatewaysClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientCreateOrUpdatePollerResponse contains the response from method P2SVPNGatewaysClient.CreateOrUpdate.

func (P2SVPNGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l P2SVPNGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (P2SVPNGatewaysClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*P2SVPNGatewaysClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *P2SVPNGatewaysClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *P2SVPNGatewaysClient, token string) error

Resume rehydrates a P2SVPNGatewaysClientCreateOrUpdatePollerResponse from the provided client and resume token.

type P2SVPNGatewaysClientCreateOrUpdateResponse added in v0.3.0 

type P2SVPNGatewaysClientCreateOrUpdateResponse struct {
	P2SVPNGatewaysClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientCreateOrUpdateResponse contains the response from method P2SVPNGatewaysClient.CreateOrUpdate.

type P2SVPNGatewaysClientCreateOrUpdateResult added in v0.3.0 

type P2SVPNGatewaysClientCreateOrUpdateResult struct {
	P2SVPNGateway
}

P2SVPNGatewaysClientCreateOrUpdateResult contains the result from method P2SVPNGatewaysClient.CreateOrUpdate.

type P2SVPNGatewaysClientDeletePoller added in v0.3.0 

type P2SVPNGatewaysClientDeletePoller struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*P2SVPNGatewaysClientDeletePoller) Done added in v0.3.0 

func (p *P2SVPNGatewaysClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*P2SVPNGatewaysClientDeletePoller) FinalResponse added in v0.3.0 

func (p *P2SVPNGatewaysClientDeletePoller) FinalResponse(ctx context.Context) (P2SVPNGatewaysClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final P2SVPNGatewaysClientDeleteResponse will be returned.

func (*P2SVPNGatewaysClientDeletePoller) Poll added in v0.3.0 

func (p *P2SVPNGatewaysClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*P2SVPNGatewaysClientDeletePoller) ResumeToken added in v0.3.0 

func (p *P2SVPNGatewaysClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type P2SVPNGatewaysClientDeletePollerResponse added in v0.3.0 

type P2SVPNGatewaysClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *P2SVPNGatewaysClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientDeletePollerResponse contains the response from method P2SVPNGatewaysClient.Delete.

func (P2SVPNGatewaysClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l P2SVPNGatewaysClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (P2SVPNGatewaysClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*P2SVPNGatewaysClientDeletePollerResponse) Resume added in v0.3.0 

func (l *P2SVPNGatewaysClientDeletePollerResponse) Resume(ctx context.Context, client *P2SVPNGatewaysClient, token string) error

Resume rehydrates a P2SVPNGatewaysClientDeletePollerResponse from the provided client and resume token.

type P2SVPNGatewaysClientDeleteResponse added in v0.3.0 

type P2SVPNGatewaysClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientDeleteResponse contains the response from method P2SVPNGatewaysClient.Delete.

type P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller added in v0.3.0 

type P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller provides polling facilities until the operation reaches a terminal state.

func (*P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller) Done added in v0.3.0 

func (p *P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller) FinalResponse added in v0.3.0 

func (p *P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller) FinalResponse(ctx context.Context) (P2SVPNGatewaysClientDisconnectP2SVPNConnectionsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final P2SVPNGatewaysClientDisconnectP2SVPNConnectionsResponse will be returned.

func (*P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller) Poll added in v0.3.0 

func (p *P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller) ResumeToken added in v0.3.0 

func (p *P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPollerResponse added in v0.3.0 

type P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPollerResponse contains the response from method P2SVPNGatewaysClient.DisconnectP2SVPNConnections.

func (P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPollerResponse) PollUntilDone added in v0.3.0 

func (l P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (P2SVPNGatewaysClientDisconnectP2SVPNConnectionsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPollerResponse) Resume added in v0.3.0 

func (l *P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPollerResponse) Resume(ctx context.Context, client *P2SVPNGatewaysClient, token string) error

Resume rehydrates a P2SVPNGatewaysClientDisconnectP2SVPNConnectionsPollerResponse from the provided client and resume token.

type P2SVPNGatewaysClientDisconnectP2SVPNConnectionsResponse added in v0.3.0 

type P2SVPNGatewaysClientDisconnectP2SVPNConnectionsResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientDisconnectP2SVPNConnectionsResponse contains the response from method P2SVPNGatewaysClient.DisconnectP2SVPNConnections.

type P2SVPNGatewaysClientGenerateVPNProfilePoller added in v0.3.0 

type P2SVPNGatewaysClientGenerateVPNProfilePoller struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClientGenerateVPNProfilePoller provides polling facilities until the operation reaches a terminal state.

func (*P2SVPNGatewaysClientGenerateVPNProfilePoller) Done added in v0.3.0 

func (p *P2SVPNGatewaysClientGenerateVPNProfilePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*P2SVPNGatewaysClientGenerateVPNProfilePoller) FinalResponse added in v0.3.0 

func (p *P2SVPNGatewaysClientGenerateVPNProfilePoller) FinalResponse(ctx context.Context) (P2SVPNGatewaysClientGenerateVPNProfileResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final P2SVPNGatewaysClientGenerateVPNProfileResponse will be returned.

func (*P2SVPNGatewaysClientGenerateVPNProfilePoller) Poll added in v0.3.0 

func (p *P2SVPNGatewaysClientGenerateVPNProfilePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*P2SVPNGatewaysClientGenerateVPNProfilePoller) ResumeToken added in v0.3.0 

func (p *P2SVPNGatewaysClientGenerateVPNProfilePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type P2SVPNGatewaysClientGenerateVPNProfilePollerResponse added in v0.3.0 

type P2SVPNGatewaysClientGenerateVPNProfilePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *P2SVPNGatewaysClientGenerateVPNProfilePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientGenerateVPNProfilePollerResponse contains the response from method P2SVPNGatewaysClient.GenerateVPNProfile.

func (P2SVPNGatewaysClientGenerateVPNProfilePollerResponse) PollUntilDone added in v0.3.0 

func (l P2SVPNGatewaysClientGenerateVPNProfilePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (P2SVPNGatewaysClientGenerateVPNProfileResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*P2SVPNGatewaysClientGenerateVPNProfilePollerResponse) Resume added in v0.3.0 

func (l *P2SVPNGatewaysClientGenerateVPNProfilePollerResponse) Resume(ctx context.Context, client *P2SVPNGatewaysClient, token string) error

Resume rehydrates a P2SVPNGatewaysClientGenerateVPNProfilePollerResponse from the provided client and resume token.

type P2SVPNGatewaysClientGenerateVPNProfileResponse added in v0.3.0 

type P2SVPNGatewaysClientGenerateVPNProfileResponse struct {
	P2SVPNGatewaysClientGenerateVPNProfileResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientGenerateVPNProfileResponse contains the response from method P2SVPNGatewaysClient.GenerateVPNProfile.

type P2SVPNGatewaysClientGenerateVPNProfileResult added in v0.3.0 

type P2SVPNGatewaysClientGenerateVPNProfileResult struct {
	VPNProfileResponse
}

P2SVPNGatewaysClientGenerateVPNProfileResult contains the result from method P2SVPNGatewaysClient.GenerateVPNProfile.

type P2SVPNGatewaysClientGetOptions added in v0.3.0 

type P2SVPNGatewaysClientGetOptions struct {
}

P2SVPNGatewaysClientGetOptions contains the optional parameters for the P2SVPNGatewaysClient.Get method.

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller added in v0.3.0 

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller provides polling facilities until the operation reaches a terminal state.

func (*P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller) Done added in v0.3.0 

func (p *P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller) FinalResponse added in v0.3.0 

func (p *P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller) FinalResponse(ctx context.Context) (P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResponse will be returned.

func (*P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller) Poll added in v0.3.0 

func (p *P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller) ResumeToken added in v0.3.0 

func (p *P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPollerResponse added in v0.3.0 

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPollerResponse contains the response from method P2SVPNGatewaysClient.GetP2SVPNConnectionHealthDetailed.

func (P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPollerResponse) PollUntilDone added in v0.3.0 

func (l P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPollerResponse) Resume added in v0.3.0 

func (l *P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPollerResponse) Resume(ctx context.Context, client *P2SVPNGatewaysClient, token string) error

Resume rehydrates a P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedPollerResponse from the provided client and resume token.

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResponse added in v0.3.0 

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResponse struct {
	P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResponse contains the response from method P2SVPNGatewaysClient.GetP2SVPNConnectionHealthDetailed.

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResult added in v0.3.0 

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResult struct {
	P2SVPNConnectionHealth
}

P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResult contains the result from method P2SVPNGatewaysClient.GetP2SVPNConnectionHealthDetailed.

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller added in v0.3.0 

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller provides polling facilities until the operation reaches a terminal state.

func (*P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller) Done added in v0.3.0 

func (p *P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller) FinalResponse added in v0.3.0 

func (p *P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller) FinalResponse(ctx context.Context) (P2SVPNGatewaysClientGetP2SVPNConnectionHealthResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final P2SVPNGatewaysClientGetP2SVPNConnectionHealthResponse will be returned.

func (*P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller) Poll added in v0.3.0 

func (p *P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller) ResumeToken added in v0.3.0 

func (p *P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthPollerResponse added in v0.3.0 

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *P2SVPNGatewaysClientGetP2SVPNConnectionHealthPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientGetP2SVPNConnectionHealthPollerResponse contains the response from method P2SVPNGatewaysClient.GetP2SVPNConnectionHealth.

func (P2SVPNGatewaysClientGetP2SVPNConnectionHealthPollerResponse) PollUntilDone added in v0.3.0 

func (l P2SVPNGatewaysClientGetP2SVPNConnectionHealthPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (P2SVPNGatewaysClientGetP2SVPNConnectionHealthResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*P2SVPNGatewaysClientGetP2SVPNConnectionHealthPollerResponse) Resume added in v0.3.0 

func (l *P2SVPNGatewaysClientGetP2SVPNConnectionHealthPollerResponse) Resume(ctx context.Context, client *P2SVPNGatewaysClient, token string) error

Resume rehydrates a P2SVPNGatewaysClientGetP2SVPNConnectionHealthPollerResponse from the provided client and resume token.

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthResponse added in v0.3.0 

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthResponse struct {
	P2SVPNGatewaysClientGetP2SVPNConnectionHealthResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientGetP2SVPNConnectionHealthResponse contains the response from method P2SVPNGatewaysClient.GetP2SVPNConnectionHealth.

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthResult added in v0.3.0 

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthResult struct {
	P2SVPNGateway
}

P2SVPNGatewaysClientGetP2SVPNConnectionHealthResult contains the result from method P2SVPNGatewaysClient.GetP2SVPNConnectionHealth.

type P2SVPNGatewaysClientGetResponse added in v0.3.0 

type P2SVPNGatewaysClientGetResponse struct {
	P2SVPNGatewaysClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientGetResponse contains the response from method P2SVPNGatewaysClient.Get.

type P2SVPNGatewaysClientGetResult added in v0.3.0 

type P2SVPNGatewaysClientGetResult struct {
	P2SVPNGateway
}

P2SVPNGatewaysClientGetResult contains the result from method P2SVPNGatewaysClient.Get.

type P2SVPNGatewaysClientListByResourceGroupOptions added in v0.3.0 

type P2SVPNGatewaysClientListByResourceGroupOptions struct {
}

P2SVPNGatewaysClientListByResourceGroupOptions contains the optional parameters for the P2SVPNGatewaysClient.ListByResourceGroup method.

type P2SVPNGatewaysClientListByResourceGroupPager added in v0.3.0 

type P2SVPNGatewaysClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*P2SVPNGatewaysClientListByResourceGroupPager) Err added in v0.3.0 

func (p *P2SVPNGatewaysClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*P2SVPNGatewaysClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *P2SVPNGatewaysClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*P2SVPNGatewaysClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *P2SVPNGatewaysClientListByResourceGroupPager) PageResponse() P2SVPNGatewaysClientListByResourceGroupResponse

PageResponse returns the current P2SVPNGatewaysClientListByResourceGroupResponse page.

type P2SVPNGatewaysClientListByResourceGroupResponse added in v0.3.0 

type P2SVPNGatewaysClientListByResourceGroupResponse struct {
	P2SVPNGatewaysClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientListByResourceGroupResponse contains the response from method P2SVPNGatewaysClient.ListByResourceGroup.

type P2SVPNGatewaysClientListByResourceGroupResult added in v0.3.0 

type P2SVPNGatewaysClientListByResourceGroupResult struct {
	ListP2SVPNGatewaysResult
}

P2SVPNGatewaysClientListByResourceGroupResult contains the result from method P2SVPNGatewaysClient.ListByResourceGroup.

type P2SVPNGatewaysClientListOptions added in v0.3.0 

type P2SVPNGatewaysClientListOptions struct {
}

P2SVPNGatewaysClientListOptions contains the optional parameters for the P2SVPNGatewaysClient.List method.

type P2SVPNGatewaysClientListPager added in v0.3.0 

type P2SVPNGatewaysClientListPager struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClientListPager provides operations for iterating over paged responses.

func (*P2SVPNGatewaysClientListPager) Err added in v0.3.0 

func (p *P2SVPNGatewaysClientListPager) Err() error

Err returns the last error encountered while paging.

func (*P2SVPNGatewaysClientListPager) NextPage added in v0.3.0 

func (p *P2SVPNGatewaysClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*P2SVPNGatewaysClientListPager) PageResponse added in v0.3.0 

func (p *P2SVPNGatewaysClientListPager) PageResponse() P2SVPNGatewaysClientListResponse

PageResponse returns the current P2SVPNGatewaysClientListResponse page.

type P2SVPNGatewaysClientListResponse added in v0.3.0 

type P2SVPNGatewaysClientListResponse struct {
	P2SVPNGatewaysClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientListResponse contains the response from method P2SVPNGatewaysClient.List.

type P2SVPNGatewaysClientListResult added in v0.3.0 

type P2SVPNGatewaysClientListResult struct {
	ListP2SVPNGatewaysResult
}

P2SVPNGatewaysClientListResult contains the result from method P2SVPNGatewaysClient.List.

type P2SVPNGatewaysClientResetPoller added in v0.3.0 

type P2SVPNGatewaysClientResetPoller struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClientResetPoller provides polling facilities until the operation reaches a terminal state.

func (*P2SVPNGatewaysClientResetPoller) Done added in v0.3.0 

func (p *P2SVPNGatewaysClientResetPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*P2SVPNGatewaysClientResetPoller) FinalResponse added in v0.3.0 

func (p *P2SVPNGatewaysClientResetPoller) FinalResponse(ctx context.Context) (P2SVPNGatewaysClientResetResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final P2SVPNGatewaysClientResetResponse will be returned.

func (*P2SVPNGatewaysClientResetPoller) Poll added in v0.3.0 

func (p *P2SVPNGatewaysClientResetPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*P2SVPNGatewaysClientResetPoller) ResumeToken added in v0.3.0 

func (p *P2SVPNGatewaysClientResetPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type P2SVPNGatewaysClientResetPollerResponse added in v0.3.0 

type P2SVPNGatewaysClientResetPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *P2SVPNGatewaysClientResetPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientResetPollerResponse contains the response from method P2SVPNGatewaysClient.Reset.

func (P2SVPNGatewaysClientResetPollerResponse) PollUntilDone added in v0.3.0 

func (l P2SVPNGatewaysClientResetPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (P2SVPNGatewaysClientResetResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*P2SVPNGatewaysClientResetPollerResponse) Resume added in v0.3.0 

func (l *P2SVPNGatewaysClientResetPollerResponse) Resume(ctx context.Context, client *P2SVPNGatewaysClient, token string) error

Resume rehydrates a P2SVPNGatewaysClientResetPollerResponse from the provided client and resume token.

type P2SVPNGatewaysClientResetResponse added in v0.3.0 

type P2SVPNGatewaysClientResetResponse struct {
	P2SVPNGatewaysClientResetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientResetResponse contains the response from method P2SVPNGatewaysClient.Reset.

type P2SVPNGatewaysClientResetResult added in v0.3.0 

type P2SVPNGatewaysClientResetResult struct {
	P2SVPNGateway
}

P2SVPNGatewaysClientResetResult contains the result from method P2SVPNGatewaysClient.Reset.

type P2SVPNGatewaysClientUpdateTagsPoller added in v0.3.0 

type P2SVPNGatewaysClientUpdateTagsPoller struct {
	// contains filtered or unexported fields
}

P2SVPNGatewaysClientUpdateTagsPoller provides polling facilities until the operation reaches a terminal state.

func (*P2SVPNGatewaysClientUpdateTagsPoller) Done added in v0.3.0 

func (p *P2SVPNGatewaysClientUpdateTagsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*P2SVPNGatewaysClientUpdateTagsPoller) FinalResponse added in v0.3.0 

func (p *P2SVPNGatewaysClientUpdateTagsPoller) FinalResponse(ctx context.Context) (P2SVPNGatewaysClientUpdateTagsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final P2SVPNGatewaysClientUpdateTagsResponse will be returned.

func (*P2SVPNGatewaysClientUpdateTagsPoller) Poll added in v0.3.0 

func (p *P2SVPNGatewaysClientUpdateTagsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*P2SVPNGatewaysClientUpdateTagsPoller) ResumeToken added in v0.3.0 

func (p *P2SVPNGatewaysClientUpdateTagsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type P2SVPNGatewaysClientUpdateTagsPollerResponse added in v0.3.0 

type P2SVPNGatewaysClientUpdateTagsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *P2SVPNGatewaysClientUpdateTagsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientUpdateTagsPollerResponse contains the response from method P2SVPNGatewaysClient.UpdateTags.

func (P2SVPNGatewaysClientUpdateTagsPollerResponse) PollUntilDone added in v0.3.0 

func (l P2SVPNGatewaysClientUpdateTagsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (P2SVPNGatewaysClientUpdateTagsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*P2SVPNGatewaysClientUpdateTagsPollerResponse) Resume added in v0.3.0 

func (l *P2SVPNGatewaysClientUpdateTagsPollerResponse) Resume(ctx context.Context, client *P2SVPNGatewaysClient, token string) error

Resume rehydrates a P2SVPNGatewaysClientUpdateTagsPollerResponse from the provided client and resume token.

type P2SVPNGatewaysClientUpdateTagsResponse added in v0.3.0 

type P2SVPNGatewaysClientUpdateTagsResponse struct {
	P2SVPNGatewaysClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

P2SVPNGatewaysClientUpdateTagsResponse contains the response from method P2SVPNGatewaysClient.UpdateTags.

type P2SVPNGatewaysClientUpdateTagsResult added in v0.3.0 

type P2SVPNGatewaysClientUpdateTagsResult struct {
	P2SVPNGateway
}

P2SVPNGatewaysClientUpdateTagsResult contains the result from method P2SVPNGatewaysClient.UpdateTags.

type P2SVPNProfileParameters 

type P2SVPNProfileParameters struct {
	// VPN client authentication method.
	AuthenticationMethod *AuthenticationMethod `json:"authenticationMethod,omitempty"`
}

P2SVPNProfileParameters - Vpn Client Parameters for package generation.

type PacketCapture 

type PacketCapture struct {
	// REQUIRED; Properties of the packet capture.
	Properties *PacketCaptureParameters `json:"properties,omitempty"`
}

PacketCapture - Parameters that define the create packet capture operation.

type PacketCaptureFilter 

type PacketCaptureFilter struct {
	// Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range.
	// "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently
	// supported. Mixing ranges with multiple entries not currently supported. Default = null.
	LocalIPAddress *string `json:"localIPAddress,omitempty"`

	// Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple
	// ranges not currently supported. Mixing ranges with multiple entries not
	// currently supported. Default = null.
	LocalPort *string `json:"localPort,omitempty"`

	// Protocol to be filtered on.
	Protocol *PcProtocol `json:"protocol,omitempty"`

	// Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range.
	// "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently
	// supported. Mixing ranges with multiple entries not currently supported. Default = null.
	RemoteIPAddress *string `json:"remoteIPAddress,omitempty"`

	// Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries.
	// Multiple ranges not currently supported. Mixing ranges with multiple entries not
	// currently supported. Default = null.
	RemotePort *string `json:"remotePort,omitempty"`
}

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

type PacketCaptureListResult 

type PacketCaptureListResult struct {
	// Information about packet capture sessions.
	Value []*PacketCaptureResult `json:"value,omitempty"`
}

PacketCaptureListResult - List of packet capture sessions.

func (PacketCaptureListResult) MarshalJSON 

func (p PacketCaptureListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCaptureListResult.

type PacketCaptureParameters 

type PacketCaptureParameters struct {
	// REQUIRED; The storage location for a packet capture session.
	StorageLocation *PacketCaptureStorageLocation `json:"storageLocation,omitempty"`

	// REQUIRED; The ID of the targeted resource, only VM is currently supported.
	Target *string `json:"target,omitempty"`

	// Number of bytes captured per packet, the remaining bytes are truncated.
	BytesToCapturePerPacket *int64 `json:"bytesToCapturePerPacket,omitempty"`

	// A list of packet capture filters.
	Filters []*PacketCaptureFilter `json:"filters,omitempty"`

	// Maximum duration of the capture session in seconds.
	TimeLimitInSeconds *int32 `json:"timeLimitInSeconds,omitempty"`

	// Maximum size of the capture output.
	TotalBytesPerSession *int64 `json:"totalBytesPerSession,omitempty"`
}

PacketCaptureParameters - Parameters that define the create packet capture operation.

func (PacketCaptureParameters) MarshalJSON 

func (p PacketCaptureParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCaptureParameters.

type PacketCaptureQueryStatusResult 

type PacketCaptureQueryStatusResult struct {
	// The start time of the packet capture session.
	CaptureStartTime *time.Time `json:"captureStartTime,omitempty"`

	// The ID of the packet capture resource.
	ID *string `json:"id,omitempty"`

	// The name of the packet capture resource.
	Name *string `json:"name,omitempty"`

	// List of errors of packet capture session.
	PacketCaptureError []*PcError `json:"packetCaptureError,omitempty"`

	// The status of the packet capture session.
	PacketCaptureStatus *PcStatus `json:"packetCaptureStatus,omitempty"`

	// The reason the current packet capture session was stopped.
	StopReason *string `json:"stopReason,omitempty"`
}

PacketCaptureQueryStatusResult - Status of packet capture session.

func (PacketCaptureQueryStatusResult) MarshalJSON 

func (p PacketCaptureQueryStatusResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCaptureQueryStatusResult.

func (*PacketCaptureQueryStatusResult) UnmarshalJSON 

func (p *PacketCaptureQueryStatusResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCaptureQueryStatusResult.

type PacketCaptureResult 

type PacketCaptureResult struct {
	// Properties of the packet capture result.
	Properties *PacketCaptureResultProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; ID of the packet capture operation.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the packet capture session.
	Name *string `json:"name,omitempty" azure:"ro"`
}

PacketCaptureResult - Information about packet capture session.

type PacketCaptureResultProperties 

type PacketCaptureResultProperties struct {
	// REQUIRED; The storage location for a packet capture session.
	StorageLocation *PacketCaptureStorageLocation `json:"storageLocation,omitempty"`

	// REQUIRED; The ID of the targeted resource, only VM is currently supported.
	Target *string `json:"target,omitempty"`

	// Number of bytes captured per packet, the remaining bytes are truncated.
	BytesToCapturePerPacket *int64 `json:"bytesToCapturePerPacket,omitempty"`

	// A list of packet capture filters.
	Filters []*PacketCaptureFilter `json:"filters,omitempty"`

	// Maximum duration of the capture session in seconds.
	TimeLimitInSeconds *int32 `json:"timeLimitInSeconds,omitempty"`

	// Maximum size of the capture output.
	TotalBytesPerSession *int64 `json:"totalBytesPerSession,omitempty"`

	// READ-ONLY; The provisioning state of the packet capture session.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PacketCaptureResultProperties - The properties of a packet capture session.

func (PacketCaptureResultProperties) MarshalJSON 

func (p PacketCaptureResultProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCaptureResultProperties.

type PacketCaptureStorageLocation 

type PacketCaptureStorageLocation struct {
	// A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it
	// must start with /var/captures. Required if no storage ID is provided, otherwise
	// optional.
	FilePath *string `json:"filePath,omitempty"`

	// The ID of the storage account to save the packet capture session. Required if no local file path is provided.
	StorageID *string `json:"storageId,omitempty"`

	// The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet
	// capture.
	StoragePath *string `json:"storagePath,omitempty"`
}

PacketCaptureStorageLocation - The storage location for a packet capture session.

type PacketCapturesClient 

type PacketCapturesClient struct {
	// contains filtered or unexported fields
}

PacketCapturesClient contains the methods for the PacketCaptures group. Don't use this type directly, use NewPacketCapturesClient() instead.

func NewPacketCapturesClient 

func NewPacketCapturesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PacketCapturesClient

NewPacketCapturesClient creates a new instance of PacketCapturesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PacketCapturesClient) BeginCreate 

func (client *PacketCapturesClient) BeginCreate(ctx context.Context, resourceGroupName string, networkWatcherName string, packetCaptureName string, parameters PacketCapture, options *PacketCapturesClientBeginCreateOptions) (PacketCapturesClientCreatePollerResponse, error)

BeginCreate - Create and start a packet capture on the specified VM. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. packetCaptureName - The name of the packet capture session. parameters - Parameters that define the create packet capture operation. options - PacketCapturesClientBeginCreateOptions contains the optional parameters for the PacketCapturesClient.BeginCreate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherPacketCaptureCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPacketCapturesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<packet-capture-name>",
		armnetwork.PacketCapture{
			Properties: &armnetwork.PacketCaptureParameters{
				BytesToCapturePerPacket: to.Int64Ptr(10000),
				Filters: []*armnetwork.PacketCaptureFilter{
					{
						LocalIPAddress: to.StringPtr("<local-ipaddress>"),
						LocalPort:      to.StringPtr("<local-port>"),
						Protocol:       armnetwork.PcProtocol("TCP").ToPtr(),
					}},
				StorageLocation: &armnetwork.PacketCaptureStorageLocation{
					FilePath:    to.StringPtr("<file-path>"),
					StorageID:   to.StringPtr("<storage-id>"),
					StoragePath: to.StringPtr("<storage-path>"),
				},
				Target:               to.StringPtr("<target>"),
				TimeLimitInSeconds:   to.Int32Ptr(100),
				TotalBytesPerSession: to.Int64Ptr(100000),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PacketCapturesClient) BeginDelete 

func (client *PacketCapturesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkWatcherName string, packetCaptureName string, options *PacketCapturesClientBeginDeleteOptions) (PacketCapturesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified packet capture session. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. packetCaptureName - The name of the packet capture session. options - PacketCapturesClientBeginDeleteOptions contains the optional parameters for the PacketCapturesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherPacketCaptureDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPacketCapturesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<packet-capture-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PacketCapturesClient) BeginGetStatus 

func (client *PacketCapturesClient) BeginGetStatus(ctx context.Context, resourceGroupName string, networkWatcherName string, packetCaptureName string, options *PacketCapturesClientBeginGetStatusOptions) (PacketCapturesClientGetStatusPollerResponse, error)

BeginGetStatus - Query the status of a running packet capture session. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the Network Watcher resource. packetCaptureName - The name given to the packet capture session. options - PacketCapturesClientBeginGetStatusOptions contains the optional parameters for the PacketCapturesClient.BeginGetStatus method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherPacketCaptureQueryStatus.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPacketCapturesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetStatus(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<packet-capture-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PacketCapturesClientGetStatusResult)
}

Output:

func (*PacketCapturesClient) BeginStop 

func (client *PacketCapturesClient) BeginStop(ctx context.Context, resourceGroupName string, networkWatcherName string, packetCaptureName string, options *PacketCapturesClientBeginStopOptions) (PacketCapturesClientStopPollerResponse, error)

BeginStop - Stops a specified packet capture session. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. packetCaptureName - The name of the packet capture session. options - PacketCapturesClientBeginStopOptions contains the optional parameters for the PacketCapturesClient.BeginStop method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherPacketCaptureStop.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPacketCapturesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStop(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<packet-capture-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PacketCapturesClient) Get 

func (client *PacketCapturesClient) Get(ctx context.Context, resourceGroupName string, networkWatcherName string, packetCaptureName string, options *PacketCapturesClientGetOptions) (PacketCapturesClientGetResponse, error)

Get - Gets a packet capture session by name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. packetCaptureName - The name of the packet capture session. options - PacketCapturesClientGetOptions contains the optional parameters for the PacketCapturesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherPacketCaptureGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPacketCapturesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		"<packet-capture-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PacketCapturesClientGetResult)
}

Output:

func (*PacketCapturesClient) List 

func (client *PacketCapturesClient) List(ctx context.Context, resourceGroupName string, networkWatcherName string, options *PacketCapturesClientListOptions) (PacketCapturesClientListResponse, error)

List - Lists all packet capture sessions within the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the Network Watcher resource. options - PacketCapturesClientListOptions contains the optional parameters for the PacketCapturesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherPacketCapturesList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPacketCapturesClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PacketCapturesClientListResult)
}

Output:

type PacketCapturesClientBeginCreateOptions added in v0.3.0 

type PacketCapturesClientBeginCreateOptions struct {
}

PacketCapturesClientBeginCreateOptions contains the optional parameters for the PacketCapturesClient.BeginCreate method.

type PacketCapturesClientBeginDeleteOptions added in v0.3.0 

type PacketCapturesClientBeginDeleteOptions struct {
}

PacketCapturesClientBeginDeleteOptions contains the optional parameters for the PacketCapturesClient.BeginDelete method.

type PacketCapturesClientBeginGetStatusOptions added in v0.3.0 

type PacketCapturesClientBeginGetStatusOptions struct {
}

PacketCapturesClientBeginGetStatusOptions contains the optional parameters for the PacketCapturesClient.BeginGetStatus method.

type PacketCapturesClientBeginStopOptions added in v0.3.0 

type PacketCapturesClientBeginStopOptions struct {
}

PacketCapturesClientBeginStopOptions contains the optional parameters for the PacketCapturesClient.BeginStop method.

type PacketCapturesClientCreatePoller added in v0.3.0 

type PacketCapturesClientCreatePoller struct {
	// contains filtered or unexported fields
}

PacketCapturesClientCreatePoller provides polling facilities until the operation reaches a terminal state.

func (*PacketCapturesClientCreatePoller) Done added in v0.3.0 

func (p *PacketCapturesClientCreatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PacketCapturesClientCreatePoller) FinalResponse added in v0.3.0 

func (p *PacketCapturesClientCreatePoller) FinalResponse(ctx context.Context) (PacketCapturesClientCreateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PacketCapturesClientCreateResponse will be returned.

func (*PacketCapturesClientCreatePoller) Poll added in v0.3.0 

func (p *PacketCapturesClientCreatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PacketCapturesClientCreatePoller) ResumeToken added in v0.3.0 

func (p *PacketCapturesClientCreatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PacketCapturesClientCreatePollerResponse added in v0.3.0 

type PacketCapturesClientCreatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PacketCapturesClientCreatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PacketCapturesClientCreatePollerResponse contains the response from method PacketCapturesClient.Create.

func (PacketCapturesClientCreatePollerResponse) PollUntilDone added in v0.3.0 

func (l PacketCapturesClientCreatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PacketCapturesClientCreateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PacketCapturesClientCreatePollerResponse) Resume added in v0.3.0 

func (l *PacketCapturesClientCreatePollerResponse) Resume(ctx context.Context, client *PacketCapturesClient, token string) error

Resume rehydrates a PacketCapturesClientCreatePollerResponse from the provided client and resume token.

type PacketCapturesClientCreateResponse added in v0.3.0 

type PacketCapturesClientCreateResponse struct {
	PacketCapturesClientCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PacketCapturesClientCreateResponse contains the response from method PacketCapturesClient.Create.

type PacketCapturesClientCreateResult added in v0.3.0 

type PacketCapturesClientCreateResult struct {
	PacketCaptureResult
}

PacketCapturesClientCreateResult contains the result from method PacketCapturesClient.Create.

type PacketCapturesClientDeletePoller added in v0.3.0 

type PacketCapturesClientDeletePoller struct {
	// contains filtered or unexported fields
}

PacketCapturesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PacketCapturesClientDeletePoller) Done added in v0.3.0 

func (p *PacketCapturesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PacketCapturesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *PacketCapturesClientDeletePoller) FinalResponse(ctx context.Context) (PacketCapturesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PacketCapturesClientDeleteResponse will be returned.

func (*PacketCapturesClientDeletePoller) Poll added in v0.3.0 

func (p *PacketCapturesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PacketCapturesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *PacketCapturesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PacketCapturesClientDeletePollerResponse added in v0.3.0 

type PacketCapturesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PacketCapturesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PacketCapturesClientDeletePollerResponse contains the response from method PacketCapturesClient.Delete.

func (PacketCapturesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l PacketCapturesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PacketCapturesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PacketCapturesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *PacketCapturesClientDeletePollerResponse) Resume(ctx context.Context, client *PacketCapturesClient, token string) error

Resume rehydrates a PacketCapturesClientDeletePollerResponse from the provided client and resume token.

type PacketCapturesClientDeleteResponse added in v0.3.0 

type PacketCapturesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PacketCapturesClientDeleteResponse contains the response from method PacketCapturesClient.Delete.

type PacketCapturesClientGetOptions added in v0.3.0 

type PacketCapturesClientGetOptions struct {
}

PacketCapturesClientGetOptions contains the optional parameters for the PacketCapturesClient.Get method.

type PacketCapturesClientGetResponse added in v0.3.0 

type PacketCapturesClientGetResponse struct {
	PacketCapturesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PacketCapturesClientGetResponse contains the response from method PacketCapturesClient.Get.

type PacketCapturesClientGetResult added in v0.3.0 

type PacketCapturesClientGetResult struct {
	PacketCaptureResult
}

PacketCapturesClientGetResult contains the result from method PacketCapturesClient.Get.

type PacketCapturesClientGetStatusPoller added in v0.3.0 

type PacketCapturesClientGetStatusPoller struct {
	// contains filtered or unexported fields
}

PacketCapturesClientGetStatusPoller provides polling facilities until the operation reaches a terminal state.

func (*PacketCapturesClientGetStatusPoller) Done added in v0.3.0 

func (p *PacketCapturesClientGetStatusPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PacketCapturesClientGetStatusPoller) FinalResponse added in v0.3.0 

func (p *PacketCapturesClientGetStatusPoller) FinalResponse(ctx context.Context) (PacketCapturesClientGetStatusResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PacketCapturesClientGetStatusResponse will be returned.

func (*PacketCapturesClientGetStatusPoller) Poll added in v0.3.0 

func (p *PacketCapturesClientGetStatusPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PacketCapturesClientGetStatusPoller) ResumeToken added in v0.3.0 

func (p *PacketCapturesClientGetStatusPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PacketCapturesClientGetStatusPollerResponse added in v0.3.0 

type PacketCapturesClientGetStatusPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PacketCapturesClientGetStatusPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PacketCapturesClientGetStatusPollerResponse contains the response from method PacketCapturesClient.GetStatus.

func (PacketCapturesClientGetStatusPollerResponse) PollUntilDone added in v0.3.0 

func (l PacketCapturesClientGetStatusPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PacketCapturesClientGetStatusResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PacketCapturesClientGetStatusPollerResponse) Resume added in v0.3.0 

func (l *PacketCapturesClientGetStatusPollerResponse) Resume(ctx context.Context, client *PacketCapturesClient, token string) error

Resume rehydrates a PacketCapturesClientGetStatusPollerResponse from the provided client and resume token.

type PacketCapturesClientGetStatusResponse added in v0.3.0 

type PacketCapturesClientGetStatusResponse struct {
	PacketCapturesClientGetStatusResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PacketCapturesClientGetStatusResponse contains the response from method PacketCapturesClient.GetStatus.

type PacketCapturesClientGetStatusResult added in v0.3.0 

type PacketCapturesClientGetStatusResult struct {
	PacketCaptureQueryStatusResult
}

PacketCapturesClientGetStatusResult contains the result from method PacketCapturesClient.GetStatus.

type PacketCapturesClientListOptions added in v0.3.0 

type PacketCapturesClientListOptions struct {
}

PacketCapturesClientListOptions contains the optional parameters for the PacketCapturesClient.List method.

type PacketCapturesClientListResponse added in v0.3.0 

type PacketCapturesClientListResponse struct {
	PacketCapturesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PacketCapturesClientListResponse contains the response from method PacketCapturesClient.List.

type PacketCapturesClientListResult added in v0.3.0 

type PacketCapturesClientListResult struct {
	PacketCaptureListResult
}

PacketCapturesClientListResult contains the result from method PacketCapturesClient.List.

type PacketCapturesClientStopPoller added in v0.3.0 

type PacketCapturesClientStopPoller struct {
	// contains filtered or unexported fields
}

PacketCapturesClientStopPoller provides polling facilities until the operation reaches a terminal state.

func (*PacketCapturesClientStopPoller) Done added in v0.3.0 

func (p *PacketCapturesClientStopPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PacketCapturesClientStopPoller) FinalResponse added in v0.3.0 

func (p *PacketCapturesClientStopPoller) FinalResponse(ctx context.Context) (PacketCapturesClientStopResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PacketCapturesClientStopResponse will be returned.

func (*PacketCapturesClientStopPoller) Poll added in v0.3.0 

func (p *PacketCapturesClientStopPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PacketCapturesClientStopPoller) ResumeToken added in v0.3.0 

func (p *PacketCapturesClientStopPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PacketCapturesClientStopPollerResponse added in v0.3.0 

type PacketCapturesClientStopPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PacketCapturesClientStopPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PacketCapturesClientStopPollerResponse contains the response from method PacketCapturesClient.Stop.

func (PacketCapturesClientStopPollerResponse) PollUntilDone added in v0.3.0 

func (l PacketCapturesClientStopPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PacketCapturesClientStopResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PacketCapturesClientStopPollerResponse) Resume added in v0.3.0 

func (l *PacketCapturesClientStopPollerResponse) Resume(ctx context.Context, client *PacketCapturesClient, token string) error

Resume rehydrates a PacketCapturesClientStopPollerResponse from the provided client and resume token.

type PacketCapturesClientStopResponse added in v0.3.0 

type PacketCapturesClientStopResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PacketCapturesClientStopResponse contains the response from method PacketCapturesClient.Stop.

type PatchRouteFilter 

type PatchRouteFilter struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Properties of the route filter.
	Properties *RouteFilterPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; 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" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PatchRouteFilter - Route Filter Resource.

func (PatchRouteFilter) MarshalJSON 

func (p PatchRouteFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PatchRouteFilter.

type PatchRouteFilterRule 

type PatchRouteFilterRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Properties of the route filter rule.
	Properties *RouteFilterRulePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; 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" azure:"ro"`
}

PatchRouteFilterRule - Route Filter Rule Resource.

type PcError 

type PcError string
const (
	PcErrorAgentStopped    PcError = "AgentStopped"
	PcErrorCaptureFailed   PcError = "CaptureFailed"
	PcErrorInternalError   PcError = "InternalError"
	PcErrorLocalFileFailed PcError = "LocalFileFailed"
	PcErrorStorageFailed   PcError = "StorageFailed"
)

func PossiblePcErrorValues 

func PossiblePcErrorValues() []PcError

PossiblePcErrorValues returns the possible values for the PcError const type.

func (PcError) ToPtr 

func (c PcError) ToPtr() *PcError

ToPtr returns a *PcError pointing to the current value.

type PcProtocol 

type PcProtocol string

PcProtocol - Protocol to be filtered on. 

const (
	PcProtocolAny PcProtocol = "Any"
	PcProtocolTCP PcProtocol = "TCP"
	PcProtocolUDP PcProtocol = "UDP"
)

func PossiblePcProtocolValues 

func PossiblePcProtocolValues() []PcProtocol

PossiblePcProtocolValues returns the possible values for the PcProtocol const type.

func (PcProtocol) ToPtr 

func (c PcProtocol) ToPtr() *PcProtocol

ToPtr returns a *PcProtocol pointing to the current value.

type PcStatus 

type PcStatus string

PcStatus - The status of the packet capture session. 

const (
	PcStatusError      PcStatus = "Error"
	PcStatusNotStarted PcStatus = "NotStarted"
	PcStatusRunning    PcStatus = "Running"
	PcStatusStopped    PcStatus = "Stopped"
	PcStatusUnknown    PcStatus = "Unknown"
)

func PossiblePcStatusValues 

func PossiblePcStatusValues() []PcStatus

PossiblePcStatusValues returns the possible values for the PcStatus const type.

func (PcStatus) ToPtr 

func (c PcStatus) ToPtr() *PcStatus

ToPtr returns a *PcStatus pointing to the current value.

type PeerExpressRouteCircuitConnection 

type PeerExpressRouteCircuitConnection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the peer express route circuit connection.
	Properties *PeerExpressRouteCircuitConnectionPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PeerExpressRouteCircuitConnection - Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.

type PeerExpressRouteCircuitConnectionListResult 

type PeerExpressRouteCircuitConnectionListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The global reach peer circuit connection associated with Private Peering in an ExpressRoute Circuit.
	Value []*PeerExpressRouteCircuitConnection `json:"value,omitempty"`
}

PeerExpressRouteCircuitConnectionListResult - Response for ListPeeredConnections API service call retrieves all global reach peer circuit connections that belongs to a Private Peering for an ExpressRouteCircuit.

func (PeerExpressRouteCircuitConnectionListResult) MarshalJSON 

func (p PeerExpressRouteCircuitConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeerExpressRouteCircuitConnectionListResult.

type PeerExpressRouteCircuitConnectionPropertiesFormat 

type PeerExpressRouteCircuitConnectionPropertiesFormat struct {
	// /29 IP address space to carve out Customer addresses for tunnels.
	AddressPrefix *string `json:"addressPrefix,omitempty"`

	// The resource guid of the authorization used for the express route circuit connection.
	AuthResourceGUID *string `json:"authResourceGuid,omitempty"`

	// The name of the express route circuit connection resource.
	ConnectionName *string `json:"connectionName,omitempty"`

	// Reference to Express Route Circuit Private Peering Resource of the circuit.
	ExpressRouteCircuitPeering *SubResource `json:"expressRouteCircuitPeering,omitempty"`

	// Reference to Express Route Circuit Private Peering Resource of the peered circuit.
	PeerExpressRouteCircuitPeering *SubResource `json:"peerExpressRouteCircuitPeering,omitempty"`

	// READ-ONLY; Express Route Circuit connection state.
	CircuitConnectionStatus *CircuitConnectionStatus `json:"circuitConnectionStatus,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the peer express route circuit connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PeerExpressRouteCircuitConnectionPropertiesFormat - Properties of the peer express route circuit connection.

type PeerExpressRouteCircuitConnectionsClient 

type PeerExpressRouteCircuitConnectionsClient struct {
	// contains filtered or unexported fields
}

PeerExpressRouteCircuitConnectionsClient contains the methods for the PeerExpressRouteCircuitConnections group. Don't use this type directly, use NewPeerExpressRouteCircuitConnectionsClient() instead.

func NewPeerExpressRouteCircuitConnectionsClient 

func NewPeerExpressRouteCircuitConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PeerExpressRouteCircuitConnectionsClient

NewPeerExpressRouteCircuitConnectionsClient creates a new instance of PeerExpressRouteCircuitConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PeerExpressRouteCircuitConnectionsClient) Get 

func (client *PeerExpressRouteCircuitConnectionsClient) Get(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, connectionName string, options *PeerExpressRouteCircuitConnectionsClientGetOptions) (PeerExpressRouteCircuitConnectionsClientGetResponse, error)

Get - Gets the specified Peer Express Route Circuit Connection from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the express route circuit. peeringName - The name of the peering. connectionName - The name of the peer express route circuit connection. options - PeerExpressRouteCircuitConnectionsClientGetOptions contains the optional parameters for the PeerExpressRouteCircuitConnectionsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PeerExpressRouteCircuitConnectionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPeerExpressRouteCircuitConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PeerExpressRouteCircuitConnectionsClientGetResult)
}

Output:

func (*PeerExpressRouteCircuitConnectionsClient) List 

func (client *PeerExpressRouteCircuitConnectionsClient) List(resourceGroupName string, circuitName string, peeringName string, options *PeerExpressRouteCircuitConnectionsClientListOptions) *PeerExpressRouteCircuitConnectionsClientListPager

List - Gets all global reach peer connections associated with a private peering in an express route circuit. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. circuitName - The name of the circuit. peeringName - The name of the peering. options - PeerExpressRouteCircuitConnectionsClientListOptions contains the optional parameters for the PeerExpressRouteCircuitConnectionsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PeerExpressRouteCircuitConnectionList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPeerExpressRouteCircuitConnectionsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<circuit-name>",
		"<peering-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type PeerExpressRouteCircuitConnectionsClientGetOptions added in v0.3.0 

type PeerExpressRouteCircuitConnectionsClientGetOptions struct {
}

PeerExpressRouteCircuitConnectionsClientGetOptions contains the optional parameters for the PeerExpressRouteCircuitConnectionsClient.Get method.

type PeerExpressRouteCircuitConnectionsClientGetResponse added in v0.3.0 

type PeerExpressRouteCircuitConnectionsClientGetResponse struct {
	PeerExpressRouteCircuitConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeerExpressRouteCircuitConnectionsClientGetResponse contains the response from method PeerExpressRouteCircuitConnectionsClient.Get.

type PeerExpressRouteCircuitConnectionsClientGetResult added in v0.3.0 

type PeerExpressRouteCircuitConnectionsClientGetResult struct {
	PeerExpressRouteCircuitConnection
}

PeerExpressRouteCircuitConnectionsClientGetResult contains the result from method PeerExpressRouteCircuitConnectionsClient.Get.

type PeerExpressRouteCircuitConnectionsClientListOptions added in v0.3.0 

type PeerExpressRouteCircuitConnectionsClientListOptions struct {
}

PeerExpressRouteCircuitConnectionsClientListOptions contains the optional parameters for the PeerExpressRouteCircuitConnectionsClient.List method.

type PeerExpressRouteCircuitConnectionsClientListPager added in v0.3.0 

type PeerExpressRouteCircuitConnectionsClientListPager struct {
	// contains filtered or unexported fields
}

PeerExpressRouteCircuitConnectionsClientListPager provides operations for iterating over paged responses.

func (*PeerExpressRouteCircuitConnectionsClientListPager) Err added in v0.3.0 

func (p *PeerExpressRouteCircuitConnectionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*PeerExpressRouteCircuitConnectionsClientListPager) NextPage added in v0.3.0 

func (p *PeerExpressRouteCircuitConnectionsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PeerExpressRouteCircuitConnectionsClientListPager) PageResponse added in v0.3.0 

func (p *PeerExpressRouteCircuitConnectionsClientListPager) PageResponse() PeerExpressRouteCircuitConnectionsClientListResponse

PageResponse returns the current PeerExpressRouteCircuitConnectionsClientListResponse page.

type PeerExpressRouteCircuitConnectionsClientListResponse added in v0.3.0 

type PeerExpressRouteCircuitConnectionsClientListResponse struct {
	PeerExpressRouteCircuitConnectionsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PeerExpressRouteCircuitConnectionsClientListResponse contains the response from method PeerExpressRouteCircuitConnectionsClient.List.

type PeerExpressRouteCircuitConnectionsClientListResult added in v0.3.0 

type PeerExpressRouteCircuitConnectionsClientListResult struct {
	PeerExpressRouteCircuitConnectionListResult
}

PeerExpressRouteCircuitConnectionsClientListResult contains the result from method PeerExpressRouteCircuitConnectionsClient.List.

type PeerRoute 

type PeerRoute struct {
	// READ-ONLY; The route's AS path sequence.
	AsPath *string `json:"asPath,omitempty" azure:"ro"`

	// READ-ONLY; The peer's local address.
	LocalAddress *string `json:"localAddress,omitempty" azure:"ro"`

	// READ-ONLY; The route's network prefix.
	Network *string `json:"network,omitempty" azure:"ro"`

	// READ-ONLY; The route's next hop.
	NextHop *string `json:"nextHop,omitempty" azure:"ro"`

	// READ-ONLY; The source this route was learned from.
	Origin *string `json:"origin,omitempty" azure:"ro"`

	// READ-ONLY; The peer this route was learned from.
	SourcePeer *string `json:"sourcePeer,omitempty" azure:"ro"`

	// READ-ONLY; The route's weight.
	Weight *int32 `json:"weight,omitempty" azure:"ro"`
}

PeerRoute - Peer routing details.

type PeerRouteList 

type PeerRouteList struct {
	// List of peer routes.
	Value []*PeerRoute `json:"value,omitempty"`
}

PeerRouteList - List of virtual router peer routes.

func (PeerRouteList) MarshalJSON 

func (p PeerRouteList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeerRouteList.

type PfsGroup 

type PfsGroup string

PfsGroup - The Pfs Groups used in IKE Phase 2 for new child SA. 

const (
	PfsGroupECP256  PfsGroup = "ECP256"
	PfsGroupECP384  PfsGroup = "ECP384"
	PfsGroupNone    PfsGroup = "None"
	PfsGroupPFS1    PfsGroup = "PFS1"
	PfsGroupPFS14   PfsGroup = "PFS14"
	PfsGroupPFS2    PfsGroup = "PFS2"
	PfsGroupPFS2048 PfsGroup = "PFS2048"
	PfsGroupPFS24   PfsGroup = "PFS24"
	PfsGroupPFSMM   PfsGroup = "PFSMM"
)

func PossiblePfsGroupValues 

func PossiblePfsGroupValues() []PfsGroup

PossiblePfsGroupValues returns the possible values for the PfsGroup const type.

func (PfsGroup) ToPtr 

func (c PfsGroup) ToPtr() *PfsGroup

ToPtr returns a *PfsGroup pointing to the current value.

type PolicySettings 

type PolicySettings struct {
	// Maximum file upload size in Mb for WAF.
	FileUploadLimitInMb *int32 `json:"fileUploadLimitInMb,omitempty"`

	// Maximum request body size in Kb for WAF.
	MaxRequestBodySizeInKb *int32 `json:"maxRequestBodySizeInKb,omitempty"`

	// The mode of the policy.
	Mode *WebApplicationFirewallMode `json:"mode,omitempty"`

	// Whether to allow WAF to check request Body.
	RequestBodyCheck *bool `json:"requestBodyCheck,omitempty"`

	// The state of the policy.
	State *WebApplicationFirewallEnabledState `json:"state,omitempty"`
}

PolicySettings - Defines contents of a web application firewall global configuration.

type PreferredIPVersion 

type PreferredIPVersion string

PreferredIPVersion - The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. 

const (
	PreferredIPVersionIPv4 PreferredIPVersion = "IPv4"
	PreferredIPVersionIPv6 PreferredIPVersion = "IPv6"
)

func PossiblePreferredIPVersionValues 

func PossiblePreferredIPVersionValues() []PreferredIPVersion

PossiblePreferredIPVersionValues returns the possible values for the PreferredIPVersion const type.

func (PreferredIPVersion) ToPtr 

func (c PreferredIPVersion) ToPtr() *PreferredIPVersion

ToPtr returns a *PreferredIPVersion pointing to the current value.

type PreferredRoutingGateway 

type PreferredRoutingGateway string

PreferredRoutingGateway - The preferred routing gateway types 

const (
	PreferredRoutingGatewayExpressRoute PreferredRoutingGateway = "ExpressRoute"
	PreferredRoutingGatewayNone         PreferredRoutingGateway = "None"
	PreferredRoutingGatewayVPNGateway   PreferredRoutingGateway = "VpnGateway"
)

func PossiblePreferredRoutingGatewayValues 

func PossiblePreferredRoutingGatewayValues() []PreferredRoutingGateway

PossiblePreferredRoutingGatewayValues returns the possible values for the PreferredRoutingGateway const type.

func (PreferredRoutingGateway) ToPtr 

func (c PreferredRoutingGateway) ToPtr() *PreferredRoutingGateway

ToPtr returns a *PreferredRoutingGateway pointing to the current value.

type PrepareNetworkPoliciesRequest 

type PrepareNetworkPoliciesRequest struct {
	// A list of NetworkIntentPolicyConfiguration.
	NetworkIntentPolicyConfigurations []*IntentPolicyConfiguration `json:"networkIntentPolicyConfigurations,omitempty"`

	// The name of the service for which subnet is being prepared for.
	ServiceName *string `json:"serviceName,omitempty"`
}

PrepareNetworkPoliciesRequest - Details of PrepareNetworkPolicies for Subnet.

func (PrepareNetworkPoliciesRequest) MarshalJSON 

func (p PrepareNetworkPoliciesRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrepareNetworkPoliciesRequest.

type PrivateDNSZoneConfig 

type PrivateDNSZoneConfig struct {
	// 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"`

	// Properties of the private dns zone configuration.
	Properties *PrivateDNSZonePropertiesFormat `json:"properties,omitempty"`
}

PrivateDNSZoneConfig - PrivateDnsZoneConfig resource.

type PrivateDNSZoneGroup 

type PrivateDNSZoneGroup struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the private dns zone group.
	Properties *PrivateDNSZoneGroupPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

PrivateDNSZoneGroup - Private dns zone group resource.

type PrivateDNSZoneGroupListResult 

type PrivateDNSZoneGroupListResult struct {
	// A list of private dns zone group resources in a private endpoint.
	Value []*PrivateDNSZoneGroup `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

PrivateDNSZoneGroupListResult - Response for the ListPrivateDnsZoneGroups API service call.

func (PrivateDNSZoneGroupListResult) MarshalJSON 

func (p PrivateDNSZoneGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateDNSZoneGroupListResult.

type PrivateDNSZoneGroupPropertiesFormat 

type PrivateDNSZoneGroupPropertiesFormat struct {
	// A collection of private dns zone configurations of the private dns zone group.
	PrivateDNSZoneConfigs []*PrivateDNSZoneConfig `json:"privateDnsZoneConfigs,omitempty"`

	// READ-ONLY; The provisioning state of the private dns zone group resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateDNSZoneGroupPropertiesFormat - Properties of the private dns zone group.

func (PrivateDNSZoneGroupPropertiesFormat) MarshalJSON 

func (p PrivateDNSZoneGroupPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateDNSZoneGroupPropertiesFormat.

type PrivateDNSZoneGroupsClient 

type PrivateDNSZoneGroupsClient struct {
	// contains filtered or unexported fields
}

PrivateDNSZoneGroupsClient contains the methods for the PrivateDNSZoneGroups group. Don't use this type directly, use NewPrivateDNSZoneGroupsClient() instead.

func NewPrivateDNSZoneGroupsClient 

func NewPrivateDNSZoneGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateDNSZoneGroupsClient

NewPrivateDNSZoneGroupsClient creates a new instance of PrivateDNSZoneGroupsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateDNSZoneGroupsClient) BeginCreateOrUpdate 

func (client *PrivateDNSZoneGroupsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, privateEndpointName string, privateDNSZoneGroupName string, parameters PrivateDNSZoneGroup, options *PrivateDNSZoneGroupsClientBeginCreateOrUpdateOptions) (PrivateDNSZoneGroupsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a private dns zone group in the specified private endpoint. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. privateEndpointName - The name of the private endpoint. privateDNSZoneGroupName - The name of the private dns zone group. parameters - Parameters supplied to the create or update private dns zone group operation. options - PrivateDNSZoneGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateEndpointDnsZoneGroupCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateDNSZoneGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<private-endpoint-name>",
		"<private-dnszone-group-name>",
		armnetwork.PrivateDNSZoneGroup{
			Properties: &armnetwork.PrivateDNSZoneGroupPropertiesFormat{
				PrivateDNSZoneConfigs: []*armnetwork.PrivateDNSZoneConfig{
					{
						Properties: &armnetwork.PrivateDNSZonePropertiesFormat{
							PrivateDNSZoneID: to.StringPtr("<private-dnszone-id>"),
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateDNSZoneGroupsClientCreateOrUpdateResult)
}

Output:

func (*PrivateDNSZoneGroupsClient) BeginDelete 

func (client *PrivateDNSZoneGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, privateEndpointName string, privateDNSZoneGroupName string, options *PrivateDNSZoneGroupsClientBeginDeleteOptions) (PrivateDNSZoneGroupsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified private dns zone group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. privateEndpointName - The name of the private endpoint. privateDNSZoneGroupName - The name of the private dns zone group. options - PrivateDNSZoneGroupsClientBeginDeleteOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateEndpointDnsZoneGroupDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateDNSZoneGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<private-endpoint-name>",
		"<private-dnszone-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PrivateDNSZoneGroupsClient) Get 

func (client *PrivateDNSZoneGroupsClient) Get(ctx context.Context, resourceGroupName string, privateEndpointName string, privateDNSZoneGroupName string, options *PrivateDNSZoneGroupsClientGetOptions) (PrivateDNSZoneGroupsClientGetResponse, error)

Get - Gets the private dns zone group resource by specified private dns zone group name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. privateEndpointName - The name of the private endpoint. privateDNSZoneGroupName - The name of the private dns zone group. options - PrivateDNSZoneGroupsClientGetOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateEndpointDnsZoneGroupGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateDNSZoneGroupsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<private-endpoint-name>",
		"<private-dnszone-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateDNSZoneGroupsClientGetResult)
}

Output:

func (*PrivateDNSZoneGroupsClient) List 

func (client *PrivateDNSZoneGroupsClient) List(privateEndpointName string, resourceGroupName string, options *PrivateDNSZoneGroupsClientListOptions) *PrivateDNSZoneGroupsClientListPager

List - Gets all private dns zone groups in a private endpoint. If the operation fails it returns an *azcore.ResponseError type. privateEndpointName - The name of the private endpoint. resourceGroupName - The name of the resource group. options - PrivateDNSZoneGroupsClientListOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateEndpointDnsZoneGroupList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateDNSZoneGroupsClient("<subscription-id>", cred, nil)
	pager := client.List("<private-endpoint-name>",
		"<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type PrivateDNSZoneGroupsClientBeginCreateOrUpdateOptions added in v0.3.0 

type PrivateDNSZoneGroupsClientBeginCreateOrUpdateOptions struct {
}

PrivateDNSZoneGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.BeginCreateOrUpdate method.

type PrivateDNSZoneGroupsClientBeginDeleteOptions added in v0.3.0 

type PrivateDNSZoneGroupsClientBeginDeleteOptions struct {
}

PrivateDNSZoneGroupsClientBeginDeleteOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.BeginDelete method.

type PrivateDNSZoneGroupsClientCreateOrUpdatePoller added in v0.3.0 

type PrivateDNSZoneGroupsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

PrivateDNSZoneGroupsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateDNSZoneGroupsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateDNSZoneGroupsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (PrivateDNSZoneGroupsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateDNSZoneGroupsClientCreateOrUpdateResponse will be returned.

func (*PrivateDNSZoneGroupsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateDNSZoneGroupsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateDNSZoneGroupsClientCreateOrUpdatePollerResponse added in v0.3.0 

type PrivateDNSZoneGroupsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateDNSZoneGroupsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateDNSZoneGroupsClientCreateOrUpdatePollerResponse contains the response from method PrivateDNSZoneGroupsClient.CreateOrUpdate.

func (PrivateDNSZoneGroupsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateDNSZoneGroupsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateDNSZoneGroupsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateDNSZoneGroupsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *PrivateDNSZoneGroupsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *PrivateDNSZoneGroupsClient, token string) error

Resume rehydrates a PrivateDNSZoneGroupsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type PrivateDNSZoneGroupsClientCreateOrUpdateResponse added in v0.3.0 

type PrivateDNSZoneGroupsClientCreateOrUpdateResponse struct {
	PrivateDNSZoneGroupsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateDNSZoneGroupsClientCreateOrUpdateResponse contains the response from method PrivateDNSZoneGroupsClient.CreateOrUpdate.

type PrivateDNSZoneGroupsClientCreateOrUpdateResult added in v0.3.0 

type PrivateDNSZoneGroupsClientCreateOrUpdateResult struct {
	PrivateDNSZoneGroup
}

PrivateDNSZoneGroupsClientCreateOrUpdateResult contains the result from method PrivateDNSZoneGroupsClient.CreateOrUpdate.

type PrivateDNSZoneGroupsClientDeletePoller added in v0.3.0 

type PrivateDNSZoneGroupsClientDeletePoller struct {
	// contains filtered or unexported fields
}

PrivateDNSZoneGroupsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateDNSZoneGroupsClientDeletePoller) Done added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateDNSZoneGroupsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientDeletePoller) FinalResponse(ctx context.Context) (PrivateDNSZoneGroupsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateDNSZoneGroupsClientDeleteResponse will be returned.

func (*PrivateDNSZoneGroupsClientDeletePoller) Poll added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateDNSZoneGroupsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateDNSZoneGroupsClientDeletePollerResponse added in v0.3.0 

type PrivateDNSZoneGroupsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateDNSZoneGroupsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateDNSZoneGroupsClientDeletePollerResponse contains the response from method PrivateDNSZoneGroupsClient.Delete.

func (PrivateDNSZoneGroupsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateDNSZoneGroupsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateDNSZoneGroupsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateDNSZoneGroupsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *PrivateDNSZoneGroupsClientDeletePollerResponse) Resume(ctx context.Context, client *PrivateDNSZoneGroupsClient, token string) error

Resume rehydrates a PrivateDNSZoneGroupsClientDeletePollerResponse from the provided client and resume token.

type PrivateDNSZoneGroupsClientDeleteResponse added in v0.3.0 

type PrivateDNSZoneGroupsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateDNSZoneGroupsClientDeleteResponse contains the response from method PrivateDNSZoneGroupsClient.Delete.

type PrivateDNSZoneGroupsClientGetOptions added in v0.3.0 

type PrivateDNSZoneGroupsClientGetOptions struct {
}

PrivateDNSZoneGroupsClientGetOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.Get method.

type PrivateDNSZoneGroupsClientGetResponse added in v0.3.0 

type PrivateDNSZoneGroupsClientGetResponse struct {
	PrivateDNSZoneGroupsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateDNSZoneGroupsClientGetResponse contains the response from method PrivateDNSZoneGroupsClient.Get.

type PrivateDNSZoneGroupsClientGetResult added in v0.3.0 

type PrivateDNSZoneGroupsClientGetResult struct {
	PrivateDNSZoneGroup
}

PrivateDNSZoneGroupsClientGetResult contains the result from method PrivateDNSZoneGroupsClient.Get.

type PrivateDNSZoneGroupsClientListOptions added in v0.3.0 

type PrivateDNSZoneGroupsClientListOptions struct {
}

PrivateDNSZoneGroupsClientListOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.List method.

type PrivateDNSZoneGroupsClientListPager added in v0.3.0 

type PrivateDNSZoneGroupsClientListPager struct {
	// contains filtered or unexported fields
}

PrivateDNSZoneGroupsClientListPager provides operations for iterating over paged responses.

func (*PrivateDNSZoneGroupsClientListPager) Err added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*PrivateDNSZoneGroupsClientListPager) NextPage added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateDNSZoneGroupsClientListPager) PageResponse added in v0.3.0 

func (p *PrivateDNSZoneGroupsClientListPager) PageResponse() PrivateDNSZoneGroupsClientListResponse

PageResponse returns the current PrivateDNSZoneGroupsClientListResponse page.

type PrivateDNSZoneGroupsClientListResponse added in v0.3.0 

type PrivateDNSZoneGroupsClientListResponse struct {
	PrivateDNSZoneGroupsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateDNSZoneGroupsClientListResponse contains the response from method PrivateDNSZoneGroupsClient.List.

type PrivateDNSZoneGroupsClientListResult added in v0.3.0 

type PrivateDNSZoneGroupsClientListResult struct {
	PrivateDNSZoneGroupListResult
}

PrivateDNSZoneGroupsClientListResult contains the result from method PrivateDNSZoneGroupsClient.List.

type PrivateDNSZonePropertiesFormat 

type PrivateDNSZonePropertiesFormat struct {
	// The resource id of the private dns zone.
	PrivateDNSZoneID *string `json:"privateDnsZoneId,omitempty"`

	// READ-ONLY; A collection of information regarding a recordSet, holding information to identify private resources.
	RecordSets []*RecordSet `json:"recordSets,omitempty" azure:"ro"`
}

PrivateDNSZonePropertiesFormat - Properties of the private dns zone configuration resource.

func (PrivateDNSZonePropertiesFormat) MarshalJSON 

func (p PrivateDNSZonePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateDNSZonePropertiesFormat.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// The extended location of the load balancer.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the private endpoint.
	Properties *PrivateEndpointProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpoint - Private endpoint resource.

func (PrivateEndpoint) MarshalJSON 

func (p PrivateEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpoint.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the private end point connection.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; The resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnection resource.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// A list of PrivateEndpointConnection resources for a specific private link service.
	Value []*PrivateEndpointConnection `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

PrivateEndpointConnectionListResult - Response for the ListPrivateEndpointConnection API service call.

func (PrivateEndpointConnectionListResult) MarshalJSON 

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// READ-ONLY; The consumer link id.
	LinkIdentifier *string `json:"linkIdentifier,omitempty" azure:"ro"`

	// READ-ONLY; The resource of private end point.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionProperties - Properties of the PrivateEndpointConnectProperties.

type PrivateEndpointIPConfiguration 

type PrivateEndpointIPConfiguration struct {
	// The name of the resource that is unique within a resource group.
	Name *string `json:"name,omitempty"`

	// Properties of private endpoint IP configurations.
	Properties *PrivateEndpointIPConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; The resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointIPConfiguration - An IP Configuration of the private endpoint.

type PrivateEndpointIPConfigurationProperties 

type PrivateEndpointIPConfigurationProperties struct {
	// The ID of a group obtained from the remote resource that this private endpoint should connect to.
	GroupID *string `json:"groupId,omitempty"`

	// The member name of a group obtained from the remote resource that this private endpoint should connect to.
	MemberName *string `json:"memberName,omitempty"`

	// A private ip address obtained from the private endpoint's subnet.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`
}

PrivateEndpointIPConfigurationProperties - Properties of an IP Configuration of the private endpoint.

type PrivateEndpointListResult 

type PrivateEndpointListResult struct {
	// A list of private endpoint resources in a resource group.
	Value []*PrivateEndpoint `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

PrivateEndpointListResult - Response for the ListPrivateEndpoints API service call.

func (PrivateEndpointListResult) MarshalJSON 

func (p PrivateEndpointListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointListResult.

type PrivateEndpointProperties 

type PrivateEndpointProperties struct {
	// Application security groups in which the private endpoint IP configuration is included.
	ApplicationSecurityGroups []*ApplicationSecurityGroup `json:"applicationSecurityGroups,omitempty"`

	// An array of custom dns configurations.
	CustomDNSConfigs []*CustomDNSConfigPropertiesFormat `json:"customDnsConfigs,omitempty"`

	// The custom name of the network interface attached to the private endpoint.
	CustomNetworkInterfaceName *string `json:"customNetworkInterfaceName,omitempty"`

	// A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints.
	IPConfigurations []*PrivateEndpointIPConfiguration `json:"ipConfigurations,omitempty"`

	// A grouping of information about the connection to the remote resource. Used when the network admin does not have access
	// to approve connections to the remote resource.
	ManualPrivateLinkServiceConnections []*PrivateLinkServiceConnection `json:"manualPrivateLinkServiceConnections,omitempty"`

	// A grouping of information about the connection to the remote resource.
	PrivateLinkServiceConnections []*PrivateLinkServiceConnection `json:"privateLinkServiceConnections,omitempty"`

	// The ID of the subnet from which the private IP will be allocated.
	Subnet *Subnet `json:"subnet,omitempty"`

	// READ-ONLY; An array of references to the network interfaces created for this private endpoint.
	NetworkInterfaces []*Interface `json:"networkInterfaces,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the private endpoint resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointProperties - Properties of the private endpoint.

func (PrivateEndpointProperties) MarshalJSON 

func (p PrivateEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointProperties.

type PrivateEndpointsClient 

type PrivateEndpointsClient struct {
	// contains filtered or unexported fields
}

PrivateEndpointsClient contains the methods for the PrivateEndpoints group. Don't use this type directly, use NewPrivateEndpointsClient() instead.

func NewPrivateEndpointsClient 

func NewPrivateEndpointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateEndpointsClient

NewPrivateEndpointsClient creates a new instance of PrivateEndpointsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointsClient) BeginCreateOrUpdate 

func (client *PrivateEndpointsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, privateEndpointName string, parameters PrivateEndpoint, options *PrivateEndpointsClientBeginCreateOrUpdateOptions) (PrivateEndpointsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates an private endpoint in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. privateEndpointName - The name of the private endpoint. parameters - Parameters supplied to the create or update private endpoint operation. options - PrivateEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateEndpointCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<private-endpoint-name>",
		armnetwork.PrivateEndpoint{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.PrivateEndpointProperties{
				CustomNetworkInterfaceName: to.StringPtr("<custom-network-interface-name>"),
				IPConfigurations: []*armnetwork.PrivateEndpointIPConfiguration{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.PrivateEndpointIPConfigurationProperties{
							GroupID:          to.StringPtr("<group-id>"),
							MemberName:       to.StringPtr("<member-name>"),
							PrivateIPAddress: to.StringPtr("<private-ipaddress>"),
						},
					}},
				PrivateLinkServiceConnections: []*armnetwork.PrivateLinkServiceConnection{
					{
						Properties: &armnetwork.PrivateLinkServiceConnectionProperties{
							GroupIDs: []*string{
								to.StringPtr("groupIdFromResource")},
							PrivateLinkServiceID: to.StringPtr("<private-link-service-id>"),
							RequestMessage:       to.StringPtr("<request-message>"),
						},
					}},
				Subnet: &armnetwork.Subnet{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointsClientCreateOrUpdateResult)
}

Output:

func (*PrivateEndpointsClient) BeginDelete 

func (client *PrivateEndpointsClient) BeginDelete(ctx context.Context, resourceGroupName string, privateEndpointName string, options *PrivateEndpointsClientBeginDeleteOptions) (PrivateEndpointsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified private endpoint. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. privateEndpointName - The name of the private endpoint. options - PrivateEndpointsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateEndpointDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<private-endpoint-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PrivateEndpointsClient) Get 

func (client *PrivateEndpointsClient) Get(ctx context.Context, resourceGroupName string, privateEndpointName string, options *PrivateEndpointsClientGetOptions) (PrivateEndpointsClientGetResponse, error)

Get - Gets the specified private endpoint by resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. privateEndpointName - The name of the private endpoint. options - PrivateEndpointsClientGetOptions contains the optional parameters for the PrivateEndpointsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateEndpointGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateEndpointsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<private-endpoint-name>",
		&armnetwork.PrivateEndpointsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointsClientGetResult)
}

Output:

func (*PrivateEndpointsClient) List 

func (client *PrivateEndpointsClient) List(resourceGroupName string, options *PrivateEndpointsClientListOptions) *PrivateEndpointsClientListPager

List - Gets all private endpoints in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - PrivateEndpointsClientListOptions contains the optional parameters for the PrivateEndpointsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateEndpointList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateEndpointsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PrivateEndpointsClient) ListBySubscription 

func (client *PrivateEndpointsClient) ListBySubscription(options *PrivateEndpointsClientListBySubscriptionOptions) *PrivateEndpointsClientListBySubscriptionPager

ListBySubscription - Gets all private endpoints in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - PrivateEndpointsClientListBySubscriptionOptions contains the optional parameters for the PrivateEndpointsClient.ListBySubscription method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateEndpointListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateEndpointsClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type PrivateEndpointsClientBeginCreateOrUpdateOptions added in v0.3.0 

type PrivateEndpointsClientBeginCreateOrUpdateOptions struct {
}

PrivateEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointsClient.BeginCreateOrUpdate method.

type PrivateEndpointsClientBeginDeleteOptions added in v0.3.0 

type PrivateEndpointsClientBeginDeleteOptions struct {
}

PrivateEndpointsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointsClient.BeginDelete method.

type PrivateEndpointsClientCreateOrUpdatePoller added in v0.3.0 

type PrivateEndpointsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

PrivateEndpointsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *PrivateEndpointsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *PrivateEndpointsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (PrivateEndpointsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointsClientCreateOrUpdateResponse will be returned.

func (*PrivateEndpointsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *PrivateEndpointsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *PrivateEndpointsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointsClientCreateOrUpdatePollerResponse added in v0.3.0 

type PrivateEndpointsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointsClientCreateOrUpdatePollerResponse contains the response from method PrivateEndpointsClient.CreateOrUpdate.

func (PrivateEndpointsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateEndpointsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *PrivateEndpointsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *PrivateEndpointsClient, token string) error

Resume rehydrates a PrivateEndpointsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type PrivateEndpointsClientCreateOrUpdateResponse added in v0.3.0 

type PrivateEndpointsClientCreateOrUpdateResponse struct {
	PrivateEndpointsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointsClientCreateOrUpdateResponse contains the response from method PrivateEndpointsClient.CreateOrUpdate.

type PrivateEndpointsClientCreateOrUpdateResult added in v0.3.0 

type PrivateEndpointsClientCreateOrUpdateResult struct {
	PrivateEndpoint
}

PrivateEndpointsClientCreateOrUpdateResult contains the result from method PrivateEndpointsClient.CreateOrUpdate.

type PrivateEndpointsClientDeletePoller added in v0.3.0 

type PrivateEndpointsClientDeletePoller struct {
	// contains filtered or unexported fields
}

PrivateEndpointsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointsClientDeletePoller) Done added in v0.3.0 

func (p *PrivateEndpointsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *PrivateEndpointsClientDeletePoller) FinalResponse(ctx context.Context) (PrivateEndpointsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointsClientDeleteResponse will be returned.

func (*PrivateEndpointsClientDeletePoller) Poll added in v0.3.0 

func (p *PrivateEndpointsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *PrivateEndpointsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointsClientDeletePollerResponse added in v0.3.0 

type PrivateEndpointsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointsClientDeletePollerResponse contains the response from method PrivateEndpointsClient.Delete.

func (PrivateEndpointsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateEndpointsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *PrivateEndpointsClientDeletePollerResponse) Resume(ctx context.Context, client *PrivateEndpointsClient, token string) error

Resume rehydrates a PrivateEndpointsClientDeletePollerResponse from the provided client and resume token.

type PrivateEndpointsClientDeleteResponse added in v0.3.0 

type PrivateEndpointsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointsClientDeleteResponse contains the response from method PrivateEndpointsClient.Delete.

type PrivateEndpointsClientGetOptions added in v0.3.0 

type PrivateEndpointsClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

PrivateEndpointsClientGetOptions contains the optional parameters for the PrivateEndpointsClient.Get method.

type PrivateEndpointsClientGetResponse added in v0.3.0 

type PrivateEndpointsClientGetResponse struct {
	PrivateEndpointsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointsClientGetResponse contains the response from method PrivateEndpointsClient.Get.

type PrivateEndpointsClientGetResult added in v0.3.0 

type PrivateEndpointsClientGetResult struct {
	PrivateEndpoint
}

PrivateEndpointsClientGetResult contains the result from method PrivateEndpointsClient.Get.

type PrivateEndpointsClientListBySubscriptionOptions added in v0.3.0 

type PrivateEndpointsClientListBySubscriptionOptions struct {
}

PrivateEndpointsClientListBySubscriptionOptions contains the optional parameters for the PrivateEndpointsClient.ListBySubscription method.

type PrivateEndpointsClientListBySubscriptionPager added in v0.3.0 

type PrivateEndpointsClientListBySubscriptionPager struct {
	// contains filtered or unexported fields
}

PrivateEndpointsClientListBySubscriptionPager provides operations for iterating over paged responses.

func (*PrivateEndpointsClientListBySubscriptionPager) Err added in v0.3.0 

func (p *PrivateEndpointsClientListBySubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*PrivateEndpointsClientListBySubscriptionPager) NextPage added in v0.3.0 

func (p *PrivateEndpointsClientListBySubscriptionPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateEndpointsClientListBySubscriptionPager) PageResponse added in v0.3.0 

func (p *PrivateEndpointsClientListBySubscriptionPager) PageResponse() PrivateEndpointsClientListBySubscriptionResponse

PageResponse returns the current PrivateEndpointsClientListBySubscriptionResponse page.

type PrivateEndpointsClientListBySubscriptionResponse added in v0.3.0 

type PrivateEndpointsClientListBySubscriptionResponse struct {
	PrivateEndpointsClientListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointsClientListBySubscriptionResponse contains the response from method PrivateEndpointsClient.ListBySubscription.

type PrivateEndpointsClientListBySubscriptionResult added in v0.3.0 

type PrivateEndpointsClientListBySubscriptionResult struct {
	PrivateEndpointListResult
}

PrivateEndpointsClientListBySubscriptionResult contains the result from method PrivateEndpointsClient.ListBySubscription.

type PrivateEndpointsClientListOptions added in v0.3.0 

type PrivateEndpointsClientListOptions struct {
}

PrivateEndpointsClientListOptions contains the optional parameters for the PrivateEndpointsClient.List method.

type PrivateEndpointsClientListPager added in v0.3.0 

type PrivateEndpointsClientListPager struct {
	// contains filtered or unexported fields
}

PrivateEndpointsClientListPager provides operations for iterating over paged responses.

func (*PrivateEndpointsClientListPager) Err added in v0.3.0 

func (p *PrivateEndpointsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*PrivateEndpointsClientListPager) NextPage added in v0.3.0 

func (p *PrivateEndpointsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateEndpointsClientListPager) PageResponse added in v0.3.0 

func (p *PrivateEndpointsClientListPager) PageResponse() PrivateEndpointsClientListResponse

PageResponse returns the current PrivateEndpointsClientListResponse page.

type PrivateEndpointsClientListResponse added in v0.3.0 

type PrivateEndpointsClientListResponse struct {
	PrivateEndpointsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointsClientListResponse contains the response from method PrivateEndpointsClient.List.

type PrivateEndpointsClientListResult added in v0.3.0 

type PrivateEndpointsClientListResult struct {
	PrivateEndpointListResult
}

PrivateEndpointsClientListResult contains the result from method PrivateEndpointsClient.List.

type PrivateLinkService 

type PrivateLinkService struct {
	// The extended location of the load balancer.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the private link service.
	Properties *PrivateLinkServiceProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkService - Private link service resource.

func (PrivateLinkService) MarshalJSON 

func (p PrivateLinkService) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkService.

type PrivateLinkServiceConnection 

type PrivateLinkServiceConnection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the private link service connection.
	Properties *PrivateLinkServiceConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; The resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkServiceConnection resource.

type PrivateLinkServiceConnectionProperties 

type PrivateLinkServiceConnectionProperties struct {
	// The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.
	GroupIDs []*string `json:"groupIds,omitempty"`

	// A collection of read-only information about the state of the connection to the remote resource.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The resource id of private link service.
	PrivateLinkServiceID *string `json:"privateLinkServiceId,omitempty"`

	// A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
	RequestMessage *string `json:"requestMessage,omitempty"`

	// READ-ONLY; The provisioning state of the private link service connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateLinkServiceConnectionProperties - Properties of the PrivateLinkServiceConnection.

func (PrivateLinkServiceConnectionProperties) MarshalJSON 

func (p PrivateLinkServiceConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceConnectionProperties.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string `json:"actionsRequired,omitempty"`

	// The reason for approval/rejection of the connection.
	Description *string `json:"description,omitempty"`

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *string `json:"status,omitempty"`
}

PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.

type PrivateLinkServiceIPConfiguration 

type PrivateLinkServiceIPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of private link service ip configuration.
	Name *string `json:"name,omitempty"`

	// Properties of the private link service ip configuration.
	Properties *PrivateLinkServiceIPConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; The resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkServiceIPConfiguration - The private link service ip configuration.

type PrivateLinkServiceIPConfigurationProperties 

type PrivateLinkServiceIPConfigurationProperties struct {
	// Whether the ip configuration is primary or not.
	Primary *bool `json:"primary,omitempty"`

	// The private IP address of the IP configuration.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.
	PrivateIPAddressVersion *IPVersion `json:"privateIPAddressVersion,omitempty"`

	// The private IP address allocation method.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// The reference to the subnet resource.
	Subnet *Subnet `json:"subnet,omitempty"`

	// READ-ONLY; The provisioning state of the private link service IP configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateLinkServiceIPConfigurationProperties - Properties of private link service IP configuration.

type PrivateLinkServiceListResult 

type PrivateLinkServiceListResult struct {
	// A list of PrivateLinkService resources in a resource group.
	Value []*PrivateLinkService `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

PrivateLinkServiceListResult - Response for the ListPrivateLinkService API service call.

func (PrivateLinkServiceListResult) MarshalJSON 

func (p PrivateLinkServiceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceListResult.

type PrivateLinkServiceProperties 

type PrivateLinkServiceProperties struct {
	// The auto-approval list of the private link service.
	AutoApproval *PrivateLinkServicePropertiesAutoApproval `json:"autoApproval,omitempty"`

	// Whether the private link service is enabled for proxy protocol or not.
	EnableProxyProtocol *bool `json:"enableProxyProtocol,omitempty"`

	// The list of Fqdn.
	Fqdns []*string `json:"fqdns,omitempty"`

	// An array of private link service IP configurations.
	IPConfigurations []*PrivateLinkServiceIPConfiguration `json:"ipConfigurations,omitempty"`

	// An array of references to the load balancer IP configurations.
	LoadBalancerFrontendIPConfigurations []*FrontendIPConfiguration `json:"loadBalancerFrontendIpConfigurations,omitempty"`

	// The visibility list of the private link service.
	Visibility *PrivateLinkServicePropertiesVisibility `json:"visibility,omitempty"`

	// READ-ONLY; The alias of the private link service.
	Alias *string `json:"alias,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to the network interfaces created for this private link service.
	NetworkInterfaces []*Interface `json:"networkInterfaces,omitempty" azure:"ro"`

	// READ-ONLY; An array of list about connections to the private endpoint.
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the private link service resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateLinkServiceProperties - Properties of the private link service.

func (PrivateLinkServiceProperties) MarshalJSON 

func (p PrivateLinkServiceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceProperties.

type PrivateLinkServicePropertiesAutoApproval 

type PrivateLinkServicePropertiesAutoApproval struct {
	// The list of subscriptions.
	Subscriptions []*string `json:"subscriptions,omitempty"`
}

PrivateLinkServicePropertiesAutoApproval - The auto-approval list of the private link service.

func (PrivateLinkServicePropertiesAutoApproval) MarshalJSON added in v0.3.0 

func (p PrivateLinkServicePropertiesAutoApproval) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServicePropertiesAutoApproval.

type PrivateLinkServicePropertiesVisibility 

type PrivateLinkServicePropertiesVisibility struct {
	// The list of subscriptions.
	Subscriptions []*string `json:"subscriptions,omitempty"`
}

PrivateLinkServicePropertiesVisibility - The visibility list of the private link service.

func (PrivateLinkServicePropertiesVisibility) MarshalJSON added in v0.3.0 

func (p PrivateLinkServicePropertiesVisibility) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServicePropertiesVisibility.

type PrivateLinkServiceVisibility 

type PrivateLinkServiceVisibility struct {
	// Private Link Service Visibility (True/False).
	Visible *bool `json:"visible,omitempty"`
}

PrivateLinkServiceVisibility - Response for the CheckPrivateLinkServiceVisibility API service call.

type PrivateLinkServicesClient 

type PrivateLinkServicesClient struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClient contains the methods for the PrivateLinkServices group. Don't use this type directly, use NewPrivateLinkServicesClient() instead.

func NewPrivateLinkServicesClient 

func NewPrivateLinkServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateLinkServicesClient

NewPrivateLinkServicesClient creates a new instance of PrivateLinkServicesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateLinkServicesClient) BeginCheckPrivateLinkServiceVisibility 

func (client *PrivateLinkServicesClient) BeginCheckPrivateLinkServiceVisibility(ctx context.Context, location string, parameters CheckPrivateLinkServiceVisibilityRequest, options *PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityOptions) (PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPollerResponse, error)

BeginCheckPrivateLinkServiceVisibility - Checks whether the subscription is visible to private link service. If the operation fails it returns an *azcore.ResponseError type. location - The location of the domain name. parameters - The request body of CheckPrivateLinkService API call. options - PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityOptions contains the optional parameters for the PrivateLinkServicesClient.BeginCheckPrivateLinkServiceVisibility method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CheckPrivateLinkServiceVisibility.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCheckPrivateLinkServiceVisibility(ctx,
		"<location>",
		armnetwork.CheckPrivateLinkServiceVisibilityRequest{
			PrivateLinkServiceAlias: to.StringPtr("<private-link-service-alias>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResult)
}

Output:

func (*PrivateLinkServicesClient) BeginCheckPrivateLinkServiceVisibilityByResourceGroup 

func (client *PrivateLinkServicesClient) BeginCheckPrivateLinkServiceVisibilityByResourceGroup(ctx context.Context, location string, resourceGroupName string, parameters CheckPrivateLinkServiceVisibilityRequest, options *PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityByResourceGroupOptions) (PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPollerResponse, error)

BeginCheckPrivateLinkServiceVisibilityByResourceGroup - Checks whether the subscription is visible to private link service in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. location - The location of the domain name. resourceGroupName - The name of the resource group. parameters - The request body of CheckPrivateLinkService API call. options - PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityByResourceGroupOptions contains the optional parameters for the PrivateLinkServicesClient.BeginCheckPrivateLinkServiceVisibilityByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCheckPrivateLinkServiceVisibilityByResourceGroup(ctx,
		"<location>",
		"<resource-group-name>",
		armnetwork.CheckPrivateLinkServiceVisibilityRequest{
			PrivateLinkServiceAlias: to.StringPtr("<private-link-service-alias>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResult)
}

Output:

func (*PrivateLinkServicesClient) BeginCreateOrUpdate 

func (client *PrivateLinkServicesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters PrivateLinkService, options *PrivateLinkServicesClientBeginCreateOrUpdateOptions) (PrivateLinkServicesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates an private link service in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceName - The name of the private link service. parameters - Parameters supplied to the create or update private link service operation. options - PrivateLinkServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateLinkServicesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateLinkServiceCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-name>",
		armnetwork.PrivateLinkService{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.PrivateLinkServiceProperties{
				AutoApproval: &armnetwork.PrivateLinkServicePropertiesAutoApproval{
					Subscriptions: []*string{
						to.StringPtr("subscription1"),
						to.StringPtr("subscription2")},
				},
				Fqdns: []*string{
					to.StringPtr("fqdn1"),
					to.StringPtr("fqdn2"),
					to.StringPtr("fqdn3")},
				IPConfigurations: []*armnetwork.PrivateLinkServiceIPConfiguration{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.PrivateLinkServiceIPConfigurationProperties{
							PrivateIPAddress:          to.StringPtr("<private-ipaddress>"),
							PrivateIPAddressVersion:   armnetwork.IPVersion("IPv4").ToPtr(),
							PrivateIPAllocationMethod: armnetwork.IPAllocationMethod("Static").ToPtr(),
							Subnet: &armnetwork.Subnet{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
				LoadBalancerFrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
					{
						ID: to.StringPtr("<id>"),
					}},
				Visibility: &armnetwork.PrivateLinkServicePropertiesVisibility{
					Subscriptions: []*string{
						to.StringPtr("subscription1"),
						to.StringPtr("subscription2"),
						to.StringPtr("subscription3")},
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateLinkServicesClientCreateOrUpdateResult)
}

Output:

func (*PrivateLinkServicesClient) BeginDelete 

func (client *PrivateLinkServicesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceName string, options *PrivateLinkServicesClientBeginDeleteOptions) (PrivateLinkServicesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified private link service. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceName - The name of the private link service. options - PrivateLinkServicesClientBeginDeleteOptions contains the optional parameters for the PrivateLinkServicesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateLinkServiceDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PrivateLinkServicesClient) BeginDeletePrivateEndpointConnection 

func (client *PrivateLinkServicesClient) BeginDeletePrivateEndpointConnection(ctx context.Context, resourceGroupName string, serviceName string, peConnectionName string, options *PrivateLinkServicesClientBeginDeletePrivateEndpointConnectionOptions) (PrivateLinkServicesClientDeletePrivateEndpointConnectionPollerResponse, error)

BeginDeletePrivateEndpointConnection - Delete private end point connection for a private link service in a subscription. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceName - The name of the private link service. peConnectionName - The name of the private end point connection. options - PrivateLinkServicesClientBeginDeletePrivateEndpointConnectionOptions contains the optional parameters for the PrivateLinkServicesClient.BeginDeletePrivateEndpointConnection method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDeletePrivateEndpointConnection(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<pe-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PrivateLinkServicesClient) Get 

func (client *PrivateLinkServicesClient) Get(ctx context.Context, resourceGroupName string, serviceName string, options *PrivateLinkServicesClientGetOptions) (PrivateLinkServicesClientGetResponse, error)

Get - Gets the specified private link service by resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceName - The name of the private link service. options - PrivateLinkServicesClientGetOptions contains the optional parameters for the PrivateLinkServicesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateLinkServiceGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-name>",
		&armnetwork.PrivateLinkServicesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateLinkServicesClientGetResult)
}

Output:

func (*PrivateLinkServicesClient) GetPrivateEndpointConnection 

func (client *PrivateLinkServicesClient) GetPrivateEndpointConnection(ctx context.Context, resourceGroupName string, serviceName string, peConnectionName string, options *PrivateLinkServicesClientGetPrivateEndpointConnectionOptions) (PrivateLinkServicesClientGetPrivateEndpointConnectionResponse, error)

GetPrivateEndpointConnection - Get the specific private end point connection by specific private link service in the resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceName - The name of the private link service. peConnectionName - The name of the private end point connection. options - PrivateLinkServicesClientGetPrivateEndpointConnectionOptions contains the optional parameters for the PrivateLinkServicesClient.GetPrivateEndpointConnection method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	res, err := client.GetPrivateEndpointConnection(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<pe-connection-name>",
		&armnetwork.PrivateLinkServicesClientGetPrivateEndpointConnectionOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateLinkServicesClientGetPrivateEndpointConnectionResult)
}

Output:

func (*PrivateLinkServicesClient) List 

func (client *PrivateLinkServicesClient) List(resourceGroupName string, options *PrivateLinkServicesClientListOptions) *PrivateLinkServicesClientListPager

List - Gets all private link services in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - PrivateLinkServicesClientListOptions contains the optional parameters for the PrivateLinkServicesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateLinkServiceList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PrivateLinkServicesClient) ListAutoApprovedPrivateLinkServices 

func (client *PrivateLinkServicesClient) ListAutoApprovedPrivateLinkServices(location string, options *PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesOptions) *PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesPager

ListAutoApprovedPrivateLinkServices - Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region. If the operation fails it returns an *azcore.ResponseError type. location - The location of the domain name. options - PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesOptions contains the optional parameters for the PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServices method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AutoApprovedPrivateLinkServicesGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	pager := client.ListAutoApprovedPrivateLinkServices("<location>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PrivateLinkServicesClient) ListAutoApprovedPrivateLinkServicesByResourceGroup 

func (client *PrivateLinkServicesClient) ListAutoApprovedPrivateLinkServicesByResourceGroup(location string, resourceGroupName string, options *PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupOptions) *PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupPager

ListAutoApprovedPrivateLinkServicesByResourceGroup - Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region. If the operation fails it returns an *azcore.ResponseError type. location - The location of the domain name. resourceGroupName - The name of the resource group. options - PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupOptions contains the optional parameters for the PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServicesByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	pager := client.ListAutoApprovedPrivateLinkServicesByResourceGroup("<location>",
		"<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PrivateLinkServicesClient) ListBySubscription 

func (client *PrivateLinkServicesClient) ListBySubscription(options *PrivateLinkServicesClientListBySubscriptionOptions) *PrivateLinkServicesClientListBySubscriptionPager

ListBySubscription - Gets all private link service in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - PrivateLinkServicesClientListBySubscriptionOptions contains the optional parameters for the PrivateLinkServicesClient.ListBySubscription method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateLinkServiceListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PrivateLinkServicesClient) ListPrivateEndpointConnections 

func (client *PrivateLinkServicesClient) ListPrivateEndpointConnections(resourceGroupName string, serviceName string, options *PrivateLinkServicesClientListPrivateEndpointConnectionsOptions) *PrivateLinkServicesClientListPrivateEndpointConnectionsPager

ListPrivateEndpointConnections - Gets all private end point connections for a specific private link service. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceName - The name of the private link service. options - PrivateLinkServicesClientListPrivateEndpointConnectionsOptions contains the optional parameters for the PrivateLinkServicesClient.ListPrivateEndpointConnections method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	pager := client.ListPrivateEndpointConnections("<resource-group-name>",
		"<service-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PrivateLinkServicesClient) UpdatePrivateEndpointConnection 

func (client *PrivateLinkServicesClient) UpdatePrivateEndpointConnection(ctx context.Context, resourceGroupName string, serviceName string, peConnectionName string, parameters PrivateEndpointConnection, options *PrivateLinkServicesClientUpdatePrivateEndpointConnectionOptions) (PrivateLinkServicesClientUpdatePrivateEndpointConnectionResponse, error)

UpdatePrivateEndpointConnection - Approve or reject private end point connection for a private link service in a subscription. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceName - The name of the private link service. peConnectionName - The name of the private end point connection. parameters - Parameters supplied to approve or reject the private end point connection. options - PrivateLinkServicesClientUpdatePrivateEndpointConnectionOptions contains the optional parameters for the PrivateLinkServicesClient.UpdatePrivateEndpointConnection method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPrivateLinkServicesClient("<subscription-id>", cred, nil)
	res, err := client.UpdatePrivateEndpointConnection(ctx,
		"<resource-group-name>",
		"<service-name>",
		"<pe-connection-name>",
		armnetwork.PrivateEndpointConnection{
			Name: to.StringPtr("<name>"),
			Properties: &armnetwork.PrivateEndpointConnectionProperties{
				PrivateEndpoint: &armnetwork.PrivateEndpoint{
					ID: to.StringPtr("<id>"),
				},
				PrivateLinkServiceConnectionState: &armnetwork.PrivateLinkServiceConnectionState{
					Description: to.StringPtr("<description>"),
					Status:      to.StringPtr("<status>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateLinkServicesClientUpdatePrivateEndpointConnectionResult)
}

Output:

type PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityByResourceGroupOptions added in v0.3.0 

type PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityByResourceGroupOptions struct {
}

PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityByResourceGroupOptions contains the optional parameters for the PrivateLinkServicesClient.BeginCheckPrivateLinkServiceVisibilityByResourceGroup method.

type PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityOptions added in v0.3.0 

type PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityOptions struct {
}

PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityOptions contains the optional parameters for the PrivateLinkServicesClient.BeginCheckPrivateLinkServiceVisibility method.

type PrivateLinkServicesClientBeginCreateOrUpdateOptions added in v0.3.0 

type PrivateLinkServicesClientBeginCreateOrUpdateOptions struct {
}

PrivateLinkServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateLinkServicesClient.BeginCreateOrUpdate method.

type PrivateLinkServicesClientBeginDeleteOptions added in v0.3.0 

type PrivateLinkServicesClientBeginDeleteOptions struct {
}

PrivateLinkServicesClientBeginDeleteOptions contains the optional parameters for the PrivateLinkServicesClient.BeginDelete method.

type PrivateLinkServicesClientBeginDeletePrivateEndpointConnectionOptions added in v0.3.0 

type PrivateLinkServicesClientBeginDeletePrivateEndpointConnectionOptions struct {
}

PrivateLinkServicesClientBeginDeletePrivateEndpointConnectionOptions contains the optional parameters for the PrivateLinkServicesClient.BeginDeletePrivateEndpointConnection method.

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller added in v0.3.0 

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller) Done added in v0.3.0 

func (p *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller) FinalResponse added in v0.3.0 

func (p *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller) FinalResponse(ctx context.Context) (PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResponse will be returned.

func (*PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller) Poll added in v0.3.0 

func (p *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller) ResumeToken added in v0.3.0 

func (p *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPollerResponse added in v0.3.0 

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPollerResponse contains the response from method PrivateLinkServicesClient.CheckPrivateLinkServiceVisibilityByResourceGroup.

func (PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPollerResponse) Resume added in v0.3.0 

func (l *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPollerResponse) Resume(ctx context.Context, client *PrivateLinkServicesClient, token string) error

Resume rehydrates a PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupPollerResponse from the provided client and resume token.

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResponse added in v0.3.0 

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResponse struct {
	PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResponse contains the response from method PrivateLinkServicesClient.CheckPrivateLinkServiceVisibilityByResourceGroup.

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResult added in v0.3.0 

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResult struct {
	PrivateLinkServiceVisibility
}

PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResult contains the result from method PrivateLinkServicesClient.CheckPrivateLinkServiceVisibilityByResourceGroup.

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller added in v0.3.0 

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller) Done added in v0.3.0 

func (p *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller) FinalResponse added in v0.3.0 

func (p *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller) FinalResponse(ctx context.Context) (PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResponse will be returned.

func (*PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller) Poll added in v0.3.0 

func (p *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller) ResumeToken added in v0.3.0 

func (p *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPollerResponse added in v0.3.0 

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPollerResponse contains the response from method PrivateLinkServicesClient.CheckPrivateLinkServiceVisibility.

func (PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPollerResponse) Resume added in v0.3.0 

func (l *PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPollerResponse) Resume(ctx context.Context, client *PrivateLinkServicesClient, token string) error

Resume rehydrates a PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityPollerResponse from the provided client and resume token.

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResponse added in v0.3.0 

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResponse struct {
	PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResponse contains the response from method PrivateLinkServicesClient.CheckPrivateLinkServiceVisibility.

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResult added in v0.3.0 

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResult struct {
	PrivateLinkServiceVisibility
}

PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResult contains the result from method PrivateLinkServicesClient.CheckPrivateLinkServiceVisibility.

type PrivateLinkServicesClientCreateOrUpdatePoller added in v0.3.0 

type PrivateLinkServicesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateLinkServicesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *PrivateLinkServicesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateLinkServicesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *PrivateLinkServicesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (PrivateLinkServicesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateLinkServicesClientCreateOrUpdateResponse will be returned.

func (*PrivateLinkServicesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *PrivateLinkServicesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateLinkServicesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *PrivateLinkServicesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateLinkServicesClientCreateOrUpdatePollerResponse added in v0.3.0 

type PrivateLinkServicesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateLinkServicesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientCreateOrUpdatePollerResponse contains the response from method PrivateLinkServicesClient.CreateOrUpdate.

func (PrivateLinkServicesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateLinkServicesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateLinkServicesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateLinkServicesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *PrivateLinkServicesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *PrivateLinkServicesClient, token string) error

Resume rehydrates a PrivateLinkServicesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type PrivateLinkServicesClientCreateOrUpdateResponse added in v0.3.0 

type PrivateLinkServicesClientCreateOrUpdateResponse struct {
	PrivateLinkServicesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientCreateOrUpdateResponse contains the response from method PrivateLinkServicesClient.CreateOrUpdate.

type PrivateLinkServicesClientCreateOrUpdateResult added in v0.3.0 

type PrivateLinkServicesClientCreateOrUpdateResult struct {
	PrivateLinkService
}

PrivateLinkServicesClientCreateOrUpdateResult contains the result from method PrivateLinkServicesClient.CreateOrUpdate.

type PrivateLinkServicesClientDeletePoller added in v0.3.0 

type PrivateLinkServicesClientDeletePoller struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateLinkServicesClientDeletePoller) Done added in v0.3.0 

func (p *PrivateLinkServicesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateLinkServicesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *PrivateLinkServicesClientDeletePoller) FinalResponse(ctx context.Context) (PrivateLinkServicesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateLinkServicesClientDeleteResponse will be returned.

func (*PrivateLinkServicesClientDeletePoller) Poll added in v0.3.0 

func (p *PrivateLinkServicesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateLinkServicesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *PrivateLinkServicesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateLinkServicesClientDeletePollerResponse added in v0.3.0 

type PrivateLinkServicesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateLinkServicesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientDeletePollerResponse contains the response from method PrivateLinkServicesClient.Delete.

func (PrivateLinkServicesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateLinkServicesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateLinkServicesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateLinkServicesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *PrivateLinkServicesClientDeletePollerResponse) Resume(ctx context.Context, client *PrivateLinkServicesClient, token string) error

Resume rehydrates a PrivateLinkServicesClientDeletePollerResponse from the provided client and resume token.

type PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller added in v0.3.0 

type PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller) Done added in v0.3.0 

func (p *PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller) FinalResponse added in v0.3.0 

func (p *PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller) FinalResponse(ctx context.Context) (PrivateLinkServicesClientDeletePrivateEndpointConnectionResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateLinkServicesClientDeletePrivateEndpointConnectionResponse will be returned.

func (*PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller) Poll added in v0.3.0 

func (p *PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller) ResumeToken added in v0.3.0 

func (p *PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateLinkServicesClientDeletePrivateEndpointConnectionPollerResponse added in v0.3.0 

type PrivateLinkServicesClientDeletePrivateEndpointConnectionPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateLinkServicesClientDeletePrivateEndpointConnectionPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientDeletePrivateEndpointConnectionPollerResponse contains the response from method PrivateLinkServicesClient.DeletePrivateEndpointConnection.

func (PrivateLinkServicesClientDeletePrivateEndpointConnectionPollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateLinkServicesClientDeletePrivateEndpointConnectionPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateLinkServicesClientDeletePrivateEndpointConnectionResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateLinkServicesClientDeletePrivateEndpointConnectionPollerResponse) Resume added in v0.3.0 

func (l *PrivateLinkServicesClientDeletePrivateEndpointConnectionPollerResponse) Resume(ctx context.Context, client *PrivateLinkServicesClient, token string) error

Resume rehydrates a PrivateLinkServicesClientDeletePrivateEndpointConnectionPollerResponse from the provided client and resume token.

type PrivateLinkServicesClientDeletePrivateEndpointConnectionResponse added in v0.3.0 

type PrivateLinkServicesClientDeletePrivateEndpointConnectionResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientDeletePrivateEndpointConnectionResponse contains the response from method PrivateLinkServicesClient.DeletePrivateEndpointConnection.

type PrivateLinkServicesClientDeleteResponse added in v0.3.0 

type PrivateLinkServicesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientDeleteResponse contains the response from method PrivateLinkServicesClient.Delete.

type PrivateLinkServicesClientGetOptions added in v0.3.0 

type PrivateLinkServicesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

PrivateLinkServicesClientGetOptions contains the optional parameters for the PrivateLinkServicesClient.Get method.

type PrivateLinkServicesClientGetPrivateEndpointConnectionOptions added in v0.3.0 

type PrivateLinkServicesClientGetPrivateEndpointConnectionOptions struct {
	// Expands referenced resources.
	Expand *string
}

PrivateLinkServicesClientGetPrivateEndpointConnectionOptions contains the optional parameters for the PrivateLinkServicesClient.GetPrivateEndpointConnection method.

type PrivateLinkServicesClientGetPrivateEndpointConnectionResponse added in v0.3.0 

type PrivateLinkServicesClientGetPrivateEndpointConnectionResponse struct {
	PrivateLinkServicesClientGetPrivateEndpointConnectionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientGetPrivateEndpointConnectionResponse contains the response from method PrivateLinkServicesClient.GetPrivateEndpointConnection.

type PrivateLinkServicesClientGetPrivateEndpointConnectionResult added in v0.3.0 

type PrivateLinkServicesClientGetPrivateEndpointConnectionResult struct {
	PrivateEndpointConnection
}

PrivateLinkServicesClientGetPrivateEndpointConnectionResult contains the result from method PrivateLinkServicesClient.GetPrivateEndpointConnection.

type PrivateLinkServicesClientGetResponse added in v0.3.0 

type PrivateLinkServicesClientGetResponse struct {
	PrivateLinkServicesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientGetResponse contains the response from method PrivateLinkServicesClient.Get.

type PrivateLinkServicesClientGetResult added in v0.3.0 

type PrivateLinkServicesClientGetResult struct {
	PrivateLinkService
}

PrivateLinkServicesClientGetResult contains the result from method PrivateLinkServicesClient.Get.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupOptions added in v0.3.0 

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupOptions struct {
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupOptions contains the optional parameters for the PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServicesByResourceGroup method.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupPager added in v0.3.0 

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupPager struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupPager provides operations for iterating over paged responses.

func (*PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupPager) Err added in v0.3.0 

func (p *PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupPager) NextPage added in v0.3.0 

func (p *PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupPager) PageResponse added in v0.3.0 

func (p *PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupPager) PageResponse() PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResponse

PageResponse returns the current PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResponse page.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResponse added in v0.3.0 

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResponse struct {
	PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResponse contains the response from method PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServicesByResourceGroup.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResult added in v0.3.0 

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResult struct {
	AutoApprovedPrivateLinkServicesResult
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResult contains the result from method PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServicesByResourceGroup.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesOptions added in v0.3.0 

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesOptions struct {
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesOptions contains the optional parameters for the PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServices method.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesPager added in v0.3.0 

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesPager struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesPager provides operations for iterating over paged responses.

func (*PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesPager) Err added in v0.3.0 

func (p *PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesPager) Err() error

Err returns the last error encountered while paging.

func (*PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesPager) NextPage added in v0.3.0 

func (p *PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesPager) PageResponse added in v0.3.0 

func (p *PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesPager) PageResponse() PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResponse

PageResponse returns the current PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResponse page.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResponse added in v0.3.0 

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResponse struct {
	PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResponse contains the response from method PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServices.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResult added in v0.3.0 

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResult struct {
	AutoApprovedPrivateLinkServicesResult
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResult contains the result from method PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServices.

type PrivateLinkServicesClientListBySubscriptionOptions added in v0.3.0 

type PrivateLinkServicesClientListBySubscriptionOptions struct {
}

PrivateLinkServicesClientListBySubscriptionOptions contains the optional parameters for the PrivateLinkServicesClient.ListBySubscription method.

type PrivateLinkServicesClientListBySubscriptionPager added in v0.3.0 

type PrivateLinkServicesClientListBySubscriptionPager struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClientListBySubscriptionPager provides operations for iterating over paged responses.

func (*PrivateLinkServicesClientListBySubscriptionPager) Err added in v0.3.0 

func (p *PrivateLinkServicesClientListBySubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*PrivateLinkServicesClientListBySubscriptionPager) NextPage added in v0.3.0 

func (p *PrivateLinkServicesClientListBySubscriptionPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateLinkServicesClientListBySubscriptionPager) PageResponse added in v0.3.0 

func (p *PrivateLinkServicesClientListBySubscriptionPager) PageResponse() PrivateLinkServicesClientListBySubscriptionResponse

PageResponse returns the current PrivateLinkServicesClientListBySubscriptionResponse page.

type PrivateLinkServicesClientListBySubscriptionResponse added in v0.3.0 

type PrivateLinkServicesClientListBySubscriptionResponse struct {
	PrivateLinkServicesClientListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientListBySubscriptionResponse contains the response from method PrivateLinkServicesClient.ListBySubscription.

type PrivateLinkServicesClientListBySubscriptionResult added in v0.3.0 

type PrivateLinkServicesClientListBySubscriptionResult struct {
	PrivateLinkServiceListResult
}

PrivateLinkServicesClientListBySubscriptionResult contains the result from method PrivateLinkServicesClient.ListBySubscription.

type PrivateLinkServicesClientListOptions added in v0.3.0 

type PrivateLinkServicesClientListOptions struct {
}

PrivateLinkServicesClientListOptions contains the optional parameters for the PrivateLinkServicesClient.List method.

type PrivateLinkServicesClientListPager added in v0.3.0 

type PrivateLinkServicesClientListPager struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClientListPager provides operations for iterating over paged responses.

func (*PrivateLinkServicesClientListPager) Err added in v0.3.0 

func (p *PrivateLinkServicesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*PrivateLinkServicesClientListPager) NextPage added in v0.3.0 

func (p *PrivateLinkServicesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateLinkServicesClientListPager) PageResponse added in v0.3.0 

func (p *PrivateLinkServicesClientListPager) PageResponse() PrivateLinkServicesClientListResponse

PageResponse returns the current PrivateLinkServicesClientListResponse page.

type PrivateLinkServicesClientListPrivateEndpointConnectionsOptions added in v0.3.0 

type PrivateLinkServicesClientListPrivateEndpointConnectionsOptions struct {
}

PrivateLinkServicesClientListPrivateEndpointConnectionsOptions contains the optional parameters for the PrivateLinkServicesClient.ListPrivateEndpointConnections method.

type PrivateLinkServicesClientListPrivateEndpointConnectionsPager added in v0.3.0 

type PrivateLinkServicesClientListPrivateEndpointConnectionsPager struct {
	// contains filtered or unexported fields
}

PrivateLinkServicesClientListPrivateEndpointConnectionsPager provides operations for iterating over paged responses.

func (*PrivateLinkServicesClientListPrivateEndpointConnectionsPager) Err added in v0.3.0 

func (p *PrivateLinkServicesClientListPrivateEndpointConnectionsPager) Err() error

Err returns the last error encountered while paging.

func (*PrivateLinkServicesClientListPrivateEndpointConnectionsPager) NextPage added in v0.3.0 

func (p *PrivateLinkServicesClientListPrivateEndpointConnectionsPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateLinkServicesClientListPrivateEndpointConnectionsPager) PageResponse added in v0.3.0 

func (p *PrivateLinkServicesClientListPrivateEndpointConnectionsPager) PageResponse() PrivateLinkServicesClientListPrivateEndpointConnectionsResponse

PageResponse returns the current PrivateLinkServicesClientListPrivateEndpointConnectionsResponse page.

type PrivateLinkServicesClientListPrivateEndpointConnectionsResponse added in v0.3.0 

type PrivateLinkServicesClientListPrivateEndpointConnectionsResponse struct {
	PrivateLinkServicesClientListPrivateEndpointConnectionsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientListPrivateEndpointConnectionsResponse contains the response from method PrivateLinkServicesClient.ListPrivateEndpointConnections.

type PrivateLinkServicesClientListPrivateEndpointConnectionsResult added in v0.3.0 

type PrivateLinkServicesClientListPrivateEndpointConnectionsResult struct {
	PrivateEndpointConnectionListResult
}

PrivateLinkServicesClientListPrivateEndpointConnectionsResult contains the result from method PrivateLinkServicesClient.ListPrivateEndpointConnections.

type PrivateLinkServicesClientListResponse added in v0.3.0 

type PrivateLinkServicesClientListResponse struct {
	PrivateLinkServicesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientListResponse contains the response from method PrivateLinkServicesClient.List.

type PrivateLinkServicesClientListResult added in v0.3.0 

type PrivateLinkServicesClientListResult struct {
	PrivateLinkServiceListResult
}

PrivateLinkServicesClientListResult contains the result from method PrivateLinkServicesClient.List.

type PrivateLinkServicesClientUpdatePrivateEndpointConnectionOptions added in v0.3.0 

type PrivateLinkServicesClientUpdatePrivateEndpointConnectionOptions struct {
}

PrivateLinkServicesClientUpdatePrivateEndpointConnectionOptions contains the optional parameters for the PrivateLinkServicesClient.UpdatePrivateEndpointConnection method.

type PrivateLinkServicesClientUpdatePrivateEndpointConnectionResponse added in v0.3.0 

type PrivateLinkServicesClientUpdatePrivateEndpointConnectionResponse struct {
	PrivateLinkServicesClientUpdatePrivateEndpointConnectionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkServicesClientUpdatePrivateEndpointConnectionResponse contains the response from method PrivateLinkServicesClient.UpdatePrivateEndpointConnection.

type PrivateLinkServicesClientUpdatePrivateEndpointConnectionResult added in v0.3.0 

type PrivateLinkServicesClientUpdatePrivateEndpointConnectionResult struct {
	PrivateEndpointConnection
}

PrivateLinkServicesClientUpdatePrivateEndpointConnectionResult contains the result from method PrivateLinkServicesClient.UpdatePrivateEndpointConnection.

type Probe 

type Probe struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access
	// the resource.
	Name *string `json:"name,omitempty"`

	// Properties of load balancer probe.
	Properties *ProbePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Type of the resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Probe - A load balancer probe.

type ProbePropertiesFormat 

type ProbePropertiesFormat struct {
	// REQUIRED; The port for communicating the probe. Possible values range from 1 to 65535, inclusive.
	Port *int32 `json:"port,omitempty"`

	// REQUIRED; The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful.
	// If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required
	// for the probe to be successful.
	Protocol *ProbeProtocol `json:"protocol,omitempty"`

	// 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"`

	// 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"`

	// 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"`

	// READ-ONLY; The load balancer rules that use this probe.
	LoadBalancingRules []*SubResource `json:"loadBalancingRules,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the probe resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ProbePropertiesFormat - Load balancer probe resource.

func (ProbePropertiesFormat) MarshalJSON 

func (p ProbePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProbePropertiesFormat.

type ProbeProtocol 

type ProbeProtocol string

ProbeProtocol - The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful. 

const (
	ProbeProtocolHTTP  ProbeProtocol = "Http"
	ProbeProtocolHTTPS ProbeProtocol = "Https"
	ProbeProtocolTCP   ProbeProtocol = "Tcp"
)

func PossibleProbeProtocolValues 

func PossibleProbeProtocolValues() []ProbeProtocol

PossibleProbeProtocolValues returns the possible values for the ProbeProtocol const type.

func (ProbeProtocol) ToPtr 

func (c ProbeProtocol) ToPtr() *ProbeProtocol

ToPtr returns a *ProbeProtocol pointing to the current value.

type ProcessorArchitecture 

type ProcessorArchitecture string

ProcessorArchitecture - VPN client Processor Architecture. 

const (
	ProcessorArchitectureAmd64 ProcessorArchitecture = "Amd64"
	ProcessorArchitectureX86   ProcessorArchitecture = "X86"
)

func PossibleProcessorArchitectureValues 

func PossibleProcessorArchitectureValues() []ProcessorArchitecture

PossibleProcessorArchitectureValues returns the possible values for the ProcessorArchitecture const type.

func (ProcessorArchitecture) ToPtr 

func (c ProcessorArchitecture) ToPtr() *ProcessorArchitecture

ToPtr returns a *ProcessorArchitecture pointing to the current value.

type Profile added in v0.3.0 

type Profile struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Network profile properties.
	Properties *ProfilePropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Profile - Network profile resource.

func (Profile) MarshalJSON added in v0.3.0 

func (p Profile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Profile.

type ProfileListResult added in v0.3.0 

type ProfileListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of network profiles that exist in a resource group.
	Value []*Profile `json:"value,omitempty"`
}

ProfileListResult - Response for ListNetworkProfiles API service call.

func (ProfileListResult) MarshalJSON added in v0.3.0 

func (p ProfileListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProfileListResult.

type ProfilePropertiesFormat added in v0.3.0 

type ProfilePropertiesFormat struct {
	// List of chid container network interface configurations.
	ContainerNetworkInterfaceConfigurations []*ContainerNetworkInterfaceConfiguration `json:"containerNetworkInterfaceConfigurations,omitempty"`

	// READ-ONLY; List of child container network interfaces.
	ContainerNetworkInterfaces []*ContainerNetworkInterface `json:"containerNetworkInterfaces,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the network profile resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the network profile resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

ProfilePropertiesFormat - Network profile properties.

func (ProfilePropertiesFormat) MarshalJSON added in v0.3.0 

func (p ProfilePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProfilePropertiesFormat.

type ProfilesClient added in v0.3.0 

type ProfilesClient struct {
	// contains filtered or unexported fields
}

ProfilesClient contains the methods for the NetworkProfiles group. Don't use this type directly, use NewProfilesClient() instead.

func NewProfilesClient added in v0.3.0 

func NewProfilesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ProfilesClient

NewProfilesClient creates a new instance of ProfilesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ProfilesClient) BeginDelete added in v0.3.0 

func (client *ProfilesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkProfileName string, options *ProfilesClientBeginDeleteOptions) (ProfilesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified network profile. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkProfileName - The name of the NetworkProfile. options - ProfilesClientBeginDeleteOptions contains the optional parameters for the ProfilesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkProfileDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewProfilesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-profile-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ProfilesClient) CreateOrUpdate added in v0.3.0 

func (client *ProfilesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkProfileName string, parameters Profile, options *ProfilesClientCreateOrUpdateOptions) (ProfilesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a network profile. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkProfileName - The name of the network profile. parameters - Parameters supplied to the create or update network profile operation. options - ProfilesClientCreateOrUpdateOptions contains the optional parameters for the ProfilesClient.CreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkProfileCreateConfigOnly.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewProfilesClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-profile-name>",
		armnetwork.Profile{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.ProfilePropertiesFormat{
				ContainerNetworkInterfaceConfigurations: []*armnetwork.ContainerNetworkInterfaceConfiguration{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.ContainerNetworkInterfaceConfigurationPropertiesFormat{
							IPConfigurations: []*armnetwork.IPConfigurationProfile{
								{
									Name: to.StringPtr("<name>"),
									Properties: &armnetwork.IPConfigurationProfilePropertiesFormat{
										Subnet: &armnetwork.Subnet{
											ID: to.StringPtr("<id>"),
										},
									},
								}},
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ProfilesClientCreateOrUpdateResult)
}

Output:

func (*ProfilesClient) Get added in v0.3.0 

func (client *ProfilesClient) Get(ctx context.Context, resourceGroupName string, networkProfileName string, options *ProfilesClientGetOptions) (ProfilesClientGetResponse, error)

Get - Gets the specified network profile in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkProfileName - The name of the public IP prefix. options - ProfilesClientGetOptions contains the optional parameters for the ProfilesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkProfileGetConfigOnly.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewProfilesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-profile-name>",
		&armnetwork.ProfilesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ProfilesClientGetResult)
}

Output:

func (*ProfilesClient) List added in v0.3.0 

func (client *ProfilesClient) List(resourceGroupName string, options *ProfilesClientListOptions) *ProfilesClientListPager

List - Gets all network profiles in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - ProfilesClientListOptions contains the optional parameters for the ProfilesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkProfileList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewProfilesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ProfilesClient) ListAll added in v0.3.0 

func (client *ProfilesClient) ListAll(options *ProfilesClientListAllOptions) *ProfilesClientListAllPager

ListAll - Gets all the network profiles in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ProfilesClientListAllOptions contains the optional parameters for the ProfilesClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkProfileListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewProfilesClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ProfilesClient) UpdateTags added in v0.3.0 

func (client *ProfilesClient) UpdateTags(ctx context.Context, resourceGroupName string, networkProfileName string, parameters TagsObject, options *ProfilesClientUpdateTagsOptions) (ProfilesClientUpdateTagsResponse, error)

UpdateTags - Updates network profile tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkProfileName - The name of the network profile. parameters - Parameters supplied to update network profile tags. options - ProfilesClientUpdateTagsOptions contains the optional parameters for the ProfilesClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkProfileUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewProfilesClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<network-profile-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ProfilesClientUpdateTagsResult)
}

Output:

type ProfilesClientBeginDeleteOptions added in v0.3.0 

type ProfilesClientBeginDeleteOptions struct {
}

ProfilesClientBeginDeleteOptions contains the optional parameters for the ProfilesClient.BeginDelete method.

type ProfilesClientCreateOrUpdateOptions added in v0.3.0 

type ProfilesClientCreateOrUpdateOptions struct {
}

ProfilesClientCreateOrUpdateOptions contains the optional parameters for the ProfilesClient.CreateOrUpdate method.

type ProfilesClientCreateOrUpdateResponse added in v0.3.0 

type ProfilesClientCreateOrUpdateResponse struct {
	ProfilesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProfilesClientCreateOrUpdateResponse contains the response from method ProfilesClient.CreateOrUpdate.

type ProfilesClientCreateOrUpdateResult added in v0.3.0 

type ProfilesClientCreateOrUpdateResult struct {
	Profile
}

ProfilesClientCreateOrUpdateResult contains the result from method ProfilesClient.CreateOrUpdate.

type ProfilesClientDeletePoller added in v0.3.0 

type ProfilesClientDeletePoller struct {
	// contains filtered or unexported fields
}

ProfilesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ProfilesClientDeletePoller) Done added in v0.3.0 

func (p *ProfilesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ProfilesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ProfilesClientDeletePoller) FinalResponse(ctx context.Context) (ProfilesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ProfilesClientDeleteResponse will be returned.

func (*ProfilesClientDeletePoller) Poll added in v0.3.0 

func (p *ProfilesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ProfilesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ProfilesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ProfilesClientDeletePollerResponse added in v0.3.0 

type ProfilesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ProfilesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProfilesClientDeletePollerResponse contains the response from method ProfilesClient.Delete.

func (ProfilesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ProfilesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ProfilesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ProfilesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ProfilesClientDeletePollerResponse) Resume(ctx context.Context, client *ProfilesClient, token string) error

Resume rehydrates a ProfilesClientDeletePollerResponse from the provided client and resume token.

type ProfilesClientDeleteResponse added in v0.3.0 

type ProfilesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProfilesClientDeleteResponse contains the response from method ProfilesClient.Delete.

type ProfilesClientGetOptions added in v0.3.0 

type ProfilesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

ProfilesClientGetOptions contains the optional parameters for the ProfilesClient.Get method.

type ProfilesClientGetResponse added in v0.3.0 

type ProfilesClientGetResponse struct {
	ProfilesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProfilesClientGetResponse contains the response from method ProfilesClient.Get.

type ProfilesClientGetResult added in v0.3.0 

type ProfilesClientGetResult struct {
	Profile
}

ProfilesClientGetResult contains the result from method ProfilesClient.Get.

type ProfilesClientListAllOptions added in v0.3.0 

type ProfilesClientListAllOptions struct {
}

ProfilesClientListAllOptions contains the optional parameters for the ProfilesClient.ListAll method.

type ProfilesClientListAllPager added in v0.3.0 

type ProfilesClientListAllPager struct {
	// contains filtered or unexported fields
}

ProfilesClientListAllPager provides operations for iterating over paged responses.

func (*ProfilesClientListAllPager) Err added in v0.3.0 

func (p *ProfilesClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*ProfilesClientListAllPager) NextPage added in v0.3.0 

func (p *ProfilesClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ProfilesClientListAllPager) PageResponse added in v0.3.0 

func (p *ProfilesClientListAllPager) PageResponse() ProfilesClientListAllResponse

PageResponse returns the current ProfilesClientListAllResponse page.

type ProfilesClientListAllResponse added in v0.3.0 

type ProfilesClientListAllResponse struct {
	ProfilesClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProfilesClientListAllResponse contains the response from method ProfilesClient.ListAll.

type ProfilesClientListAllResult added in v0.3.0 

type ProfilesClientListAllResult struct {
	ProfileListResult
}

ProfilesClientListAllResult contains the result from method ProfilesClient.ListAll.

type ProfilesClientListOptions added in v0.3.0 

type ProfilesClientListOptions struct {
}

ProfilesClientListOptions contains the optional parameters for the ProfilesClient.List method.

type ProfilesClientListPager added in v0.3.0 

type ProfilesClientListPager struct {
	// contains filtered or unexported fields
}

ProfilesClientListPager provides operations for iterating over paged responses.

func (*ProfilesClientListPager) Err added in v0.3.0 

func (p *ProfilesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ProfilesClientListPager) NextPage added in v0.3.0 

func (p *ProfilesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ProfilesClientListPager) PageResponse added in v0.3.0 

func (p *ProfilesClientListPager) PageResponse() ProfilesClientListResponse

PageResponse returns the current ProfilesClientListResponse page.

type ProfilesClientListResponse added in v0.3.0 

type ProfilesClientListResponse struct {
	ProfilesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProfilesClientListResponse contains the response from method ProfilesClient.List.

type ProfilesClientListResult added in v0.3.0 

type ProfilesClientListResult struct {
	ProfileListResult
}

ProfilesClientListResult contains the result from method ProfilesClient.List.

type ProfilesClientUpdateTagsOptions added in v0.3.0 

type ProfilesClientUpdateTagsOptions struct {
}

ProfilesClientUpdateTagsOptions contains the optional parameters for the ProfilesClient.UpdateTags method.

type ProfilesClientUpdateTagsResponse added in v0.3.0 

type ProfilesClientUpdateTagsResponse struct {
	ProfilesClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ProfilesClientUpdateTagsResponse contains the response from method ProfilesClient.UpdateTags.

type ProfilesClientUpdateTagsResult added in v0.3.0 

type ProfilesClientUpdateTagsResult struct {
	Profile
}

ProfilesClientUpdateTagsResult contains the result from method ProfilesClient.UpdateTags.

type PropagatedRouteTable 

type PropagatedRouteTable struct {
	// The list of resource ids of all the RouteTables.
	IDs []*SubResource `json:"ids,omitempty"`

	// The list of labels.
	Labels []*string `json:"labels,omitempty"`
}

PropagatedRouteTable - The list of RouteTables to advertise the routes to.

func (PropagatedRouteTable) MarshalJSON 

func (p PropagatedRouteTable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PropagatedRouteTable.

type Protocol 

type Protocol string

Protocol - Network protocol. 

const (
	ProtocolHTTP  Protocol = "Http"
	ProtocolHTTPS Protocol = "Https"
	ProtocolIcmp  Protocol = "Icmp"
	ProtocolTCP   Protocol = "Tcp"
)

func PossibleProtocolValues 

func PossibleProtocolValues() []Protocol

PossibleProtocolValues returns the possible values for the Protocol const type.

func (Protocol) ToPtr 

func (c Protocol) ToPtr() *Protocol

ToPtr returns a *Protocol pointing to the current value.

type ProtocolConfiguration 

type ProtocolConfiguration struct {
	// HTTP configuration of the connectivity check.
	HTTPConfiguration *HTTPConfiguration `json:"HTTPConfiguration,omitempty"`
}

ProtocolConfiguration - Configuration of the protocol.

type ProtocolCustomSettingsFormat 

type ProtocolCustomSettingsFormat struct {
	// The protocol for which the DDoS protection policy is being customized.
	Protocol *DdosCustomPolicyProtocol `json:"protocol,omitempty"`

	// The customized DDoS protection source rate.
	SourceRateOverride *string `json:"sourceRateOverride,omitempty"`

	// The customized DDoS protection trigger rate.
	TriggerRateOverride *string `json:"triggerRateOverride,omitempty"`

	// The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal
	// traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal
	// traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity
	// w.r.t. normal traffic.
	TriggerSensitivityOverride *DdosCustomPolicyTriggerSensitivityOverride `json:"triggerSensitivityOverride,omitempty"`
}

ProtocolCustomSettingsFormat - DDoS custom policy properties.

type ProtocolType 

type ProtocolType string

ProtocolType - RNM supported protocol types. 

const (
	ProtocolTypeAh       ProtocolType = "Ah"
	ProtocolTypeAll      ProtocolType = "All"
	ProtocolTypeDoNotUse ProtocolType = "DoNotUse"
	ProtocolTypeEsp      ProtocolType = "Esp"
	ProtocolTypeGre      ProtocolType = "Gre"
	ProtocolTypeIcmp     ProtocolType = "Icmp"
	ProtocolTypeTCP      ProtocolType = "Tcp"
	ProtocolTypeUDP      ProtocolType = "Udp"
	ProtocolTypeVxlan    ProtocolType = "Vxlan"
)

func PossibleProtocolTypeValues 

func PossibleProtocolTypeValues() []ProtocolType

PossibleProtocolTypeValues returns the possible values for the ProtocolType const type.

func (ProtocolType) ToPtr 

func (c ProtocolType) ToPtr() *ProtocolType

ToPtr returns a *ProtocolType pointing to the current value.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - The current provisioning state. 

const (
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

func (ProvisioningState) ToPtr 

func (c ProvisioningState) ToPtr() *ProvisioningState

ToPtr returns a *ProvisioningState pointing to the current value.

type PublicIPAddress 

type PublicIPAddress struct {
	// The extended location of the public ip address.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Public IP address properties.
	Properties *PublicIPAddressPropertiesFormat `json:"properties,omitempty"`

	// The public IP address SKU.
	SKU *PublicIPAddressSKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// A list of availability zones denoting the IP allocated for the resource needs to come from.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PublicIPAddress - Public IP address resource.

func (PublicIPAddress) MarshalJSON 

func (p PublicIPAddress) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublicIPAddress.

type PublicIPAddressDNSSettings 

type PublicIPAddressDNSSettings struct {
	// 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"`

	// The 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"`

	// 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 

type PublicIPAddressListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of public IP addresses that exists in a resource group.
	Value []*PublicIPAddress `json:"value,omitempty"`
}

PublicIPAddressListResult - Response for ListPublicIpAddresses API service call.

func (PublicIPAddressListResult) MarshalJSON 

func (p PublicIPAddressListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublicIPAddressListResult.

type PublicIPAddressMigrationPhase 

type PublicIPAddressMigrationPhase string

PublicIPAddressMigrationPhase - Migration phase of Public IP Address. 

const (
	PublicIPAddressMigrationPhaseAbort     PublicIPAddressMigrationPhase = "Abort"
	PublicIPAddressMigrationPhaseCommit    PublicIPAddressMigrationPhase = "Commit"
	PublicIPAddressMigrationPhaseCommitted PublicIPAddressMigrationPhase = "Committed"
	PublicIPAddressMigrationPhaseNone      PublicIPAddressMigrationPhase = "None"
	PublicIPAddressMigrationPhasePrepare   PublicIPAddressMigrationPhase = "Prepare"
)

func PossiblePublicIPAddressMigrationPhaseValues 

func PossiblePublicIPAddressMigrationPhaseValues() []PublicIPAddressMigrationPhase

PossiblePublicIPAddressMigrationPhaseValues returns the possible values for the PublicIPAddressMigrationPhase const type.

func (PublicIPAddressMigrationPhase) ToPtr 

func (c PublicIPAddressMigrationPhase) ToPtr() *PublicIPAddressMigrationPhase

ToPtr returns a *PublicIPAddressMigrationPhase pointing to the current value.

type PublicIPAddressPropertiesFormat 

type PublicIPAddressPropertiesFormat struct {
	// The FQDN of the DNS record associated with the public IP address.
	DNSSettings *PublicIPAddressDNSSettings `json:"dnsSettings,omitempty"`

	// The DDoS protection custom policy associated with the public IP address.
	DdosSettings *DdosSettings `json:"ddosSettings,omitempty"`

	// Specify what happens to the public IP address when the VM using it is deleted
	DeleteOption *DeleteOptions `json:"deleteOption,omitempty"`

	// The IP address associated with the public IP address resource.
	IPAddress *string `json:"ipAddress,omitempty"`

	// The list of tags associated with the public IP address.
	IPTags []*IPTag `json:"ipTags,omitempty"`

	// The idle timeout of the public IP address.
	IdleTimeoutInMinutes *int32 `json:"idleTimeoutInMinutes,omitempty"`

	// The linked public IP address of the public IP address resource.
	LinkedPublicIPAddress *PublicIPAddress `json:"linkedPublicIPAddress,omitempty"`

	// Migration phase of Public IP Address.
	MigrationPhase *PublicIPAddressMigrationPhase `json:"migrationPhase,omitempty"`

	// The NatGateway for the Public IP address.
	NatGateway *NatGateway `json:"natGateway,omitempty"`

	// The public IP address version.
	PublicIPAddressVersion *IPVersion `json:"publicIPAddressVersion,omitempty"`

	// The public IP address allocation method.
	PublicIPAllocationMethod *IPAllocationMethod `json:"publicIPAllocationMethod,omitempty"`

	// The Public IP Prefix this Public IP Address should be allocated from.
	PublicIPPrefix *SubResource `json:"publicIPPrefix,omitempty"`

	// The service public IP address of the public IP address resource.
	ServicePublicIPAddress *PublicIPAddress `json:"servicePublicIPAddress,omitempty"`

	// READ-ONLY; The IP configuration associated with the public IP address.
	IPConfiguration *IPConfiguration `json:"ipConfiguration,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the public IP address resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the public IP address resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

PublicIPAddressPropertiesFormat - Public IP address properties.

func (PublicIPAddressPropertiesFormat) MarshalJSON 

func (p PublicIPAddressPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublicIPAddressPropertiesFormat.

type PublicIPAddressSKU 

type PublicIPAddressSKU struct {
	// Name of a public IP address SKU.
	Name *PublicIPAddressSKUName `json:"name,omitempty"`

	// Tier of a public IP address SKU.
	Tier *PublicIPAddressSKUTier `json:"tier,omitempty"`
}

PublicIPAddressSKU - SKU of a public IP address.

type PublicIPAddressSKUName 

type PublicIPAddressSKUName string

PublicIPAddressSKUName - Name of a public IP address SKU. 

const (
	PublicIPAddressSKUNameBasic    PublicIPAddressSKUName = "Basic"
	PublicIPAddressSKUNameStandard PublicIPAddressSKUName = "Standard"
)

func PossiblePublicIPAddressSKUNameValues 

func PossiblePublicIPAddressSKUNameValues() []PublicIPAddressSKUName

PossiblePublicIPAddressSKUNameValues returns the possible values for the PublicIPAddressSKUName const type.

func (PublicIPAddressSKUName) ToPtr 

func (c PublicIPAddressSKUName) ToPtr() *PublicIPAddressSKUName

ToPtr returns a *PublicIPAddressSKUName pointing to the current value.

type PublicIPAddressSKUTier 

type PublicIPAddressSKUTier string

PublicIPAddressSKUTier - Tier of a public IP address SKU. 

const (
	PublicIPAddressSKUTierGlobal   PublicIPAddressSKUTier = "Global"
	PublicIPAddressSKUTierRegional PublicIPAddressSKUTier = "Regional"
)

func PossiblePublicIPAddressSKUTierValues 

func PossiblePublicIPAddressSKUTierValues() []PublicIPAddressSKUTier

PossiblePublicIPAddressSKUTierValues returns the possible values for the PublicIPAddressSKUTier const type.

func (PublicIPAddressSKUTier) ToPtr 

func (c PublicIPAddressSKUTier) ToPtr() *PublicIPAddressSKUTier

ToPtr returns a *PublicIPAddressSKUTier pointing to the current value.

type PublicIPAddressesClient 

type PublicIPAddressesClient struct {
	// contains filtered or unexported fields
}

PublicIPAddressesClient contains the methods for the PublicIPAddresses group. Don't use this type directly, use NewPublicIPAddressesClient() instead.

func NewPublicIPAddressesClient 

func NewPublicIPAddressesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PublicIPAddressesClient

NewPublicIPAddressesClient creates a new instance of PublicIPAddressesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PublicIPAddressesClient) BeginCreateOrUpdate 

func (client *PublicIPAddressesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, publicIPAddressName string, parameters PublicIPAddress, options *PublicIPAddressesClientBeginCreateOrUpdateOptions) (PublicIPAddressesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a static or dynamic public IP address. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. publicIPAddressName - The name of the public IP address. parameters - Parameters supplied to the create or update public IP address operation. options - PublicIPAddressesClientBeginCreateOrUpdateOptions contains the optional parameters for the PublicIPAddressesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpAddressCreateDns.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<public-ipaddress-name>",
		armnetwork.PublicIPAddress{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.PublicIPAddressPropertiesFormat{
				DNSSettings: &armnetwork.PublicIPAddressDNSSettings{
					DomainNameLabel: to.StringPtr("<domain-name-label>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PublicIPAddressesClientCreateOrUpdateResult)
}

Output:

func (*PublicIPAddressesClient) BeginDelete 

func (client *PublicIPAddressesClient) BeginDelete(ctx context.Context, resourceGroupName string, publicIPAddressName string, options *PublicIPAddressesClientBeginDeleteOptions) (PublicIPAddressesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified public IP address. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. publicIPAddressName - The name of the public IP address. options - PublicIPAddressesClientBeginDeleteOptions contains the optional parameters for the PublicIPAddressesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpAddressDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<public-ipaddress-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PublicIPAddressesClient) Get 

func (client *PublicIPAddressesClient) Get(ctx context.Context, resourceGroupName string, publicIPAddressName string, options *PublicIPAddressesClientGetOptions) (PublicIPAddressesClientGetResponse, error)

Get - Gets the specified public IP address in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. publicIPAddressName - The name of the public IP address. options - PublicIPAddressesClientGetOptions contains the optional parameters for the PublicIPAddressesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpAddressGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<public-ipaddress-name>",
		&armnetwork.PublicIPAddressesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PublicIPAddressesClientGetResult)
}

Output:

func (*PublicIPAddressesClient) GetCloudServicePublicIPAddress 

func (client *PublicIPAddressesClient) GetCloudServicePublicIPAddress(ctx context.Context, resourceGroupName string, cloudServiceName string, roleInstanceName string, networkInterfaceName string, ipConfigurationName string, publicIPAddressName string, options *PublicIPAddressesClientGetCloudServicePublicIPAddressOptions) (PublicIPAddressesClientGetCloudServicePublicIPAddressResponse, error)

GetCloudServicePublicIPAddress - Get the specified public IP address in a cloud service. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. cloudServiceName - The name of the cloud service. roleInstanceName - The role instance name. networkInterfaceName - The name of the network interface. ipConfigurationName - The name of the IP configuration. publicIPAddressName - The name of the public IP Address. options - PublicIPAddressesClientGetCloudServicePublicIPAddressOptions contains the optional parameters for the PublicIPAddressesClient.GetCloudServicePublicIPAddress method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CloudServicePublicIpGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	res, err := client.GetCloudServicePublicIPAddress(ctx,
		"<resource-group-name>",
		"<cloud-service-name>",
		"<role-instance-name>",
		"<network-interface-name>",
		"<ip-configuration-name>",
		"<public-ipaddress-name>",
		&armnetwork.PublicIPAddressesClientGetCloudServicePublicIPAddressOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PublicIPAddressesClientGetCloudServicePublicIPAddressResult)
}

Output:

func (*PublicIPAddressesClient) GetVirtualMachineScaleSetPublicIPAddress 

func (client *PublicIPAddressesClient) GetVirtualMachineScaleSetPublicIPAddress(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, ipConfigurationName string, publicIPAddressName string, options *PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressOptions) (PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResponse, error)

GetVirtualMachineScaleSetPublicIPAddress - Get the specified public IP address in a virtual machine scale set. If the operation fails it returns an *azcore.ResponseError type. 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. ipConfigurationName - The name of the IP configuration. publicIPAddressName - The name of the public IP Address. options - PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressOptions contains the optional parameters for the PublicIPAddressesClient.GetVirtualMachineScaleSetPublicIPAddress method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VmssPublicIpGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	res, err := client.GetVirtualMachineScaleSetPublicIPAddress(ctx,
		"<resource-group-name>",
		"<virtual-machine-scale-set-name>",
		"<virtualmachine-index>",
		"<network-interface-name>",
		"<ip-configuration-name>",
		"<public-ipaddress-name>",
		&armnetwork.PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResult)
}

Output:

func (*PublicIPAddressesClient) List 

func (client *PublicIPAddressesClient) List(resourceGroupName string, options *PublicIPAddressesClientListOptions) *PublicIPAddressesClientListPager

List - Gets all public IP addresses in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - PublicIPAddressesClientListOptions contains the optional parameters for the PublicIPAddressesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpAddressList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PublicIPAddressesClient) ListAll 

func (client *PublicIPAddressesClient) ListAll(options *PublicIPAddressesClientListAllOptions) *PublicIPAddressesClientListAllPager

ListAll - Gets all the public IP addresses in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - PublicIPAddressesClientListAllOptions contains the optional parameters for the PublicIPAddressesClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpAddressListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PublicIPAddressesClient) ListCloudServicePublicIPAddresses 

func (client *PublicIPAddressesClient) ListCloudServicePublicIPAddresses(resourceGroupName string, cloudServiceName string, options *PublicIPAddressesClientListCloudServicePublicIPAddressesOptions) *PublicIPAddressesClientListCloudServicePublicIPAddressesPager

ListCloudServicePublicIPAddresses - Gets information about all public IP addresses on a cloud service level. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. cloudServiceName - The name of the cloud service. options - PublicIPAddressesClientListCloudServicePublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListCloudServicePublicIPAddresses method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CloudServicePublicIpListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	pager := client.ListCloudServicePublicIPAddresses("<resource-group-name>",
		"<cloud-service-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PublicIPAddressesClient) ListCloudServiceRoleInstancePublicIPAddresses 

func (client *PublicIPAddressesClient) ListCloudServiceRoleInstancePublicIPAddresses(resourceGroupName string, cloudServiceName string, roleInstanceName string, networkInterfaceName string, ipConfigurationName string, options *PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesOptions) *PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesPager

ListCloudServiceRoleInstancePublicIPAddresses - Gets information about all public IP addresses in a role instance IP configuration in a cloud service. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. cloudServiceName - The name of the cloud service. roleInstanceName - The name of role instance. networkInterfaceName - The network interface name. ipConfigurationName - The IP configuration name. options - PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListCloudServiceRoleInstancePublicIPAddresses method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/CloudServiceRoleInstancePublicIpList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	pager := client.ListCloudServiceRoleInstancePublicIPAddresses("<resource-group-name>",
		"<cloud-service-name>",
		"<role-instance-name>",
		"<network-interface-name>",
		"<ip-configuration-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PublicIPAddressesClient) ListVirtualMachineScaleSetPublicIPAddresses 

func (client *PublicIPAddressesClient) ListVirtualMachineScaleSetPublicIPAddresses(resourceGroupName string, virtualMachineScaleSetName string, options *PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesOptions) *PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesPager

ListVirtualMachineScaleSetPublicIPAddresses - Gets information about all public IP addresses on a virtual machine scale set level. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualMachineScaleSetName - The name of the virtual machine scale set. options - PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListVirtualMachineScaleSetPublicIPAddresses method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VmssPublicIpListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	pager := client.ListVirtualMachineScaleSetPublicIPAddresses("<resource-group-name>",
		"<virtual-machine-scale-set-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PublicIPAddressesClient) ListVirtualMachineScaleSetVMPublicIPAddresses 

func (client *PublicIPAddressesClient) ListVirtualMachineScaleSetVMPublicIPAddresses(resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, ipConfigurationName string, options *PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesOptions) *PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesPager

ListVirtualMachineScaleSetVMPublicIPAddresses - Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualMachineScaleSetName - The name of the virtual machine scale set. virtualmachineIndex - The virtual machine index. networkInterfaceName - The network interface name. ipConfigurationName - The IP configuration name. options - PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListVirtualMachineScaleSetVMPublicIPAddresses method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VmssVmPublicIpList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	pager := client.ListVirtualMachineScaleSetVMPublicIPAddresses("<resource-group-name>",
		"<virtual-machine-scale-set-name>",
		"<virtualmachine-index>",
		"<network-interface-name>",
		"<ip-configuration-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PublicIPAddressesClient) UpdateTags 

func (client *PublicIPAddressesClient) UpdateTags(ctx context.Context, resourceGroupName string, publicIPAddressName string, parameters TagsObject, options *PublicIPAddressesClientUpdateTagsOptions) (PublicIPAddressesClientUpdateTagsResponse, error)

UpdateTags - Updates public IP address tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. publicIPAddressName - The name of the public IP address. parameters - Parameters supplied to update public IP address tags. options - PublicIPAddressesClientUpdateTagsOptions contains the optional parameters for the PublicIPAddressesClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpAddressUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPAddressesClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<public-ipaddress-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PublicIPAddressesClientUpdateTagsResult)
}

Output:

type PublicIPAddressesClientBeginCreateOrUpdateOptions added in v0.3.0 

type PublicIPAddressesClientBeginCreateOrUpdateOptions struct {
}

PublicIPAddressesClientBeginCreateOrUpdateOptions contains the optional parameters for the PublicIPAddressesClient.BeginCreateOrUpdate method.

type PublicIPAddressesClientBeginDeleteOptions added in v0.3.0 

type PublicIPAddressesClientBeginDeleteOptions struct {
}

PublicIPAddressesClientBeginDeleteOptions contains the optional parameters for the PublicIPAddressesClient.BeginDelete method.

type PublicIPAddressesClientCreateOrUpdatePoller added in v0.3.0 

type PublicIPAddressesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

PublicIPAddressesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PublicIPAddressesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *PublicIPAddressesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PublicIPAddressesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *PublicIPAddressesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (PublicIPAddressesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PublicIPAddressesClientCreateOrUpdateResponse will be returned.

func (*PublicIPAddressesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *PublicIPAddressesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PublicIPAddressesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *PublicIPAddressesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PublicIPAddressesClientCreateOrUpdatePollerResponse added in v0.3.0 

type PublicIPAddressesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PublicIPAddressesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientCreateOrUpdatePollerResponse contains the response from method PublicIPAddressesClient.CreateOrUpdate.

func (PublicIPAddressesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l PublicIPAddressesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PublicIPAddressesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PublicIPAddressesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *PublicIPAddressesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *PublicIPAddressesClient, token string) error

Resume rehydrates a PublicIPAddressesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type PublicIPAddressesClientCreateOrUpdateResponse added in v0.3.0 

type PublicIPAddressesClientCreateOrUpdateResponse struct {
	PublicIPAddressesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientCreateOrUpdateResponse contains the response from method PublicIPAddressesClient.CreateOrUpdate.

type PublicIPAddressesClientCreateOrUpdateResult added in v0.3.0 

type PublicIPAddressesClientCreateOrUpdateResult struct {
	PublicIPAddress
}

PublicIPAddressesClientCreateOrUpdateResult contains the result from method PublicIPAddressesClient.CreateOrUpdate.

type PublicIPAddressesClientDeletePoller added in v0.3.0 

type PublicIPAddressesClientDeletePoller struct {
	// contains filtered or unexported fields
}

PublicIPAddressesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PublicIPAddressesClientDeletePoller) Done added in v0.3.0 

func (p *PublicIPAddressesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PublicIPAddressesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *PublicIPAddressesClientDeletePoller) FinalResponse(ctx context.Context) (PublicIPAddressesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PublicIPAddressesClientDeleteResponse will be returned.

func (*PublicIPAddressesClientDeletePoller) Poll added in v0.3.0 

func (p *PublicIPAddressesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PublicIPAddressesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *PublicIPAddressesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PublicIPAddressesClientDeletePollerResponse added in v0.3.0 

type PublicIPAddressesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PublicIPAddressesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientDeletePollerResponse contains the response from method PublicIPAddressesClient.Delete.

func (PublicIPAddressesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l PublicIPAddressesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PublicIPAddressesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PublicIPAddressesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *PublicIPAddressesClientDeletePollerResponse) Resume(ctx context.Context, client *PublicIPAddressesClient, token string) error

Resume rehydrates a PublicIPAddressesClientDeletePollerResponse from the provided client and resume token.

type PublicIPAddressesClientDeleteResponse added in v0.3.0 

type PublicIPAddressesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientDeleteResponse contains the response from method PublicIPAddressesClient.Delete.

type PublicIPAddressesClientGetCloudServicePublicIPAddressOptions added in v0.3.0 

type PublicIPAddressesClientGetCloudServicePublicIPAddressOptions struct {
	// Expands referenced resources.
	Expand *string
}

PublicIPAddressesClientGetCloudServicePublicIPAddressOptions contains the optional parameters for the PublicIPAddressesClient.GetCloudServicePublicIPAddress method.

type PublicIPAddressesClientGetCloudServicePublicIPAddressResponse added in v0.3.0 

type PublicIPAddressesClientGetCloudServicePublicIPAddressResponse struct {
	PublicIPAddressesClientGetCloudServicePublicIPAddressResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientGetCloudServicePublicIPAddressResponse contains the response from method PublicIPAddressesClient.GetCloudServicePublicIPAddress.

type PublicIPAddressesClientGetCloudServicePublicIPAddressResult added in v0.3.0 

type PublicIPAddressesClientGetCloudServicePublicIPAddressResult struct {
	PublicIPAddress
}

PublicIPAddressesClientGetCloudServicePublicIPAddressResult contains the result from method PublicIPAddressesClient.GetCloudServicePublicIPAddress.

type PublicIPAddressesClientGetOptions added in v0.3.0 

type PublicIPAddressesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

PublicIPAddressesClientGetOptions contains the optional parameters for the PublicIPAddressesClient.Get method.

type PublicIPAddressesClientGetResponse added in v0.3.0 

type PublicIPAddressesClientGetResponse struct {
	PublicIPAddressesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientGetResponse contains the response from method PublicIPAddressesClient.Get.

type PublicIPAddressesClientGetResult added in v0.3.0 

type PublicIPAddressesClientGetResult struct {
	PublicIPAddress
}

PublicIPAddressesClientGetResult contains the result from method PublicIPAddressesClient.Get.

type PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressOptions added in v0.3.0 

type PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressOptions struct {
	// Expands referenced resources.
	Expand *string
}

PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressOptions contains the optional parameters for the PublicIPAddressesClient.GetVirtualMachineScaleSetPublicIPAddress method.

type PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResponse added in v0.3.0 

type PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResponse struct {
	PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResponse contains the response from method PublicIPAddressesClient.GetVirtualMachineScaleSetPublicIPAddress.

type PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResult added in v0.3.0 

type PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResult struct {
	PublicIPAddress
}

PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResult contains the result from method PublicIPAddressesClient.GetVirtualMachineScaleSetPublicIPAddress.

type PublicIPAddressesClientListAllOptions added in v0.3.0 

type PublicIPAddressesClientListAllOptions struct {
}

PublicIPAddressesClientListAllOptions contains the optional parameters for the PublicIPAddressesClient.ListAll method.

type PublicIPAddressesClientListAllPager added in v0.3.0 

type PublicIPAddressesClientListAllPager struct {
	// contains filtered or unexported fields
}

PublicIPAddressesClientListAllPager provides operations for iterating over paged responses.

func (*PublicIPAddressesClientListAllPager) Err added in v0.3.0 

func (p *PublicIPAddressesClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*PublicIPAddressesClientListAllPager) NextPage added in v0.3.0 

func (p *PublicIPAddressesClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PublicIPAddressesClientListAllPager) PageResponse added in v0.3.0 

func (p *PublicIPAddressesClientListAllPager) PageResponse() PublicIPAddressesClientListAllResponse

PageResponse returns the current PublicIPAddressesClientListAllResponse page.

type PublicIPAddressesClientListAllResponse added in v0.3.0 

type PublicIPAddressesClientListAllResponse struct {
	PublicIPAddressesClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientListAllResponse contains the response from method PublicIPAddressesClient.ListAll.

type PublicIPAddressesClientListAllResult added in v0.3.0 

type PublicIPAddressesClientListAllResult struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListAllResult contains the result from method PublicIPAddressesClient.ListAll.

type PublicIPAddressesClientListCloudServicePublicIPAddressesOptions added in v0.3.0 

type PublicIPAddressesClientListCloudServicePublicIPAddressesOptions struct {
}

PublicIPAddressesClientListCloudServicePublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListCloudServicePublicIPAddresses method.

type PublicIPAddressesClientListCloudServicePublicIPAddressesPager added in v0.3.0 

type PublicIPAddressesClientListCloudServicePublicIPAddressesPager struct {
	// contains filtered or unexported fields
}

PublicIPAddressesClientListCloudServicePublicIPAddressesPager provides operations for iterating over paged responses.

func (*PublicIPAddressesClientListCloudServicePublicIPAddressesPager) Err added in v0.3.0 

func (p *PublicIPAddressesClientListCloudServicePublicIPAddressesPager) Err() error

Err returns the last error encountered while paging.

func (*PublicIPAddressesClientListCloudServicePublicIPAddressesPager) NextPage added in v0.3.0 

func (p *PublicIPAddressesClientListCloudServicePublicIPAddressesPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PublicIPAddressesClientListCloudServicePublicIPAddressesPager) PageResponse added in v0.3.0 

func (p *PublicIPAddressesClientListCloudServicePublicIPAddressesPager) PageResponse() PublicIPAddressesClientListCloudServicePublicIPAddressesResponse

PageResponse returns the current PublicIPAddressesClientListCloudServicePublicIPAddressesResponse page.

type PublicIPAddressesClientListCloudServicePublicIPAddressesResponse added in v0.3.0 

type PublicIPAddressesClientListCloudServicePublicIPAddressesResponse struct {
	PublicIPAddressesClientListCloudServicePublicIPAddressesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientListCloudServicePublicIPAddressesResponse contains the response from method PublicIPAddressesClient.ListCloudServicePublicIPAddresses.

type PublicIPAddressesClientListCloudServicePublicIPAddressesResult added in v0.3.0 

type PublicIPAddressesClientListCloudServicePublicIPAddressesResult struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListCloudServicePublicIPAddressesResult contains the result from method PublicIPAddressesClient.ListCloudServicePublicIPAddresses.

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesOptions added in v0.3.0 

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesOptions struct {
}

PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListCloudServiceRoleInstancePublicIPAddresses method.

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesPager added in v0.3.0 

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesPager struct {
	// contains filtered or unexported fields
}

PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesPager provides operations for iterating over paged responses.

func (*PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesPager) Err added in v0.3.0 

func (p *PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesPager) Err() error

Err returns the last error encountered while paging.

func (*PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesPager) NextPage added in v0.3.0 

func (p *PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesPager) PageResponse added in v0.3.0 

func (p *PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesPager) PageResponse() PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResponse

PageResponse returns the current PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResponse page.

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResponse added in v0.3.0 

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResponse struct {
	PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResponse contains the response from method PublicIPAddressesClient.ListCloudServiceRoleInstancePublicIPAddresses.

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResult added in v0.3.0 

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResult struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResult contains the result from method PublicIPAddressesClient.ListCloudServiceRoleInstancePublicIPAddresses.

type PublicIPAddressesClientListOptions added in v0.3.0 

type PublicIPAddressesClientListOptions struct {
}

PublicIPAddressesClientListOptions contains the optional parameters for the PublicIPAddressesClient.List method.

type PublicIPAddressesClientListPager added in v0.3.0 

type PublicIPAddressesClientListPager struct {
	// contains filtered or unexported fields
}

PublicIPAddressesClientListPager provides operations for iterating over paged responses.

func (*PublicIPAddressesClientListPager) Err added in v0.3.0 

func (p *PublicIPAddressesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*PublicIPAddressesClientListPager) NextPage added in v0.3.0 

func (p *PublicIPAddressesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PublicIPAddressesClientListPager) PageResponse added in v0.3.0 

func (p *PublicIPAddressesClientListPager) PageResponse() PublicIPAddressesClientListResponse

PageResponse returns the current PublicIPAddressesClientListResponse page.

type PublicIPAddressesClientListResponse added in v0.3.0 

type PublicIPAddressesClientListResponse struct {
	PublicIPAddressesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientListResponse contains the response from method PublicIPAddressesClient.List.

type PublicIPAddressesClientListResult added in v0.3.0 

type PublicIPAddressesClientListResult struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListResult contains the result from method PublicIPAddressesClient.List.

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesOptions added in v0.3.0 

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesOptions struct {
}

PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListVirtualMachineScaleSetPublicIPAddresses method.

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesPager added in v0.3.0 

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesPager struct {
	// contains filtered or unexported fields
}

PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesPager provides operations for iterating over paged responses.

func (*PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesPager) Err added in v0.3.0 

func (p *PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesPager) Err() error

Err returns the last error encountered while paging.

func (*PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesPager) NextPage added in v0.3.0 

func (p *PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesPager) PageResponse added in v0.3.0 

func (p *PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesPager) PageResponse() PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResponse

PageResponse returns the current PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResponse page.

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResponse added in v0.3.0 

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResponse struct {
	PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResponse contains the response from method PublicIPAddressesClient.ListVirtualMachineScaleSetPublicIPAddresses.

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResult added in v0.3.0 

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResult struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResult contains the result from method PublicIPAddressesClient.ListVirtualMachineScaleSetPublicIPAddresses.

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesOptions added in v0.3.0 

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesOptions struct {
}

PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListVirtualMachineScaleSetVMPublicIPAddresses method.

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesPager added in v0.3.0 

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesPager struct {
	// contains filtered or unexported fields
}

PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesPager provides operations for iterating over paged responses.

func (*PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesPager) Err added in v0.3.0 

func (p *PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesPager) Err() error

Err returns the last error encountered while paging.

func (*PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesPager) NextPage added in v0.3.0 

func (p *PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesPager) PageResponse added in v0.3.0 

func (p *PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesPager) PageResponse() PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResponse

PageResponse returns the current PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResponse page.

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResponse added in v0.3.0 

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResponse struct {
	PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResponse contains the response from method PublicIPAddressesClient.ListVirtualMachineScaleSetVMPublicIPAddresses.

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResult added in v0.3.0 

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResult struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResult contains the result from method PublicIPAddressesClient.ListVirtualMachineScaleSetVMPublicIPAddresses.

type PublicIPAddressesClientUpdateTagsOptions added in v0.3.0 

type PublicIPAddressesClientUpdateTagsOptions struct {
}

PublicIPAddressesClientUpdateTagsOptions contains the optional parameters for the PublicIPAddressesClient.UpdateTags method.

type PublicIPAddressesClientUpdateTagsResponse added in v0.3.0 

type PublicIPAddressesClientUpdateTagsResponse struct {
	PublicIPAddressesClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPAddressesClientUpdateTagsResponse contains the response from method PublicIPAddressesClient.UpdateTags.

type PublicIPAddressesClientUpdateTagsResult added in v0.3.0 

type PublicIPAddressesClientUpdateTagsResult struct {
	PublicIPAddress
}

PublicIPAddressesClientUpdateTagsResult contains the result from method PublicIPAddressesClient.UpdateTags.

type PublicIPPrefix 

type PublicIPPrefix struct {
	// The extended location of the public ip address.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Public IP prefix properties.
	Properties *PublicIPPrefixPropertiesFormat `json:"properties,omitempty"`

	// The public IP prefix SKU.
	SKU *PublicIPPrefixSKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// A list of availability zones denoting the IP allocated for the resource needs to come from.
	Zones []*string `json:"zones,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PublicIPPrefix - Public IP prefix resource.

func (PublicIPPrefix) MarshalJSON 

func (p PublicIPPrefix) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublicIPPrefix.

type PublicIPPrefixListResult 

type PublicIPPrefixListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of public IP prefixes that exists in a resource group.
	Value []*PublicIPPrefix `json:"value,omitempty"`
}

PublicIPPrefixListResult - Response for ListPublicIpPrefixes API service call.

func (PublicIPPrefixListResult) MarshalJSON 

func (p PublicIPPrefixListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublicIPPrefixListResult.

type PublicIPPrefixPropertiesFormat 

type PublicIPPrefixPropertiesFormat struct {
	// The customIpPrefix that this prefix is associated with.
	CustomIPPrefix *SubResource `json:"customIPPrefix,omitempty"`

	// The list of tags associated with the public IP prefix.
	IPTags []*IPTag `json:"ipTags,omitempty"`

	// NatGateway of Public IP Prefix.
	NatGateway *NatGateway `json:"natGateway,omitempty"`

	// The Length of the Public IP Prefix.
	PrefixLength *int32 `json:"prefixLength,omitempty"`

	// The public IP address version.
	PublicIPAddressVersion *IPVersion `json:"publicIPAddressVersion,omitempty"`

	// READ-ONLY; The allocated Prefix.
	IPPrefix *string `json:"ipPrefix,omitempty" azure:"ro"`

	// READ-ONLY; The reference to load balancer frontend IP configuration associated with the public IP prefix.
	LoadBalancerFrontendIPConfiguration *SubResource `json:"loadBalancerFrontendIpConfiguration,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the public IP prefix resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The list of all referenced PublicIPAddresses.
	PublicIPAddresses []*ReferencedPublicIPAddress `json:"publicIPAddresses,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the public IP prefix resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

PublicIPPrefixPropertiesFormat - Public IP prefix properties.

func (PublicIPPrefixPropertiesFormat) MarshalJSON 

func (p PublicIPPrefixPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublicIPPrefixPropertiesFormat.

type PublicIPPrefixSKU 

type PublicIPPrefixSKU struct {
	// Name of a public IP prefix SKU.
	Name *PublicIPPrefixSKUName `json:"name,omitempty"`

	// Tier of a public IP prefix SKU.
	Tier *PublicIPPrefixSKUTier `json:"tier,omitempty"`
}

PublicIPPrefixSKU - SKU of a public IP prefix.

type PublicIPPrefixSKUName 

type PublicIPPrefixSKUName string

PublicIPPrefixSKUName - Name of a public IP prefix SKU. 

const (
	PublicIPPrefixSKUNameStandard PublicIPPrefixSKUName = "Standard"
)

func PossiblePublicIPPrefixSKUNameValues 

func PossiblePublicIPPrefixSKUNameValues() []PublicIPPrefixSKUName

PossiblePublicIPPrefixSKUNameValues returns the possible values for the PublicIPPrefixSKUName const type.

func (PublicIPPrefixSKUName) ToPtr 

func (c PublicIPPrefixSKUName) ToPtr() *PublicIPPrefixSKUName

ToPtr returns a *PublicIPPrefixSKUName pointing to the current value.

type PublicIPPrefixSKUTier 

type PublicIPPrefixSKUTier string

PublicIPPrefixSKUTier - Tier of a public IP prefix SKU. 

const (
	PublicIPPrefixSKUTierGlobal   PublicIPPrefixSKUTier = "Global"
	PublicIPPrefixSKUTierRegional PublicIPPrefixSKUTier = "Regional"
)

func PossiblePublicIPPrefixSKUTierValues 

func PossiblePublicIPPrefixSKUTierValues() []PublicIPPrefixSKUTier

PossiblePublicIPPrefixSKUTierValues returns the possible values for the PublicIPPrefixSKUTier const type.

func (PublicIPPrefixSKUTier) ToPtr 

func (c PublicIPPrefixSKUTier) ToPtr() *PublicIPPrefixSKUTier

ToPtr returns a *PublicIPPrefixSKUTier pointing to the current value.

type PublicIPPrefixesClient 

type PublicIPPrefixesClient struct {
	// contains filtered or unexported fields
}

PublicIPPrefixesClient contains the methods for the PublicIPPrefixes group. Don't use this type directly, use NewPublicIPPrefixesClient() instead.

func NewPublicIPPrefixesClient 

func NewPublicIPPrefixesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PublicIPPrefixesClient

NewPublicIPPrefixesClient creates a new instance of PublicIPPrefixesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PublicIPPrefixesClient) BeginCreateOrUpdate 

func (client *PublicIPPrefixesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, publicIPPrefixName string, parameters PublicIPPrefix, options *PublicIPPrefixesClientBeginCreateOrUpdateOptions) (PublicIPPrefixesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a static or dynamic public IP prefix. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. publicIPPrefixName - The name of the public IP prefix. parameters - Parameters supplied to the create or update public IP prefix operation. options - PublicIPPrefixesClientBeginCreateOrUpdateOptions contains the optional parameters for the PublicIPPrefixesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpPrefixCreateCustomizedValues.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPPrefixesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<public-ipprefix-name>",
		armnetwork.PublicIPPrefix{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.PublicIPPrefixPropertiesFormat{
				PrefixLength:           to.Int32Ptr(30),
				PublicIPAddressVersion: armnetwork.IPVersion("IPv4").ToPtr(),
			},
			SKU: &armnetwork.PublicIPPrefixSKU{
				Name: armnetwork.PublicIPPrefixSKUName("Standard").ToPtr(),
				Tier: armnetwork.PublicIPPrefixSKUTier("Regional").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PublicIPPrefixesClientCreateOrUpdateResult)
}

Output:

func (*PublicIPPrefixesClient) BeginDelete 

func (client *PublicIPPrefixesClient) BeginDelete(ctx context.Context, resourceGroupName string, publicIPPrefixName string, options *PublicIPPrefixesClientBeginDeleteOptions) (PublicIPPrefixesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified public IP prefix. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. publicIPPrefixName - The name of the PublicIpPrefix. options - PublicIPPrefixesClientBeginDeleteOptions contains the optional parameters for the PublicIPPrefixesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpPrefixDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPPrefixesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<public-ipprefix-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PublicIPPrefixesClient) Get 

func (client *PublicIPPrefixesClient) Get(ctx context.Context, resourceGroupName string, publicIPPrefixName string, options *PublicIPPrefixesClientGetOptions) (PublicIPPrefixesClientGetResponse, error)

Get - Gets the specified public IP prefix in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. publicIPPrefixName - The name of the public IP prefix. options - PublicIPPrefixesClientGetOptions contains the optional parameters for the PublicIPPrefixesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpPrefixGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPPrefixesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<public-ipprefix-name>",
		&armnetwork.PublicIPPrefixesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PublicIPPrefixesClientGetResult)
}

Output:

func (*PublicIPPrefixesClient) List 

func (client *PublicIPPrefixesClient) List(resourceGroupName string, options *PublicIPPrefixesClientListOptions) *PublicIPPrefixesClientListPager

List - Gets all public IP prefixes in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - PublicIPPrefixesClientListOptions contains the optional parameters for the PublicIPPrefixesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpPrefixList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPPrefixesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PublicIPPrefixesClient) ListAll 

func (client *PublicIPPrefixesClient) ListAll(options *PublicIPPrefixesClientListAllOptions) *PublicIPPrefixesClientListAllPager

ListAll - Gets all the public IP prefixes in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - PublicIPPrefixesClientListAllOptions contains the optional parameters for the PublicIPPrefixesClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpPrefixListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPPrefixesClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PublicIPPrefixesClient) UpdateTags 

func (client *PublicIPPrefixesClient) UpdateTags(ctx context.Context, resourceGroupName string, publicIPPrefixName string, parameters TagsObject, options *PublicIPPrefixesClientUpdateTagsOptions) (PublicIPPrefixesClientUpdateTagsResponse, error)

UpdateTags - Updates public IP prefix tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. publicIPPrefixName - The name of the public IP prefix. parameters - Parameters supplied to update public IP prefix tags. options - PublicIPPrefixesClientUpdateTagsOptions contains the optional parameters for the PublicIPPrefixesClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/PublicIpPrefixUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewPublicIPPrefixesClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<public-ipprefix-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PublicIPPrefixesClientUpdateTagsResult)
}

Output:

type PublicIPPrefixesClientBeginCreateOrUpdateOptions added in v0.3.0 

type PublicIPPrefixesClientBeginCreateOrUpdateOptions struct {
}

PublicIPPrefixesClientBeginCreateOrUpdateOptions contains the optional parameters for the PublicIPPrefixesClient.BeginCreateOrUpdate method.

type PublicIPPrefixesClientBeginDeleteOptions added in v0.3.0 

type PublicIPPrefixesClientBeginDeleteOptions struct {
}

PublicIPPrefixesClientBeginDeleteOptions contains the optional parameters for the PublicIPPrefixesClient.BeginDelete method.

type PublicIPPrefixesClientCreateOrUpdatePoller added in v0.3.0 

type PublicIPPrefixesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

PublicIPPrefixesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PublicIPPrefixesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *PublicIPPrefixesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PublicIPPrefixesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *PublicIPPrefixesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (PublicIPPrefixesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PublicIPPrefixesClientCreateOrUpdateResponse will be returned.

func (*PublicIPPrefixesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *PublicIPPrefixesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PublicIPPrefixesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *PublicIPPrefixesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PublicIPPrefixesClientCreateOrUpdatePollerResponse added in v0.3.0 

type PublicIPPrefixesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PublicIPPrefixesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPPrefixesClientCreateOrUpdatePollerResponse contains the response from method PublicIPPrefixesClient.CreateOrUpdate.

func (PublicIPPrefixesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l PublicIPPrefixesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PublicIPPrefixesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PublicIPPrefixesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *PublicIPPrefixesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *PublicIPPrefixesClient, token string) error

Resume rehydrates a PublicIPPrefixesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type PublicIPPrefixesClientCreateOrUpdateResponse added in v0.3.0 

type PublicIPPrefixesClientCreateOrUpdateResponse struct {
	PublicIPPrefixesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPPrefixesClientCreateOrUpdateResponse contains the response from method PublicIPPrefixesClient.CreateOrUpdate.

type PublicIPPrefixesClientCreateOrUpdateResult added in v0.3.0 

type PublicIPPrefixesClientCreateOrUpdateResult struct {
	PublicIPPrefix
}

PublicIPPrefixesClientCreateOrUpdateResult contains the result from method PublicIPPrefixesClient.CreateOrUpdate.

type PublicIPPrefixesClientDeletePoller added in v0.3.0 

type PublicIPPrefixesClientDeletePoller struct {
	// contains filtered or unexported fields
}

PublicIPPrefixesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PublicIPPrefixesClientDeletePoller) Done added in v0.3.0 

func (p *PublicIPPrefixesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PublicIPPrefixesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *PublicIPPrefixesClientDeletePoller) FinalResponse(ctx context.Context) (PublicIPPrefixesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PublicIPPrefixesClientDeleteResponse will be returned.

func (*PublicIPPrefixesClientDeletePoller) Poll added in v0.3.0 

func (p *PublicIPPrefixesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PublicIPPrefixesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *PublicIPPrefixesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PublicIPPrefixesClientDeletePollerResponse added in v0.3.0 

type PublicIPPrefixesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PublicIPPrefixesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPPrefixesClientDeletePollerResponse contains the response from method PublicIPPrefixesClient.Delete.

func (PublicIPPrefixesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l PublicIPPrefixesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PublicIPPrefixesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PublicIPPrefixesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *PublicIPPrefixesClientDeletePollerResponse) Resume(ctx context.Context, client *PublicIPPrefixesClient, token string) error

Resume rehydrates a PublicIPPrefixesClientDeletePollerResponse from the provided client and resume token.

type PublicIPPrefixesClientDeleteResponse added in v0.3.0 

type PublicIPPrefixesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPPrefixesClientDeleteResponse contains the response from method PublicIPPrefixesClient.Delete.

type PublicIPPrefixesClientGetOptions added in v0.3.0 

type PublicIPPrefixesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

PublicIPPrefixesClientGetOptions contains the optional parameters for the PublicIPPrefixesClient.Get method.

type PublicIPPrefixesClientGetResponse added in v0.3.0 

type PublicIPPrefixesClientGetResponse struct {
	PublicIPPrefixesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPPrefixesClientGetResponse contains the response from method PublicIPPrefixesClient.Get.

type PublicIPPrefixesClientGetResult added in v0.3.0 

type PublicIPPrefixesClientGetResult struct {
	PublicIPPrefix
}

PublicIPPrefixesClientGetResult contains the result from method PublicIPPrefixesClient.Get.

type PublicIPPrefixesClientListAllOptions added in v0.3.0 

type PublicIPPrefixesClientListAllOptions struct {
}

PublicIPPrefixesClientListAllOptions contains the optional parameters for the PublicIPPrefixesClient.ListAll method.

type PublicIPPrefixesClientListAllPager added in v0.3.0 

type PublicIPPrefixesClientListAllPager struct {
	// contains filtered or unexported fields
}

PublicIPPrefixesClientListAllPager provides operations for iterating over paged responses.

func (*PublicIPPrefixesClientListAllPager) Err added in v0.3.0 

func (p *PublicIPPrefixesClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*PublicIPPrefixesClientListAllPager) NextPage added in v0.3.0 

func (p *PublicIPPrefixesClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PublicIPPrefixesClientListAllPager) PageResponse added in v0.3.0 

func (p *PublicIPPrefixesClientListAllPager) PageResponse() PublicIPPrefixesClientListAllResponse

PageResponse returns the current PublicIPPrefixesClientListAllResponse page.

type PublicIPPrefixesClientListAllResponse added in v0.3.0 

type PublicIPPrefixesClientListAllResponse struct {
	PublicIPPrefixesClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPPrefixesClientListAllResponse contains the response from method PublicIPPrefixesClient.ListAll.

type PublicIPPrefixesClientListAllResult added in v0.3.0 

type PublicIPPrefixesClientListAllResult struct {
	PublicIPPrefixListResult
}

PublicIPPrefixesClientListAllResult contains the result from method PublicIPPrefixesClient.ListAll.

type PublicIPPrefixesClientListOptions added in v0.3.0 

type PublicIPPrefixesClientListOptions struct {
}

PublicIPPrefixesClientListOptions contains the optional parameters for the PublicIPPrefixesClient.List method.

type PublicIPPrefixesClientListPager added in v0.3.0 

type PublicIPPrefixesClientListPager struct {
	// contains filtered or unexported fields
}

PublicIPPrefixesClientListPager provides operations for iterating over paged responses.

func (*PublicIPPrefixesClientListPager) Err added in v0.3.0 

func (p *PublicIPPrefixesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*PublicIPPrefixesClientListPager) NextPage added in v0.3.0 

func (p *PublicIPPrefixesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PublicIPPrefixesClientListPager) PageResponse added in v0.3.0 

func (p *PublicIPPrefixesClientListPager) PageResponse() PublicIPPrefixesClientListResponse

PageResponse returns the current PublicIPPrefixesClientListResponse page.

type PublicIPPrefixesClientListResponse added in v0.3.0 

type PublicIPPrefixesClientListResponse struct {
	PublicIPPrefixesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPPrefixesClientListResponse contains the response from method PublicIPPrefixesClient.List.

type PublicIPPrefixesClientListResult added in v0.3.0 

type PublicIPPrefixesClientListResult struct {
	PublicIPPrefixListResult
}

PublicIPPrefixesClientListResult contains the result from method PublicIPPrefixesClient.List.

type PublicIPPrefixesClientUpdateTagsOptions added in v0.3.0 

type PublicIPPrefixesClientUpdateTagsOptions struct {
}

PublicIPPrefixesClientUpdateTagsOptions contains the optional parameters for the PublicIPPrefixesClient.UpdateTags method.

type PublicIPPrefixesClientUpdateTagsResponse added in v0.3.0 

type PublicIPPrefixesClientUpdateTagsResponse struct {
	PublicIPPrefixesClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PublicIPPrefixesClientUpdateTagsResponse contains the response from method PublicIPPrefixesClient.UpdateTags.

type PublicIPPrefixesClientUpdateTagsResult added in v0.3.0 

type PublicIPPrefixesClientUpdateTagsResult struct {
	PublicIPPrefix
}

PublicIPPrefixesClientUpdateTagsResult contains the result from method PublicIPPrefixesClient.UpdateTags.

type QosDefinition 

type QosDefinition struct {
	// Destination IP ranges.
	DestinationIPRanges []*QosIPRange `json:"destinationIpRanges,omitempty"`

	// Destination port ranges.
	DestinationPortRanges []*QosPortRange `json:"destinationPortRanges,omitempty"`

	// List of markings to be used in the configuration.
	Markings []*int32 `json:"markings,omitempty"`

	// RNM supported protocol types.
	Protocol *ProtocolType `json:"protocol,omitempty"`

	// Source IP ranges.
	SourceIPRanges []*QosIPRange `json:"sourceIpRanges,omitempty"`

	// Sources port ranges.
	SourcePortRanges []*QosPortRange `json:"sourcePortRanges,omitempty"`
}

QosDefinition - Quality of Service defines the traffic configuration between endpoints. Mandatory to have one marking.

func (QosDefinition) MarshalJSON 

func (q QosDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QosDefinition.

type QosIPRange 

type QosIPRange struct {
	// End IP Address.
	EndIP *string `json:"endIP,omitempty"`

	// Start IP Address.
	StartIP *string `json:"startIP,omitempty"`
}

QosIPRange - Qos Traffic Profiler IP Range properties.

type QosPortRange 

type QosPortRange struct {
	// Qos Port Range end.
	End *int32 `json:"end,omitempty"`

	// Qos Port Range start.
	Start *int32 `json:"start,omitempty"`
}

QosPortRange - Qos Traffic Profiler Port range properties.

type QueryInboundNatRulePortMappingRequest added in v0.2.0 

type QueryInboundNatRulePortMappingRequest struct {
	// IP address set in load balancer backend address.
	IPAddress *string `json:"ipAddress,omitempty"`

	// NetworkInterfaceIPConfiguration set in load balancer backend address.
	IPConfiguration *SubResource `json:"ipConfiguration,omitempty"`
}

QueryInboundNatRulePortMappingRequest - The request for a QueryInboundNatRulePortMapping API. Either IpConfiguration or IpAddress should be set

type QueryResults added in v0.2.0 

type QueryResults struct {
	// Number of total records matching the query.
	MatchingRecordsCount *int64 `json:"matchingRecordsCount,omitempty"`

	// Array containing the results of the query
	Signatures []*SingleQueryResult `json:"signatures,omitempty"`
}

QueryResults - Query result

func (QueryResults) MarshalJSON added in v0.2.0 

func (q QueryResults) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QueryResults.

type QueryTroubleshootingParameters 

type QueryTroubleshootingParameters struct {
	// REQUIRED; The target resource ID to query the troubleshooting result.
	TargetResourceID *string `json:"targetResourceId,omitempty"`
}

QueryTroubleshootingParameters - Parameters that define the resource to query the troubleshooting result.

type RadiusServer 

type RadiusServer struct {
	// REQUIRED; The address of this radius server.
	RadiusServerAddress *string `json:"radiusServerAddress,omitempty"`

	// The initial score assigned to this radius server.
	RadiusServerScore *int64 `json:"radiusServerScore,omitempty"`

	// The secret used for this radius server.
	RadiusServerSecret *string `json:"radiusServerSecret,omitempty"`
}

RadiusServer - Radius Server Settings.

type RecordSet 

type RecordSet struct {
	// Fqdn that resolves to private endpoint ip address.
	Fqdn *string `json:"fqdn,omitempty"`

	// The private ip address of the private endpoint.
	IPAddresses []*string `json:"ipAddresses,omitempty"`

	// Recordset name.
	RecordSetName *string `json:"recordSetName,omitempty"`

	// Resource record type.
	RecordType *string `json:"recordType,omitempty"`

	// Recordset time to live.
	TTL *int32 `json:"ttl,omitempty"`

	// READ-ONLY; The provisioning state of the recordset.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

RecordSet - A collective group of information about the record set information.

func (RecordSet) MarshalJSON 

func (r RecordSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecordSet.

type ReferencedPublicIPAddress 

type ReferencedPublicIPAddress struct {
	// The PublicIPAddress Reference.
	ID *string `json:"id,omitempty"`
}

ReferencedPublicIPAddress - Reference to a public IP address.

type Resource 

type Resource struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common resource representation.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType - The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. 

const (
	ResourceIdentityTypeSystemAssigned             ResourceIdentityType = "SystemAssigned"
	ResourceIdentityTypeUserAssigned               ResourceIdentityType = "UserAssigned"
	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
	ResourceIdentityTypeNone                       ResourceIdentityType = "None"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

func (ResourceIdentityType) ToPtr 

func (c ResourceIdentityType) ToPtr() *ResourceIdentityType

ToPtr returns a *ResourceIdentityType pointing to the current value. 

type ResourceNavigationLink struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Resource navigation link properties format.
	Properties *ResourceNavigationLinkFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ResourceNavigationLink resource.

type ResourceNavigationLinkFormat 

type ResourceNavigationLinkFormat struct {
	// Link to the external resource.
	Link *string `json:"link,omitempty"`

	// Resource type of the linked resource.
	LinkedResourceType *string `json:"linkedResourceType,omitempty"`

	// READ-ONLY; The provisioning state of the resource navigation link resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ResourceNavigationLinkFormat - Properties of ResourceNavigationLink.

type ResourceNavigationLinksClient 

type ResourceNavigationLinksClient struct {
	// contains filtered or unexported fields
}

ResourceNavigationLinksClient contains the methods for the ResourceNavigationLinks group. Don't use this type directly, use NewResourceNavigationLinksClient() instead.

func NewResourceNavigationLinksClient 

func NewResourceNavigationLinksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ResourceNavigationLinksClient

NewResourceNavigationLinksClient creates a new instance of ResourceNavigationLinksClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ResourceNavigationLinksClient) List 

func (client *ResourceNavigationLinksClient) List(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, options *ResourceNavigationLinksClientListOptions) (ResourceNavigationLinksClientListResponse, error)

List - Gets a list of resource navigation links for a subnet. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. subnetName - The name of the subnet. options - ResourceNavigationLinksClientListOptions contains the optional parameters for the ResourceNavigationLinksClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGetResourceNavigationLinks.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewResourceNavigationLinksClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<subnet-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ResourceNavigationLinksClientListResult)
}

Output:

type ResourceNavigationLinksClientListOptions added in v0.3.0 

type ResourceNavigationLinksClientListOptions struct {
}

ResourceNavigationLinksClientListOptions contains the optional parameters for the ResourceNavigationLinksClient.List method.

type ResourceNavigationLinksClientListResponse added in v0.3.0 

type ResourceNavigationLinksClientListResponse struct {
	ResourceNavigationLinksClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceNavigationLinksClientListResponse contains the response from method ResourceNavigationLinksClient.List.

type ResourceNavigationLinksClientListResult added in v0.3.0 

type ResourceNavigationLinksClientListResult struct {
	ResourceNavigationLinksListResult
}

ResourceNavigationLinksClientListResult contains the result from method ResourceNavigationLinksClient.List.

type ResourceNavigationLinksListResult 

type ResourceNavigationLinksListResult struct {
	// The resource navigation links in a subnet.
	Value []*ResourceNavigationLink `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ResourceNavigationLinksListResult - Response for ResourceNavigationLinks_List operation.

func (ResourceNavigationLinksListResult) MarshalJSON 

func (r ResourceNavigationLinksListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceNavigationLinksListResult.

type ResourceSet 

type ResourceSet struct {
	// The list of subscriptions.
	Subscriptions []*string `json:"subscriptions,omitempty"`
}

ResourceSet - The base resource set for visibility and auto-approval.

func (ResourceSet) MarshalJSON 

func (r ResourceSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceSet.

type RetentionPolicyParameters 

type RetentionPolicyParameters struct {
	// Number of days to retain flow log records.
	Days *int32 `json:"days,omitempty"`

	// Flag to enable/disable retention.
	Enabled *bool `json:"enabled,omitempty"`
}

RetentionPolicyParameters - Parameters that define the retention policy for flow log.

type Route 

type Route struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the route.
	Properties *RoutePropertiesFormat `json:"properties,omitempty"`

	// The type of the resource.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

Route resource.

type RouteFilter 

type RouteFilter struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the route filter.
	Properties *RouteFilterPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RouteFilter - Route Filter Resource.

func (RouteFilter) MarshalJSON 

func (r RouteFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteFilter.

type RouteFilterListResult 

type RouteFilterListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of route filters in a resource group.
	Value []*RouteFilter `json:"value,omitempty"`
}

RouteFilterListResult - Response for the ListRouteFilters API service call.

func (RouteFilterListResult) MarshalJSON 

func (r RouteFilterListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteFilterListResult.

type RouteFilterPropertiesFormat 

type RouteFilterPropertiesFormat struct {
	// Collection of RouteFilterRules contained within a route filter.
	Rules []*RouteFilterRule `json:"rules,omitempty"`

	// READ-ONLY; A collection of references to express route circuit ipv6 peerings.
	IPv6Peerings []*ExpressRouteCircuitPeering `json:"ipv6Peerings,omitempty" azure:"ro"`

	// READ-ONLY; A collection of references to express route circuit peerings.
	Peerings []*ExpressRouteCircuitPeering `json:"peerings,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the route filter resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

RouteFilterPropertiesFormat - Route Filter Resource.

func (RouteFilterPropertiesFormat) MarshalJSON 

func (r RouteFilterPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteFilterPropertiesFormat.

type RouteFilterRule 

type RouteFilterRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// 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"`

	// Properties of the route filter rule.
	Properties *RouteFilterRulePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

RouteFilterRule - Route Filter Rule Resource.

type RouteFilterRuleListResult 

type RouteFilterRuleListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of RouteFilterRules in a resource group.
	Value []*RouteFilterRule `json:"value,omitempty"`
}

RouteFilterRuleListResult - Response for the ListRouteFilterRules API service call.

func (RouteFilterRuleListResult) MarshalJSON 

func (r RouteFilterRuleListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteFilterRuleListResult.

type RouteFilterRulePropertiesFormat 

type RouteFilterRulePropertiesFormat struct {
	// REQUIRED; The access type of the rule.
	Access *Access `json:"access,omitempty"`

	// REQUIRED; The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
	Communities []*string `json:"communities,omitempty"`

	// REQUIRED; The rule type of the rule.
	RouteFilterRuleType *RouteFilterRuleType `json:"routeFilterRuleType,omitempty"`

	// READ-ONLY; The provisioning state of the route filter rule resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

RouteFilterRulePropertiesFormat - Route Filter Rule Resource.

func (RouteFilterRulePropertiesFormat) MarshalJSON 

func (r RouteFilterRulePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteFilterRulePropertiesFormat.

type RouteFilterRuleType 

type RouteFilterRuleType string

RouteFilterRuleType - The rule type of the rule. 

const (
	RouteFilterRuleTypeCommunity RouteFilterRuleType = "Community"
)

func PossibleRouteFilterRuleTypeValues 

func PossibleRouteFilterRuleTypeValues() []RouteFilterRuleType

PossibleRouteFilterRuleTypeValues returns the possible values for the RouteFilterRuleType const type.

func (RouteFilterRuleType) ToPtr 

func (c RouteFilterRuleType) ToPtr() *RouteFilterRuleType

ToPtr returns a *RouteFilterRuleType pointing to the current value.

type RouteFilterRulesClient 

type RouteFilterRulesClient struct {
	// contains filtered or unexported fields
}

RouteFilterRulesClient contains the methods for the RouteFilterRules group. Don't use this type directly, use NewRouteFilterRulesClient() instead.

func NewRouteFilterRulesClient 

func NewRouteFilterRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *RouteFilterRulesClient

NewRouteFilterRulesClient creates a new instance of RouteFilterRulesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RouteFilterRulesClient) BeginCreateOrUpdate 

func (client *RouteFilterRulesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, routeFilterName string, ruleName string, routeFilterRuleParameters RouteFilterRule, options *RouteFilterRulesClientBeginCreateOrUpdateOptions) (RouteFilterRulesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a route in the specified route filter. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeFilterName - The name of the route filter. ruleName - The name of the route filter rule. routeFilterRuleParameters - Parameters supplied to the create or update route filter rule operation. options - RouteFilterRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteFilterRulesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteFilterRuleCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteFilterRulesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<route-filter-name>",
		"<rule-name>",
		armnetwork.RouteFilterRule{
			Properties: &armnetwork.RouteFilterRulePropertiesFormat{
				Access: armnetwork.Access("Allow").ToPtr(),
				Communities: []*string{
					to.StringPtr("12076:5030"),
					to.StringPtr("12076:5040")},
				RouteFilterRuleType: armnetwork.RouteFilterRuleType("Community").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RouteFilterRulesClientCreateOrUpdateResult)
}

Output:

func (*RouteFilterRulesClient) BeginDelete 

func (client *RouteFilterRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, routeFilterName string, ruleName string, options *RouteFilterRulesClientBeginDeleteOptions) (RouteFilterRulesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified rule from a route filter. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeFilterName - The name of the route filter. ruleName - The name of the rule. options - RouteFilterRulesClientBeginDeleteOptions contains the optional parameters for the RouteFilterRulesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteFilterRuleDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteFilterRulesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<route-filter-name>",
		"<rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RouteFilterRulesClient) Get 

func (client *RouteFilterRulesClient) Get(ctx context.Context, resourceGroupName string, routeFilterName string, ruleName string, options *RouteFilterRulesClientGetOptions) (RouteFilterRulesClientGetResponse, error)

Get - Gets the specified rule from a route filter. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeFilterName - The name of the route filter. ruleName - The name of the rule. options - RouteFilterRulesClientGetOptions contains the optional parameters for the RouteFilterRulesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteFilterRuleGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteFilterRulesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<route-filter-name>",
		"<rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RouteFilterRulesClientGetResult)
}

Output:

func (*RouteFilterRulesClient) ListByRouteFilter 

func (client *RouteFilterRulesClient) ListByRouteFilter(resourceGroupName string, routeFilterName string, options *RouteFilterRulesClientListByRouteFilterOptions) *RouteFilterRulesClientListByRouteFilterPager

ListByRouteFilter - Gets all RouteFilterRules in a route filter. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeFilterName - The name of the route filter. options - RouteFilterRulesClientListByRouteFilterOptions contains the optional parameters for the RouteFilterRulesClient.ListByRouteFilter method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteFilterRuleListByRouteFilter.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteFilterRulesClient("<subscription-id>", cred, nil)
	pager := client.ListByRouteFilter("<resource-group-name>",
		"<route-filter-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RouteFilterRulesClientBeginCreateOrUpdateOptions added in v0.3.0 

type RouteFilterRulesClientBeginCreateOrUpdateOptions struct {
}

RouteFilterRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteFilterRulesClient.BeginCreateOrUpdate method.

type RouteFilterRulesClientBeginDeleteOptions added in v0.3.0 

type RouteFilterRulesClientBeginDeleteOptions struct {
}

RouteFilterRulesClientBeginDeleteOptions contains the optional parameters for the RouteFilterRulesClient.BeginDelete method.

type RouteFilterRulesClientCreateOrUpdatePoller added in v0.3.0 

type RouteFilterRulesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

RouteFilterRulesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*RouteFilterRulesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *RouteFilterRulesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RouteFilterRulesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *RouteFilterRulesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (RouteFilterRulesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RouteFilterRulesClientCreateOrUpdateResponse will be returned.

func (*RouteFilterRulesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *RouteFilterRulesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RouteFilterRulesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *RouteFilterRulesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RouteFilterRulesClientCreateOrUpdatePollerResponse added in v0.3.0 

type RouteFilterRulesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RouteFilterRulesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFilterRulesClientCreateOrUpdatePollerResponse contains the response from method RouteFilterRulesClient.CreateOrUpdate.

func (RouteFilterRulesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l RouteFilterRulesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RouteFilterRulesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RouteFilterRulesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *RouteFilterRulesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *RouteFilterRulesClient, token string) error

Resume rehydrates a RouteFilterRulesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type RouteFilterRulesClientCreateOrUpdateResponse added in v0.3.0 

type RouteFilterRulesClientCreateOrUpdateResponse struct {
	RouteFilterRulesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFilterRulesClientCreateOrUpdateResponse contains the response from method RouteFilterRulesClient.CreateOrUpdate.

type RouteFilterRulesClientCreateOrUpdateResult added in v0.3.0 

type RouteFilterRulesClientCreateOrUpdateResult struct {
	RouteFilterRule
}

RouteFilterRulesClientCreateOrUpdateResult contains the result from method RouteFilterRulesClient.CreateOrUpdate.

type RouteFilterRulesClientDeletePoller added in v0.3.0 

type RouteFilterRulesClientDeletePoller struct {
	// contains filtered or unexported fields
}

RouteFilterRulesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*RouteFilterRulesClientDeletePoller) Done added in v0.3.0 

func (p *RouteFilterRulesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RouteFilterRulesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *RouteFilterRulesClientDeletePoller) FinalResponse(ctx context.Context) (RouteFilterRulesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RouteFilterRulesClientDeleteResponse will be returned.

func (*RouteFilterRulesClientDeletePoller) Poll added in v0.3.0 

func (p *RouteFilterRulesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RouteFilterRulesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *RouteFilterRulesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RouteFilterRulesClientDeletePollerResponse added in v0.3.0 

type RouteFilterRulesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RouteFilterRulesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFilterRulesClientDeletePollerResponse contains the response from method RouteFilterRulesClient.Delete.

func (RouteFilterRulesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l RouteFilterRulesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RouteFilterRulesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RouteFilterRulesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *RouteFilterRulesClientDeletePollerResponse) Resume(ctx context.Context, client *RouteFilterRulesClient, token string) error

Resume rehydrates a RouteFilterRulesClientDeletePollerResponse from the provided client and resume token.

type RouteFilterRulesClientDeleteResponse added in v0.3.0 

type RouteFilterRulesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFilterRulesClientDeleteResponse contains the response from method RouteFilterRulesClient.Delete.

type RouteFilterRulesClientGetOptions added in v0.3.0 

type RouteFilterRulesClientGetOptions struct {
}

RouteFilterRulesClientGetOptions contains the optional parameters for the RouteFilterRulesClient.Get method.

type RouteFilterRulesClientGetResponse added in v0.3.0 

type RouteFilterRulesClientGetResponse struct {
	RouteFilterRulesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFilterRulesClientGetResponse contains the response from method RouteFilterRulesClient.Get.

type RouteFilterRulesClientGetResult added in v0.3.0 

type RouteFilterRulesClientGetResult struct {
	RouteFilterRule
}

RouteFilterRulesClientGetResult contains the result from method RouteFilterRulesClient.Get.

type RouteFilterRulesClientListByRouteFilterOptions added in v0.3.0 

type RouteFilterRulesClientListByRouteFilterOptions struct {
}

RouteFilterRulesClientListByRouteFilterOptions contains the optional parameters for the RouteFilterRulesClient.ListByRouteFilter method.

type RouteFilterRulesClientListByRouteFilterPager added in v0.3.0 

type RouteFilterRulesClientListByRouteFilterPager struct {
	// contains filtered or unexported fields
}

RouteFilterRulesClientListByRouteFilterPager provides operations for iterating over paged responses.

func (*RouteFilterRulesClientListByRouteFilterPager) Err added in v0.3.0 

func (p *RouteFilterRulesClientListByRouteFilterPager) Err() error

Err returns the last error encountered while paging.

func (*RouteFilterRulesClientListByRouteFilterPager) NextPage added in v0.3.0 

func (p *RouteFilterRulesClientListByRouteFilterPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*RouteFilterRulesClientListByRouteFilterPager) PageResponse added in v0.3.0 

func (p *RouteFilterRulesClientListByRouteFilterPager) PageResponse() RouteFilterRulesClientListByRouteFilterResponse

PageResponse returns the current RouteFilterRulesClientListByRouteFilterResponse page.

type RouteFilterRulesClientListByRouteFilterResponse added in v0.3.0 

type RouteFilterRulesClientListByRouteFilterResponse struct {
	RouteFilterRulesClientListByRouteFilterResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFilterRulesClientListByRouteFilterResponse contains the response from method RouteFilterRulesClient.ListByRouteFilter.

type RouteFilterRulesClientListByRouteFilterResult added in v0.3.0 

type RouteFilterRulesClientListByRouteFilterResult struct {
	RouteFilterRuleListResult
}

RouteFilterRulesClientListByRouteFilterResult contains the result from method RouteFilterRulesClient.ListByRouteFilter.

type RouteFiltersClient 

type RouteFiltersClient struct {
	// contains filtered or unexported fields
}

RouteFiltersClient contains the methods for the RouteFilters group. Don't use this type directly, use NewRouteFiltersClient() instead.

func NewRouteFiltersClient 

func NewRouteFiltersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *RouteFiltersClient

NewRouteFiltersClient creates a new instance of RouteFiltersClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RouteFiltersClient) BeginCreateOrUpdate 

func (client *RouteFiltersClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, routeFilterName string, routeFilterParameters RouteFilter, options *RouteFiltersClientBeginCreateOrUpdateOptions) (RouteFiltersClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a route filter in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeFilterName - The name of the route filter. routeFilterParameters - Parameters supplied to the create or update route filter operation. options - RouteFiltersClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteFiltersClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteFilterCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteFiltersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<route-filter-name>",
		armnetwork.RouteFilter{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.RouteFilterPropertiesFormat{
				Rules: []*armnetwork.RouteFilterRule{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.RouteFilterRulePropertiesFormat{
							Access: armnetwork.Access("Allow").ToPtr(),
							Communities: []*string{
								to.StringPtr("12076:5030"),
								to.StringPtr("12076:5040")},
							RouteFilterRuleType: armnetwork.RouteFilterRuleType("Community").ToPtr(),
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RouteFiltersClientCreateOrUpdateResult)
}

Output:

func (*RouteFiltersClient) BeginDelete 

func (client *RouteFiltersClient) BeginDelete(ctx context.Context, resourceGroupName string, routeFilterName string, options *RouteFiltersClientBeginDeleteOptions) (RouteFiltersClientDeletePollerResponse, error)

BeginDelete - Deletes the specified route filter. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeFilterName - The name of the route filter. options - RouteFiltersClientBeginDeleteOptions contains the optional parameters for the RouteFiltersClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteFilterDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteFiltersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<route-filter-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RouteFiltersClient) Get 

func (client *RouteFiltersClient) Get(ctx context.Context, resourceGroupName string, routeFilterName string, options *RouteFiltersClientGetOptions) (RouteFiltersClientGetResponse, error)

Get - Gets the specified route filter. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeFilterName - The name of the route filter. options - RouteFiltersClientGetOptions contains the optional parameters for the RouteFiltersClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteFilterGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteFiltersClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<route-filter-name>",
		&armnetwork.RouteFiltersClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RouteFiltersClientGetResult)
}

Output:

func (*RouteFiltersClient) List 

func (client *RouteFiltersClient) List(options *RouteFiltersClientListOptions) *RouteFiltersClientListPager

List - Gets all route filters in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - RouteFiltersClientListOptions contains the optional parameters for the RouteFiltersClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteFilterList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteFiltersClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*RouteFiltersClient) ListByResourceGroup 

func (client *RouteFiltersClient) ListByResourceGroup(resourceGroupName string, options *RouteFiltersClientListByResourceGroupOptions) *RouteFiltersClientListByResourceGroupPager

ListByResourceGroup - Gets all route filters in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - RouteFiltersClientListByResourceGroupOptions contains the optional parameters for the RouteFiltersClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteFilterListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteFiltersClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*RouteFiltersClient) UpdateTags 

func (client *RouteFiltersClient) UpdateTags(ctx context.Context, resourceGroupName string, routeFilterName string, parameters TagsObject, options *RouteFiltersClientUpdateTagsOptions) (RouteFiltersClientUpdateTagsResponse, error)

UpdateTags - Updates tags of a route filter. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeFilterName - The name of the route filter. parameters - Parameters supplied to update route filter tags. options - RouteFiltersClientUpdateTagsOptions contains the optional parameters for the RouteFiltersClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteFilterUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteFiltersClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<route-filter-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RouteFiltersClientUpdateTagsResult)
}

Output:

type RouteFiltersClientBeginCreateOrUpdateOptions added in v0.3.0 

type RouteFiltersClientBeginCreateOrUpdateOptions struct {
}

RouteFiltersClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteFiltersClient.BeginCreateOrUpdate method.

type RouteFiltersClientBeginDeleteOptions added in v0.3.0 

type RouteFiltersClientBeginDeleteOptions struct {
}

RouteFiltersClientBeginDeleteOptions contains the optional parameters for the RouteFiltersClient.BeginDelete method.

type RouteFiltersClientCreateOrUpdatePoller added in v0.3.0 

type RouteFiltersClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

RouteFiltersClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*RouteFiltersClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *RouteFiltersClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RouteFiltersClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *RouteFiltersClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (RouteFiltersClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RouteFiltersClientCreateOrUpdateResponse will be returned.

func (*RouteFiltersClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *RouteFiltersClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RouteFiltersClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *RouteFiltersClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RouteFiltersClientCreateOrUpdatePollerResponse added in v0.3.0 

type RouteFiltersClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RouteFiltersClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFiltersClientCreateOrUpdatePollerResponse contains the response from method RouteFiltersClient.CreateOrUpdate.

func (RouteFiltersClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l RouteFiltersClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RouteFiltersClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RouteFiltersClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *RouteFiltersClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *RouteFiltersClient, token string) error

Resume rehydrates a RouteFiltersClientCreateOrUpdatePollerResponse from the provided client and resume token.

type RouteFiltersClientCreateOrUpdateResponse added in v0.3.0 

type RouteFiltersClientCreateOrUpdateResponse struct {
	RouteFiltersClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFiltersClientCreateOrUpdateResponse contains the response from method RouteFiltersClient.CreateOrUpdate.

type RouteFiltersClientCreateOrUpdateResult added in v0.3.0 

type RouteFiltersClientCreateOrUpdateResult struct {
	RouteFilter
}

RouteFiltersClientCreateOrUpdateResult contains the result from method RouteFiltersClient.CreateOrUpdate.

type RouteFiltersClientDeletePoller added in v0.3.0 

type RouteFiltersClientDeletePoller struct {
	// contains filtered or unexported fields
}

RouteFiltersClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*RouteFiltersClientDeletePoller) Done added in v0.3.0 

func (p *RouteFiltersClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RouteFiltersClientDeletePoller) FinalResponse added in v0.3.0 

func (p *RouteFiltersClientDeletePoller) FinalResponse(ctx context.Context) (RouteFiltersClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RouteFiltersClientDeleteResponse will be returned.

func (*RouteFiltersClientDeletePoller) Poll added in v0.3.0 

func (p *RouteFiltersClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RouteFiltersClientDeletePoller) ResumeToken added in v0.3.0 

func (p *RouteFiltersClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RouteFiltersClientDeletePollerResponse added in v0.3.0 

type RouteFiltersClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RouteFiltersClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFiltersClientDeletePollerResponse contains the response from method RouteFiltersClient.Delete.

func (RouteFiltersClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l RouteFiltersClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RouteFiltersClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RouteFiltersClientDeletePollerResponse) Resume added in v0.3.0 

func (l *RouteFiltersClientDeletePollerResponse) Resume(ctx context.Context, client *RouteFiltersClient, token string) error

Resume rehydrates a RouteFiltersClientDeletePollerResponse from the provided client and resume token.

type RouteFiltersClientDeleteResponse added in v0.3.0 

type RouteFiltersClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFiltersClientDeleteResponse contains the response from method RouteFiltersClient.Delete.

type RouteFiltersClientGetOptions added in v0.3.0 

type RouteFiltersClientGetOptions struct {
	// Expands referenced express route bgp peering resources.
	Expand *string
}

RouteFiltersClientGetOptions contains the optional parameters for the RouteFiltersClient.Get method.

type RouteFiltersClientGetResponse added in v0.3.0 

type RouteFiltersClientGetResponse struct {
	RouteFiltersClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFiltersClientGetResponse contains the response from method RouteFiltersClient.Get.

type RouteFiltersClientGetResult added in v0.3.0 

type RouteFiltersClientGetResult struct {
	RouteFilter
}

RouteFiltersClientGetResult contains the result from method RouteFiltersClient.Get.

type RouteFiltersClientListByResourceGroupOptions added in v0.3.0 

type RouteFiltersClientListByResourceGroupOptions struct {
}

RouteFiltersClientListByResourceGroupOptions contains the optional parameters for the RouteFiltersClient.ListByResourceGroup method.

type RouteFiltersClientListByResourceGroupPager added in v0.3.0 

type RouteFiltersClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

RouteFiltersClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*RouteFiltersClientListByResourceGroupPager) Err added in v0.3.0 

func (p *RouteFiltersClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*RouteFiltersClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *RouteFiltersClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*RouteFiltersClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *RouteFiltersClientListByResourceGroupPager) PageResponse() RouteFiltersClientListByResourceGroupResponse

PageResponse returns the current RouteFiltersClientListByResourceGroupResponse page.

type RouteFiltersClientListByResourceGroupResponse added in v0.3.0 

type RouteFiltersClientListByResourceGroupResponse struct {
	RouteFiltersClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFiltersClientListByResourceGroupResponse contains the response from method RouteFiltersClient.ListByResourceGroup.

type RouteFiltersClientListByResourceGroupResult added in v0.3.0 

type RouteFiltersClientListByResourceGroupResult struct {
	RouteFilterListResult
}

RouteFiltersClientListByResourceGroupResult contains the result from method RouteFiltersClient.ListByResourceGroup.

type RouteFiltersClientListOptions added in v0.3.0 

type RouteFiltersClientListOptions struct {
}

RouteFiltersClientListOptions contains the optional parameters for the RouteFiltersClient.List method.

type RouteFiltersClientListPager added in v0.3.0 

type RouteFiltersClientListPager struct {
	// contains filtered or unexported fields
}

RouteFiltersClientListPager provides operations for iterating over paged responses.

func (*RouteFiltersClientListPager) Err added in v0.3.0 

func (p *RouteFiltersClientListPager) Err() error

Err returns the last error encountered while paging.

func (*RouteFiltersClientListPager) NextPage added in v0.3.0 

func (p *RouteFiltersClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*RouteFiltersClientListPager) PageResponse added in v0.3.0 

func (p *RouteFiltersClientListPager) PageResponse() RouteFiltersClientListResponse

PageResponse returns the current RouteFiltersClientListResponse page.

type RouteFiltersClientListResponse added in v0.3.0 

type RouteFiltersClientListResponse struct {
	RouteFiltersClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFiltersClientListResponse contains the response from method RouteFiltersClient.List.

type RouteFiltersClientListResult added in v0.3.0 

type RouteFiltersClientListResult struct {
	RouteFilterListResult
}

RouteFiltersClientListResult contains the result from method RouteFiltersClient.List.

type RouteFiltersClientUpdateTagsOptions added in v0.3.0 

type RouteFiltersClientUpdateTagsOptions struct {
}

RouteFiltersClientUpdateTagsOptions contains the optional parameters for the RouteFiltersClient.UpdateTags method.

type RouteFiltersClientUpdateTagsResponse added in v0.3.0 

type RouteFiltersClientUpdateTagsResponse struct {
	RouteFiltersClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteFiltersClientUpdateTagsResponse contains the response from method RouteFiltersClient.UpdateTags.

type RouteFiltersClientUpdateTagsResult added in v0.3.0 

type RouteFiltersClientUpdateTagsResult struct {
	RouteFilter
}

RouteFiltersClientUpdateTagsResult contains the result from method RouteFiltersClient.UpdateTags.

type RouteListResult 

type RouteListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of routes in a resource group.
	Value []*Route `json:"value,omitempty"`
}

RouteListResult - Response for the ListRoute API service call.

func (RouteListResult) MarshalJSON 

func (r RouteListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteListResult.

type RouteNextHopType 

type RouteNextHopType string

RouteNextHopType - The type of Azure hop the packet should be sent to. 

const (
	RouteNextHopTypeInternet              RouteNextHopType = "Internet"
	RouteNextHopTypeNone                  RouteNextHopType = "None"
	RouteNextHopTypeVirtualAppliance      RouteNextHopType = "VirtualAppliance"
	RouteNextHopTypeVirtualNetworkGateway RouteNextHopType = "VirtualNetworkGateway"
	RouteNextHopTypeVnetLocal             RouteNextHopType = "VnetLocal"
)

func PossibleRouteNextHopTypeValues 

func PossibleRouteNextHopTypeValues() []RouteNextHopType

PossibleRouteNextHopTypeValues returns the possible values for the RouteNextHopType const type.

func (RouteNextHopType) ToPtr 

func (c RouteNextHopType) ToPtr() *RouteNextHopType

ToPtr returns a *RouteNextHopType pointing to the current value.

type RoutePropertiesFormat 

type RoutePropertiesFormat struct {
	// REQUIRED; The type of Azure hop the packet should be sent to.
	NextHopType *RouteNextHopType `json:"nextHopType,omitempty"`

	// The destination CIDR to which the route applies.
	AddressPrefix *string `json:"addressPrefix,omitempty"`

	// A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
	HasBgpOverride *bool `json:"hasBgpOverride,omitempty"`

	// The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
	NextHopIPAddress *string `json:"nextHopIpAddress,omitempty"`

	// READ-ONLY; The provisioning state of the route resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

RoutePropertiesFormat - Route resource.

type RouteTable 

type RouteTable struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the route table.
	Properties *RouteTablePropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RouteTable - Route table resource.

func (RouteTable) MarshalJSON 

func (r RouteTable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteTable.

type RouteTableListResult 

type RouteTableListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of route tables in a resource group.
	Value []*RouteTable `json:"value,omitempty"`
}

RouteTableListResult - Response for the ListRouteTable API service call.

func (RouteTableListResult) MarshalJSON 

func (r RouteTableListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteTableListResult.

type RouteTablePropertiesFormat 

type RouteTablePropertiesFormat struct {
	// Whether to disable the routes learned by BGP on that route table. True means disable.
	DisableBgpRoutePropagation *bool `json:"disableBgpRoutePropagation,omitempty"`

	// Collection of routes contained within a route table.
	Routes []*Route `json:"routes,omitempty"`

	// READ-ONLY; The provisioning state of the route table resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the route table.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`

	// READ-ONLY; A collection of references to subnets.
	Subnets []*Subnet `json:"subnets,omitempty" azure:"ro"`
}

RouteTablePropertiesFormat - Route Table resource.

func (RouteTablePropertiesFormat) MarshalJSON 

func (r RouteTablePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteTablePropertiesFormat.

type RouteTablesClient 

type RouteTablesClient struct {
	// contains filtered or unexported fields
}

RouteTablesClient contains the methods for the RouteTables group. Don't use this type directly, use NewRouteTablesClient() instead.

func NewRouteTablesClient 

func NewRouteTablesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *RouteTablesClient

NewRouteTablesClient creates a new instance of RouteTablesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RouteTablesClient) BeginCreateOrUpdate 

func (client *RouteTablesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, routeTableName string, parameters RouteTable, options *RouteTablesClientBeginCreateOrUpdateOptions) (RouteTablesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Create or updates a route table in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeTableName - The name of the route table. parameters - Parameters supplied to the create or update route table operation. options - RouteTablesClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteTablesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteTableCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteTablesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<route-table-name>",
		armnetwork.RouteTable{
			Location: to.StringPtr("<location>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RouteTablesClientCreateOrUpdateResult)
}

Output:

func (*RouteTablesClient) BeginDelete 

func (client *RouteTablesClient) BeginDelete(ctx context.Context, resourceGroupName string, routeTableName string, options *RouteTablesClientBeginDeleteOptions) (RouteTablesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified route table. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeTableName - The name of the route table. options - RouteTablesClientBeginDeleteOptions contains the optional parameters for the RouteTablesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteTableDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteTablesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<route-table-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RouteTablesClient) Get 

func (client *RouteTablesClient) Get(ctx context.Context, resourceGroupName string, routeTableName string, options *RouteTablesClientGetOptions) (RouteTablesClientGetResponse, error)

Get - Gets the specified route table. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeTableName - The name of the route table. options - RouteTablesClientGetOptions contains the optional parameters for the RouteTablesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteTableGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteTablesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<route-table-name>",
		&armnetwork.RouteTablesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RouteTablesClientGetResult)
}

Output:

func (*RouteTablesClient) List 

func (client *RouteTablesClient) List(resourceGroupName string, options *RouteTablesClientListOptions) *RouteTablesClientListPager

List - Gets all route tables in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - RouteTablesClientListOptions contains the optional parameters for the RouteTablesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteTableList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteTablesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*RouteTablesClient) ListAll 

func (client *RouteTablesClient) ListAll(options *RouteTablesClientListAllOptions) *RouteTablesClientListAllPager

ListAll - Gets all route tables in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - RouteTablesClientListAllOptions contains the optional parameters for the RouteTablesClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteTableListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteTablesClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*RouteTablesClient) UpdateTags 

func (client *RouteTablesClient) UpdateTags(ctx context.Context, resourceGroupName string, routeTableName string, parameters TagsObject, options *RouteTablesClientUpdateTagsOptions) (RouteTablesClientUpdateTagsResponse, error)

UpdateTags - Updates a route table tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeTableName - The name of the route table. parameters - Parameters supplied to update route table tags. options - RouteTablesClientUpdateTagsOptions contains the optional parameters for the RouteTablesClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteTableUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRouteTablesClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<route-table-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RouteTablesClientUpdateTagsResult)
}

Output:

type RouteTablesClientBeginCreateOrUpdateOptions added in v0.3.0 

type RouteTablesClientBeginCreateOrUpdateOptions struct {
}

RouteTablesClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteTablesClient.BeginCreateOrUpdate method.

type RouteTablesClientBeginDeleteOptions added in v0.3.0 

type RouteTablesClientBeginDeleteOptions struct {
}

RouteTablesClientBeginDeleteOptions contains the optional parameters for the RouteTablesClient.BeginDelete method.

type RouteTablesClientCreateOrUpdatePoller added in v0.3.0 

type RouteTablesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

RouteTablesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*RouteTablesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *RouteTablesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RouteTablesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *RouteTablesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (RouteTablesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RouteTablesClientCreateOrUpdateResponse will be returned.

func (*RouteTablesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *RouteTablesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RouteTablesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *RouteTablesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RouteTablesClientCreateOrUpdatePollerResponse added in v0.3.0 

type RouteTablesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RouteTablesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteTablesClientCreateOrUpdatePollerResponse contains the response from method RouteTablesClient.CreateOrUpdate.

func (RouteTablesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l RouteTablesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RouteTablesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RouteTablesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *RouteTablesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *RouteTablesClient, token string) error

Resume rehydrates a RouteTablesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type RouteTablesClientCreateOrUpdateResponse added in v0.3.0 

type RouteTablesClientCreateOrUpdateResponse struct {
	RouteTablesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteTablesClientCreateOrUpdateResponse contains the response from method RouteTablesClient.CreateOrUpdate.

type RouteTablesClientCreateOrUpdateResult added in v0.3.0 

type RouteTablesClientCreateOrUpdateResult struct {
	RouteTable
}

RouteTablesClientCreateOrUpdateResult contains the result from method RouteTablesClient.CreateOrUpdate.

type RouteTablesClientDeletePoller added in v0.3.0 

type RouteTablesClientDeletePoller struct {
	// contains filtered or unexported fields
}

RouteTablesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*RouteTablesClientDeletePoller) Done added in v0.3.0 

func (p *RouteTablesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RouteTablesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *RouteTablesClientDeletePoller) FinalResponse(ctx context.Context) (RouteTablesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RouteTablesClientDeleteResponse will be returned.

func (*RouteTablesClientDeletePoller) Poll added in v0.3.0 

func (p *RouteTablesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RouteTablesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *RouteTablesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RouteTablesClientDeletePollerResponse added in v0.3.0 

type RouteTablesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RouteTablesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteTablesClientDeletePollerResponse contains the response from method RouteTablesClient.Delete.

func (RouteTablesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l RouteTablesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RouteTablesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RouteTablesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *RouteTablesClientDeletePollerResponse) Resume(ctx context.Context, client *RouteTablesClient, token string) error

Resume rehydrates a RouteTablesClientDeletePollerResponse from the provided client and resume token.

type RouteTablesClientDeleteResponse added in v0.3.0 

type RouteTablesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteTablesClientDeleteResponse contains the response from method RouteTablesClient.Delete.

type RouteTablesClientGetOptions added in v0.3.0 

type RouteTablesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

RouteTablesClientGetOptions contains the optional parameters for the RouteTablesClient.Get method.

type RouteTablesClientGetResponse added in v0.3.0 

type RouteTablesClientGetResponse struct {
	RouteTablesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteTablesClientGetResponse contains the response from method RouteTablesClient.Get.

type RouteTablesClientGetResult added in v0.3.0 

type RouteTablesClientGetResult struct {
	RouteTable
}

RouteTablesClientGetResult contains the result from method RouteTablesClient.Get.

type RouteTablesClientListAllOptions added in v0.3.0 

type RouteTablesClientListAllOptions struct {
}

RouteTablesClientListAllOptions contains the optional parameters for the RouteTablesClient.ListAll method.

type RouteTablesClientListAllPager added in v0.3.0 

type RouteTablesClientListAllPager struct {
	// contains filtered or unexported fields
}

RouteTablesClientListAllPager provides operations for iterating over paged responses.

func (*RouteTablesClientListAllPager) Err added in v0.3.0 

func (p *RouteTablesClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*RouteTablesClientListAllPager) NextPage added in v0.3.0 

func (p *RouteTablesClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*RouteTablesClientListAllPager) PageResponse added in v0.3.0 

func (p *RouteTablesClientListAllPager) PageResponse() RouteTablesClientListAllResponse

PageResponse returns the current RouteTablesClientListAllResponse page.

type RouteTablesClientListAllResponse added in v0.3.0 

type RouteTablesClientListAllResponse struct {
	RouteTablesClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteTablesClientListAllResponse contains the response from method RouteTablesClient.ListAll.

type RouteTablesClientListAllResult added in v0.3.0 

type RouteTablesClientListAllResult struct {
	RouteTableListResult
}

RouteTablesClientListAllResult contains the result from method RouteTablesClient.ListAll.

type RouteTablesClientListOptions added in v0.3.0 

type RouteTablesClientListOptions struct {
}

RouteTablesClientListOptions contains the optional parameters for the RouteTablesClient.List method.

type RouteTablesClientListPager added in v0.3.0 

type RouteTablesClientListPager struct {
	// contains filtered or unexported fields
}

RouteTablesClientListPager provides operations for iterating over paged responses.

func (*RouteTablesClientListPager) Err added in v0.3.0 

func (p *RouteTablesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*RouteTablesClientListPager) NextPage added in v0.3.0 

func (p *RouteTablesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*RouteTablesClientListPager) PageResponse added in v0.3.0 

func (p *RouteTablesClientListPager) PageResponse() RouteTablesClientListResponse

PageResponse returns the current RouteTablesClientListResponse page.

type RouteTablesClientListResponse added in v0.3.0 

type RouteTablesClientListResponse struct {
	RouteTablesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteTablesClientListResponse contains the response from method RouteTablesClient.List.

type RouteTablesClientListResult added in v0.3.0 

type RouteTablesClientListResult struct {
	RouteTableListResult
}

RouteTablesClientListResult contains the result from method RouteTablesClient.List.

type RouteTablesClientUpdateTagsOptions added in v0.3.0 

type RouteTablesClientUpdateTagsOptions struct {
}

RouteTablesClientUpdateTagsOptions contains the optional parameters for the RouteTablesClient.UpdateTags method.

type RouteTablesClientUpdateTagsResponse added in v0.3.0 

type RouteTablesClientUpdateTagsResponse struct {
	RouteTablesClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RouteTablesClientUpdateTagsResponse contains the response from method RouteTablesClient.UpdateTags.

type RouteTablesClientUpdateTagsResult added in v0.3.0 

type RouteTablesClientUpdateTagsResult struct {
	RouteTable
}

RouteTablesClientUpdateTagsResult contains the result from method RouteTablesClient.UpdateTags.

type RoutesClient 

type RoutesClient struct {
	// contains filtered or unexported fields
}

RoutesClient contains the methods for the Routes group. Don't use this type directly, use NewRoutesClient() instead.

func NewRoutesClient 

func NewRoutesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *RoutesClient

NewRoutesClient creates a new instance of RoutesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoutesClient) BeginCreateOrUpdate 

func (client *RoutesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, routeTableName string, routeName string, routeParameters Route, options *RoutesClientBeginCreateOrUpdateOptions) (RoutesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a route in the specified route table. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeTableName - The name of the route table. routeName - The name of the route. routeParameters - Parameters supplied to the create or update route operation. options - RoutesClientBeginCreateOrUpdateOptions contains the optional parameters for the RoutesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteTableRouteCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRoutesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<route-table-name>",
		"<route-name>",
		armnetwork.Route{
			Properties: &armnetwork.RoutePropertiesFormat{
				AddressPrefix: to.StringPtr("<address-prefix>"),
				NextHopType:   armnetwork.RouteNextHopType("VirtualNetworkGateway").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoutesClientCreateOrUpdateResult)
}

Output:

func (*RoutesClient) BeginDelete 

func (client *RoutesClient) BeginDelete(ctx context.Context, resourceGroupName string, routeTableName string, routeName string, options *RoutesClientBeginDeleteOptions) (RoutesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified route from a route table. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeTableName - The name of the route table. routeName - The name of the route. options - RoutesClientBeginDeleteOptions contains the optional parameters for the RoutesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteTableRouteDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRoutesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<route-table-name>",
		"<route-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RoutesClient) Get 

func (client *RoutesClient) Get(ctx context.Context, resourceGroupName string, routeTableName string, routeName string, options *RoutesClientGetOptions) (RoutesClientGetResponse, error)

Get - Gets the specified route from a route table. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeTableName - The name of the route table. routeName - The name of the route. options - RoutesClientGetOptions contains the optional parameters for the RoutesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteTableRouteGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRoutesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<route-table-name>",
		"<route-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoutesClientGetResult)
}

Output:

func (*RoutesClient) List 

func (client *RoutesClient) List(resourceGroupName string, routeTableName string, options *RoutesClientListOptions) *RoutesClientListPager

List - Gets all routes in a route table. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. routeTableName - The name of the route table. options - RoutesClientListOptions contains the optional parameters for the RoutesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RouteTableRouteList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRoutesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<route-table-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RoutesClientBeginCreateOrUpdateOptions added in v0.3.0 

type RoutesClientBeginCreateOrUpdateOptions struct {
}

RoutesClientBeginCreateOrUpdateOptions contains the optional parameters for the RoutesClient.BeginCreateOrUpdate method.

type RoutesClientBeginDeleteOptions added in v0.3.0 

type RoutesClientBeginDeleteOptions struct {
}

RoutesClientBeginDeleteOptions contains the optional parameters for the RoutesClient.BeginDelete method.

type RoutesClientCreateOrUpdatePoller added in v0.3.0 

type RoutesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

RoutesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*RoutesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *RoutesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RoutesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *RoutesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (RoutesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RoutesClientCreateOrUpdateResponse will be returned.

func (*RoutesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *RoutesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RoutesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *RoutesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RoutesClientCreateOrUpdatePollerResponse added in v0.3.0 

type RoutesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RoutesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutesClientCreateOrUpdatePollerResponse contains the response from method RoutesClient.CreateOrUpdate.

func (RoutesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l RoutesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RoutesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RoutesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *RoutesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *RoutesClient, token string) error

Resume rehydrates a RoutesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type RoutesClientCreateOrUpdateResponse added in v0.3.0 

type RoutesClientCreateOrUpdateResponse struct {
	RoutesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutesClientCreateOrUpdateResponse contains the response from method RoutesClient.CreateOrUpdate.

type RoutesClientCreateOrUpdateResult added in v0.3.0 

type RoutesClientCreateOrUpdateResult struct {
	Route
}

RoutesClientCreateOrUpdateResult contains the result from method RoutesClient.CreateOrUpdate.

type RoutesClientDeletePoller added in v0.3.0 

type RoutesClientDeletePoller struct {
	// contains filtered or unexported fields
}

RoutesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*RoutesClientDeletePoller) Done added in v0.3.0 

func (p *RoutesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RoutesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *RoutesClientDeletePoller) FinalResponse(ctx context.Context) (RoutesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RoutesClientDeleteResponse will be returned.

func (*RoutesClientDeletePoller) Poll added in v0.3.0 

func (p *RoutesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RoutesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *RoutesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RoutesClientDeletePollerResponse added in v0.3.0 

type RoutesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RoutesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutesClientDeletePollerResponse contains the response from method RoutesClient.Delete.

func (RoutesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l RoutesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RoutesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RoutesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *RoutesClientDeletePollerResponse) Resume(ctx context.Context, client *RoutesClient, token string) error

Resume rehydrates a RoutesClientDeletePollerResponse from the provided client and resume token.

type RoutesClientDeleteResponse added in v0.3.0 

type RoutesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutesClientDeleteResponse contains the response from method RoutesClient.Delete.

type RoutesClientGetOptions added in v0.3.0 

type RoutesClientGetOptions struct {
}

RoutesClientGetOptions contains the optional parameters for the RoutesClient.Get method.

type RoutesClientGetResponse added in v0.3.0 

type RoutesClientGetResponse struct {
	RoutesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutesClientGetResponse contains the response from method RoutesClient.Get.

type RoutesClientGetResult added in v0.3.0 

type RoutesClientGetResult struct {
	Route
}

RoutesClientGetResult contains the result from method RoutesClient.Get.

type RoutesClientListOptions added in v0.3.0 

type RoutesClientListOptions struct {
}

RoutesClientListOptions contains the optional parameters for the RoutesClient.List method.

type RoutesClientListPager added in v0.3.0 

type RoutesClientListPager struct {
	// contains filtered or unexported fields
}

RoutesClientListPager provides operations for iterating over paged responses.

func (*RoutesClientListPager) Err added in v0.3.0 

func (p *RoutesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*RoutesClientListPager) NextPage added in v0.3.0 

func (p *RoutesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*RoutesClientListPager) PageResponse added in v0.3.0 

func (p *RoutesClientListPager) PageResponse() RoutesClientListResponse

PageResponse returns the current RoutesClientListResponse page.

type RoutesClientListResponse added in v0.3.0 

type RoutesClientListResponse struct {
	RoutesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutesClientListResponse contains the response from method RoutesClient.List.

type RoutesClientListResult added in v0.3.0 

type RoutesClientListResult struct {
	RouteListResult
}

RoutesClientListResult contains the result from method RoutesClient.List.

type RoutingConfiguration 

type RoutingConfiguration struct {
	// The resource id RouteTable associated with this RoutingConfiguration.
	AssociatedRouteTable *SubResource `json:"associatedRouteTable,omitempty"`

	// The list of RouteTables to advertise the routes to.
	PropagatedRouteTables *PropagatedRouteTable `json:"propagatedRouteTables,omitempty"`

	// List of routes that control routing from VirtualHub into a virtual network connection.
	VnetRoutes *VnetRoute `json:"vnetRoutes,omitempty"`
}

RoutingConfiguration - Routing Configuration indicating the associated and propagated route tables for this connection.

type RoutingIntent added in v0.2.0 

type RoutingIntent struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the RoutingIntent resource.
	Properties *RoutingIntentProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

RoutingIntent - The routing intent child resource of a Virtual hub.

type RoutingIntentClient added in v0.2.0 

type RoutingIntentClient struct {
	// contains filtered or unexported fields
}

RoutingIntentClient contains the methods for the RoutingIntent group. Don't use this type directly, use NewRoutingIntentClient() instead.

func NewRoutingIntentClient added in v0.2.0 

func NewRoutingIntentClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *RoutingIntentClient

NewRoutingIntentClient creates a new instance of RoutingIntentClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RoutingIntentClient) BeginCreateOrUpdate added in v0.2.0 

func (client *RoutingIntentClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualHubName string, routingIntentName string, routingIntentParameters RoutingIntent, options *RoutingIntentClientBeginCreateOrUpdateOptions) (RoutingIntentClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the RoutingIntent. virtualHubName - The name of the VirtualHub. routingIntentName - The name of the per VirtualHub singleton Routing Intent resource. routingIntentParameters - Parameters supplied to create or update RoutingIntent. options - RoutingIntentClientBeginCreateOrUpdateOptions contains the optional parameters for the RoutingIntentClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RoutingIntentPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRoutingIntentClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<routing-intent-name>",
		armnetwork.RoutingIntent{
			Properties: &armnetwork.RoutingIntentProperties{
				RoutingPolicies: []*armnetwork.RoutingPolicy{
					{
						Name: to.StringPtr("<name>"),
						Destinations: []*string{
							to.StringPtr("Internet")},
						NextHop: to.StringPtr("<next-hop>"),
					},
					{
						Name: to.StringPtr("<name>"),
						Destinations: []*string{
							to.StringPtr("PrivateTraffic")},
						NextHop: to.StringPtr("<next-hop>"),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoutingIntentClientCreateOrUpdateResult)
}

Output:

func (*RoutingIntentClient) BeginDelete added in v0.2.0 

func (client *RoutingIntentClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, routingIntentName string, options *RoutingIntentClientBeginDeleteOptions) (RoutingIntentClientDeletePollerResponse, error)

BeginDelete - Deletes a RoutingIntent. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the RoutingIntent. virtualHubName - The name of the VirtualHub. routingIntentName - The name of the RoutingIntent. options - RoutingIntentClientBeginDeleteOptions contains the optional parameters for the RoutingIntentClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RoutingIntentDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRoutingIntentClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<routing-intent-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RoutingIntentClient) Get added in v0.2.0 

func (client *RoutingIntentClient) Get(ctx context.Context, resourceGroupName string, virtualHubName string, routingIntentName string, options *RoutingIntentClientGetOptions) (RoutingIntentClientGetResponse, error)

Get - Retrieves the details of a RoutingIntent. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the RoutingIntent. virtualHubName - The name of the VirtualHub. routingIntentName - The name of the RoutingIntent. options - RoutingIntentClientGetOptions contains the optional parameters for the RoutingIntentClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RoutingIntentGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRoutingIntentClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<routing-intent-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RoutingIntentClientGetResult)
}

Output:

func (*RoutingIntentClient) List added in v0.2.0 

func (client *RoutingIntentClient) List(resourceGroupName string, virtualHubName string, options *RoutingIntentClientListOptions) *RoutingIntentClientListPager

List - Retrieves the details of all RoutingIntent child resources of the VirtualHub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. options - RoutingIntentClientListOptions contains the optional parameters for the RoutingIntentClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/RoutingIntentList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewRoutingIntentClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<virtual-hub-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type RoutingIntentClientBeginCreateOrUpdateOptions added in v0.3.0 

type RoutingIntentClientBeginCreateOrUpdateOptions struct {
}

RoutingIntentClientBeginCreateOrUpdateOptions contains the optional parameters for the RoutingIntentClient.BeginCreateOrUpdate method.

type RoutingIntentClientBeginDeleteOptions added in v0.3.0 

type RoutingIntentClientBeginDeleteOptions struct {
}

RoutingIntentClientBeginDeleteOptions contains the optional parameters for the RoutingIntentClient.BeginDelete method.

type RoutingIntentClientCreateOrUpdatePoller added in v0.3.0 

type RoutingIntentClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

RoutingIntentClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*RoutingIntentClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *RoutingIntentClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RoutingIntentClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *RoutingIntentClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (RoutingIntentClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RoutingIntentClientCreateOrUpdateResponse will be returned.

func (*RoutingIntentClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *RoutingIntentClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RoutingIntentClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *RoutingIntentClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RoutingIntentClientCreateOrUpdatePollerResponse added in v0.3.0 

type RoutingIntentClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RoutingIntentClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutingIntentClientCreateOrUpdatePollerResponse contains the response from method RoutingIntentClient.CreateOrUpdate.

func (RoutingIntentClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l RoutingIntentClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RoutingIntentClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RoutingIntentClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *RoutingIntentClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *RoutingIntentClient, token string) error

Resume rehydrates a RoutingIntentClientCreateOrUpdatePollerResponse from the provided client and resume token.

type RoutingIntentClientCreateOrUpdateResponse added in v0.3.0 

type RoutingIntentClientCreateOrUpdateResponse struct {
	RoutingIntentClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutingIntentClientCreateOrUpdateResponse contains the response from method RoutingIntentClient.CreateOrUpdate.

type RoutingIntentClientCreateOrUpdateResult added in v0.3.0 

type RoutingIntentClientCreateOrUpdateResult struct {
	RoutingIntent
}

RoutingIntentClientCreateOrUpdateResult contains the result from method RoutingIntentClient.CreateOrUpdate.

type RoutingIntentClientDeletePoller added in v0.3.0 

type RoutingIntentClientDeletePoller struct {
	// contains filtered or unexported fields
}

RoutingIntentClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*RoutingIntentClientDeletePoller) Done added in v0.3.0 

func (p *RoutingIntentClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RoutingIntentClientDeletePoller) FinalResponse added in v0.3.0 

func (p *RoutingIntentClientDeletePoller) FinalResponse(ctx context.Context) (RoutingIntentClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RoutingIntentClientDeleteResponse will be returned.

func (*RoutingIntentClientDeletePoller) Poll added in v0.3.0 

func (p *RoutingIntentClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RoutingIntentClientDeletePoller) ResumeToken added in v0.3.0 

func (p *RoutingIntentClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RoutingIntentClientDeletePollerResponse added in v0.3.0 

type RoutingIntentClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RoutingIntentClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutingIntentClientDeletePollerResponse contains the response from method RoutingIntentClient.Delete.

func (RoutingIntentClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l RoutingIntentClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RoutingIntentClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RoutingIntentClientDeletePollerResponse) Resume added in v0.3.0 

func (l *RoutingIntentClientDeletePollerResponse) Resume(ctx context.Context, client *RoutingIntentClient, token string) error

Resume rehydrates a RoutingIntentClientDeletePollerResponse from the provided client and resume token.

type RoutingIntentClientDeleteResponse added in v0.3.0 

type RoutingIntentClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutingIntentClientDeleteResponse contains the response from method RoutingIntentClient.Delete.

type RoutingIntentClientGetOptions added in v0.3.0 

type RoutingIntentClientGetOptions struct {
}

RoutingIntentClientGetOptions contains the optional parameters for the RoutingIntentClient.Get method.

type RoutingIntentClientGetResponse added in v0.3.0 

type RoutingIntentClientGetResponse struct {
	RoutingIntentClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutingIntentClientGetResponse contains the response from method RoutingIntentClient.Get.

type RoutingIntentClientGetResult added in v0.3.0 

type RoutingIntentClientGetResult struct {
	RoutingIntent
}

RoutingIntentClientGetResult contains the result from method RoutingIntentClient.Get.

type RoutingIntentClientListOptions added in v0.3.0 

type RoutingIntentClientListOptions struct {
}

RoutingIntentClientListOptions contains the optional parameters for the RoutingIntentClient.List method.

type RoutingIntentClientListPager added in v0.3.0 

type RoutingIntentClientListPager struct {
	// contains filtered or unexported fields
}

RoutingIntentClientListPager provides operations for iterating over paged responses.

func (*RoutingIntentClientListPager) Err added in v0.3.0 

func (p *RoutingIntentClientListPager) Err() error

Err returns the last error encountered while paging.

func (*RoutingIntentClientListPager) NextPage added in v0.3.0 

func (p *RoutingIntentClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*RoutingIntentClientListPager) PageResponse added in v0.3.0 

func (p *RoutingIntentClientListPager) PageResponse() RoutingIntentClientListResponse

PageResponse returns the current RoutingIntentClientListResponse page.

type RoutingIntentClientListResponse added in v0.3.0 

type RoutingIntentClientListResponse struct {
	RoutingIntentClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RoutingIntentClientListResponse contains the response from method RoutingIntentClient.List.

type RoutingIntentClientListResult added in v0.3.0 

type RoutingIntentClientListResult struct {
	ListRoutingIntentResult
}

RoutingIntentClientListResult contains the result from method RoutingIntentClient.List.

type RoutingIntentProperties added in v0.2.0 

type RoutingIntentProperties struct {
	// List of routing policies.
	RoutingPolicies []*RoutingPolicy `json:"routingPolicies,omitempty"`

	// READ-ONLY; The provisioning state of the RoutingIntent resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

RoutingIntentProperties - The properties of a RoutingIntent resource.

func (RoutingIntentProperties) MarshalJSON added in v0.2.0 

func (r RoutingIntentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoutingIntentProperties.

type RoutingPolicy added in v0.2.0 

type RoutingPolicy struct {
	// REQUIRED; List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic).
	Destinations []*string `json:"destinations,omitempty"`

	// REQUIRED; The unique name for the routing policy.
	Name *string `json:"name,omitempty"`

	// REQUIRED; The next hop resource id on which this routing policy is applicable to.
	NextHop *string `json:"nextHop,omitempty"`
}

RoutingPolicy - The routing policy object used in a RoutingIntent resource.

func (RoutingPolicy) MarshalJSON added in v0.2.0 

func (r RoutingPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoutingPolicy.

type RoutingState 

type RoutingState string

RoutingState - The current routing state of the VirtualHub. 

const (
	RoutingStateFailed       RoutingState = "Failed"
	RoutingStateNone         RoutingState = "None"
	RoutingStateProvisioned  RoutingState = "Provisioned"
	RoutingStateProvisioning RoutingState = "Provisioning"
)

func PossibleRoutingStateValues 

func PossibleRoutingStateValues() []RoutingState

PossibleRoutingStateValues returns the possible values for the RoutingState const type.

func (RoutingState) ToPtr 

func (c RoutingState) ToPtr() *RoutingState

ToPtr returns a *RoutingState pointing to the current value.

type Rule added in v0.3.0 

type Rule struct {
	// REQUIRED; Rule Type.
	RuleType *FirewallPolicyRuleType `json:"ruleType,omitempty"`

	// Description of the rule.
	Description *string `json:"description,omitempty"`

	// List of destination IP addresses or Service Tags.
	DestinationAddresses []*string `json:"destinationAddresses,omitempty"`

	// List of destination FQDNs.
	DestinationFqdns []*string `json:"destinationFqdns,omitempty"`

	// List of destination IpGroups for this rule.
	DestinationIPGroups []*string `json:"destinationIpGroups,omitempty"`

	// List of destination ports.
	DestinationPorts []*string `json:"destinationPorts,omitempty"`

	// Array of FirewallPolicyRuleNetworkProtocols.
	IPProtocols []*FirewallPolicyRuleNetworkProtocol `json:"ipProtocols,omitempty"`

	// Name of the rule.
	Name *string `json:"name,omitempty"`

	// List of source IP addresses for this rule.
	SourceAddresses []*string `json:"sourceAddresses,omitempty"`

	// List of source IpGroups for this rule.
	SourceIPGroups []*string `json:"sourceIpGroups,omitempty"`
}

Rule of type network.

func (*Rule) GetFirewallPolicyRule added in v0.3.0 

func (r *Rule) GetFirewallPolicyRule() *FirewallPolicyRule

GetFirewallPolicyRule implements the FirewallPolicyRuleClassification interface for type Rule.

func (Rule) MarshalJSON added in v0.3.0 

func (r Rule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Rule.

func (*Rule) UnmarshalJSON added in v0.3.0 

func (r *Rule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Rule.

type SKU 

type SKU struct {
	// The name of this Bastion Host.
	Name *BastionHostSKUName `json:"name,omitempty"`
}

SKU - The sku of this Bastion Host.

type SecurityGroup added in v0.3.0 

type SecurityGroup struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the network security group.
	Properties *SecurityGroupPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

SecurityGroup - NetworkSecurityGroup resource.

func (SecurityGroup) MarshalJSON added in v0.3.0 

func (s SecurityGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroup.

type SecurityGroupListResult added in v0.3.0 

type SecurityGroupListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of NetworkSecurityGroup resources.
	Value []*SecurityGroup `json:"value,omitempty"`
}

SecurityGroupListResult - Response for ListNetworkSecurityGroups API service call.

func (SecurityGroupListResult) MarshalJSON added in v0.3.0 

func (s SecurityGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroupListResult.

type SecurityGroupNetworkInterface 

type SecurityGroupNetworkInterface struct {
	// ID of the network interface.
	ID *string `json:"id,omitempty"`

	// All security rules associated with the network interface.
	SecurityRuleAssociations *SecurityRuleAssociations `json:"securityRuleAssociations,omitempty"`
}

SecurityGroupNetworkInterface - Network interface and all its associated security rules.

type SecurityGroupPropertiesFormat added in v0.3.0 

type SecurityGroupPropertiesFormat struct {
	// A collection of security rules of the network security group.
	SecurityRules []*SecurityRule `json:"securityRules,omitempty"`

	// READ-ONLY; The default security rules of network security group.
	DefaultSecurityRules []*SecurityRule `json:"defaultSecurityRules,omitempty" azure:"ro"`

	// READ-ONLY; A collection of references to flow log resources.
	FlowLogs []*FlowLog `json:"flowLogs,omitempty" azure:"ro"`

	// READ-ONLY; A collection of references to network interfaces.
	NetworkInterfaces []*Interface `json:"networkInterfaces,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the network security group resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the network security group resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`

	// READ-ONLY; A collection of references to subnets.
	Subnets []*Subnet `json:"subnets,omitempty" azure:"ro"`
}

SecurityGroupPropertiesFormat - Network Security Group resource.

func (SecurityGroupPropertiesFormat) MarshalJSON added in v0.3.0 

func (s SecurityGroupPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroupPropertiesFormat.

type SecurityGroupResult added in v0.3.0 

type SecurityGroupResult struct {
	// The network traffic is allowed or denied.
	SecurityRuleAccessResult *SecurityRuleAccess `json:"securityRuleAccessResult,omitempty"`

	// READ-ONLY; List of results network security groups diagnostic.
	EvaluatedNetworkSecurityGroups []*EvaluatedNetworkSecurityGroup `json:"evaluatedNetworkSecurityGroups,omitempty" azure:"ro"`
}

SecurityGroupResult - Network configuration diagnostic result corresponded provided traffic query.

func (SecurityGroupResult) MarshalJSON added in v0.3.0 

func (s SecurityGroupResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroupResult.

type SecurityGroupViewParameters 

type SecurityGroupViewParameters struct {
	// REQUIRED; ID of the target VM.
	TargetResourceID *string `json:"targetResourceId,omitempty"`
}

SecurityGroupViewParameters - Parameters that define the VM to check security groups for.

type SecurityGroupViewResult 

type SecurityGroupViewResult struct {
	// List of network interfaces on the specified VM.
	NetworkInterfaces []*SecurityGroupNetworkInterface `json:"networkInterfaces,omitempty"`
}

SecurityGroupViewResult - The information about security rules applied to the specified VM.

func (SecurityGroupViewResult) MarshalJSON 

func (s SecurityGroupViewResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroupViewResult.

type SecurityGroupsClient added in v0.3.0 

type SecurityGroupsClient struct {
	// contains filtered or unexported fields
}

SecurityGroupsClient contains the methods for the NetworkSecurityGroups group. Don't use this type directly, use NewSecurityGroupsClient() instead.

func NewSecurityGroupsClient added in v0.3.0 

func NewSecurityGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *SecurityGroupsClient

NewSecurityGroupsClient creates a new instance of SecurityGroupsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SecurityGroupsClient) BeginCreateOrUpdate added in v0.3.0 

func (client *SecurityGroupsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, parameters SecurityGroup, options *SecurityGroupsClientBeginCreateOrUpdateOptions) (SecurityGroupsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a network security group in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkSecurityGroupName - The name of the network security group. parameters - Parameters supplied to the create or update network security group operation. options - SecurityGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the SecurityGroupsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkSecurityGroupCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-security-group-name>",
		armnetwork.SecurityGroup{
			Location: to.StringPtr("<location>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecurityGroupsClientCreateOrUpdateResult)
}

Output:

func (*SecurityGroupsClient) BeginDelete added in v0.3.0 

func (client *SecurityGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, options *SecurityGroupsClientBeginDeleteOptions) (SecurityGroupsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified network security group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkSecurityGroupName - The name of the network security group. options - SecurityGroupsClientBeginDeleteOptions contains the optional parameters for the SecurityGroupsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkSecurityGroupDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityGroupsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-security-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SecurityGroupsClient) Get added in v0.3.0 

func (client *SecurityGroupsClient) Get(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, options *SecurityGroupsClientGetOptions) (SecurityGroupsClientGetResponse, error)

Get - Gets the specified network security group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkSecurityGroupName - The name of the network security group. options - SecurityGroupsClientGetOptions contains the optional parameters for the SecurityGroupsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkSecurityGroupGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityGroupsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-security-group-name>",
		&armnetwork.SecurityGroupsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecurityGroupsClientGetResult)
}

Output:

func (*SecurityGroupsClient) List added in v0.3.0 

func (client *SecurityGroupsClient) List(resourceGroupName string, options *SecurityGroupsClientListOptions) *SecurityGroupsClientListPager

List - Gets all network security groups in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - SecurityGroupsClientListOptions contains the optional parameters for the SecurityGroupsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkSecurityGroupList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityGroupsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*SecurityGroupsClient) ListAll added in v0.3.0 

func (client *SecurityGroupsClient) ListAll(options *SecurityGroupsClientListAllOptions) *SecurityGroupsClientListAllPager

ListAll - Gets all network security groups in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - SecurityGroupsClientListAllOptions contains the optional parameters for the SecurityGroupsClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkSecurityGroupListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityGroupsClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*SecurityGroupsClient) UpdateTags added in v0.3.0 

func (client *SecurityGroupsClient) UpdateTags(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, parameters TagsObject, options *SecurityGroupsClientUpdateTagsOptions) (SecurityGroupsClientUpdateTagsResponse, error)

UpdateTags - Updates a network security group tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkSecurityGroupName - The name of the network security group. parameters - Parameters supplied to update network security group tags. options - SecurityGroupsClientUpdateTagsOptions contains the optional parameters for the SecurityGroupsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkSecurityGroupUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityGroupsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<network-security-group-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecurityGroupsClientUpdateTagsResult)
}

Output:

type SecurityGroupsClientBeginCreateOrUpdateOptions added in v0.3.0 

type SecurityGroupsClientBeginCreateOrUpdateOptions struct {
}

SecurityGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the SecurityGroupsClient.BeginCreateOrUpdate method.

type SecurityGroupsClientBeginDeleteOptions added in v0.3.0 

type SecurityGroupsClientBeginDeleteOptions struct {
}

SecurityGroupsClientBeginDeleteOptions contains the optional parameters for the SecurityGroupsClient.BeginDelete method.

type SecurityGroupsClientCreateOrUpdatePoller added in v0.3.0 

type SecurityGroupsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

SecurityGroupsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*SecurityGroupsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *SecurityGroupsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SecurityGroupsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *SecurityGroupsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (SecurityGroupsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SecurityGroupsClientCreateOrUpdateResponse will be returned.

func (*SecurityGroupsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *SecurityGroupsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SecurityGroupsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *SecurityGroupsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SecurityGroupsClientCreateOrUpdatePollerResponse added in v0.3.0 

type SecurityGroupsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SecurityGroupsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityGroupsClientCreateOrUpdatePollerResponse contains the response from method SecurityGroupsClient.CreateOrUpdate.

func (SecurityGroupsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l SecurityGroupsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SecurityGroupsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SecurityGroupsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *SecurityGroupsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *SecurityGroupsClient, token string) error

Resume rehydrates a SecurityGroupsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type SecurityGroupsClientCreateOrUpdateResponse added in v0.3.0 

type SecurityGroupsClientCreateOrUpdateResponse struct {
	SecurityGroupsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityGroupsClientCreateOrUpdateResponse contains the response from method SecurityGroupsClient.CreateOrUpdate.

type SecurityGroupsClientCreateOrUpdateResult added in v0.3.0 

type SecurityGroupsClientCreateOrUpdateResult struct {
	SecurityGroup
}

SecurityGroupsClientCreateOrUpdateResult contains the result from method SecurityGroupsClient.CreateOrUpdate.

type SecurityGroupsClientDeletePoller added in v0.3.0 

type SecurityGroupsClientDeletePoller struct {
	// contains filtered or unexported fields
}

SecurityGroupsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*SecurityGroupsClientDeletePoller) Done added in v0.3.0 

func (p *SecurityGroupsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SecurityGroupsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *SecurityGroupsClientDeletePoller) FinalResponse(ctx context.Context) (SecurityGroupsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SecurityGroupsClientDeleteResponse will be returned.

func (*SecurityGroupsClientDeletePoller) Poll added in v0.3.0 

func (p *SecurityGroupsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SecurityGroupsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *SecurityGroupsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SecurityGroupsClientDeletePollerResponse added in v0.3.0 

type SecurityGroupsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SecurityGroupsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityGroupsClientDeletePollerResponse contains the response from method SecurityGroupsClient.Delete.

func (SecurityGroupsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l SecurityGroupsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SecurityGroupsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SecurityGroupsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *SecurityGroupsClientDeletePollerResponse) Resume(ctx context.Context, client *SecurityGroupsClient, token string) error

Resume rehydrates a SecurityGroupsClientDeletePollerResponse from the provided client and resume token.

type SecurityGroupsClientDeleteResponse added in v0.3.0 

type SecurityGroupsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityGroupsClientDeleteResponse contains the response from method SecurityGroupsClient.Delete.

type SecurityGroupsClientGetOptions added in v0.3.0 

type SecurityGroupsClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

SecurityGroupsClientGetOptions contains the optional parameters for the SecurityGroupsClient.Get method.

type SecurityGroupsClientGetResponse added in v0.3.0 

type SecurityGroupsClientGetResponse struct {
	SecurityGroupsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityGroupsClientGetResponse contains the response from method SecurityGroupsClient.Get.

type SecurityGroupsClientGetResult added in v0.3.0 

type SecurityGroupsClientGetResult struct {
	SecurityGroup
}

SecurityGroupsClientGetResult contains the result from method SecurityGroupsClient.Get.

type SecurityGroupsClientListAllOptions added in v0.3.0 

type SecurityGroupsClientListAllOptions struct {
}

SecurityGroupsClientListAllOptions contains the optional parameters for the SecurityGroupsClient.ListAll method.

type SecurityGroupsClientListAllPager added in v0.3.0 

type SecurityGroupsClientListAllPager struct {
	// contains filtered or unexported fields
}

SecurityGroupsClientListAllPager provides operations for iterating over paged responses.

func (*SecurityGroupsClientListAllPager) Err added in v0.3.0 

func (p *SecurityGroupsClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*SecurityGroupsClientListAllPager) NextPage added in v0.3.0 

func (p *SecurityGroupsClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*SecurityGroupsClientListAllPager) PageResponse added in v0.3.0 

func (p *SecurityGroupsClientListAllPager) PageResponse() SecurityGroupsClientListAllResponse

PageResponse returns the current SecurityGroupsClientListAllResponse page.

type SecurityGroupsClientListAllResponse added in v0.3.0 

type SecurityGroupsClientListAllResponse struct {
	SecurityGroupsClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityGroupsClientListAllResponse contains the response from method SecurityGroupsClient.ListAll.

type SecurityGroupsClientListAllResult added in v0.3.0 

type SecurityGroupsClientListAllResult struct {
	SecurityGroupListResult
}

SecurityGroupsClientListAllResult contains the result from method SecurityGroupsClient.ListAll.

type SecurityGroupsClientListOptions added in v0.3.0 

type SecurityGroupsClientListOptions struct {
}

SecurityGroupsClientListOptions contains the optional parameters for the SecurityGroupsClient.List method.

type SecurityGroupsClientListPager added in v0.3.0 

type SecurityGroupsClientListPager struct {
	// contains filtered or unexported fields
}

SecurityGroupsClientListPager provides operations for iterating over paged responses.

func (*SecurityGroupsClientListPager) Err added in v0.3.0 

func (p *SecurityGroupsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*SecurityGroupsClientListPager) NextPage added in v0.3.0 

func (p *SecurityGroupsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*SecurityGroupsClientListPager) PageResponse added in v0.3.0 

func (p *SecurityGroupsClientListPager) PageResponse() SecurityGroupsClientListResponse

PageResponse returns the current SecurityGroupsClientListResponse page.

type SecurityGroupsClientListResponse added in v0.3.0 

type SecurityGroupsClientListResponse struct {
	SecurityGroupsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityGroupsClientListResponse contains the response from method SecurityGroupsClient.List.

type SecurityGroupsClientListResult added in v0.3.0 

type SecurityGroupsClientListResult struct {
	SecurityGroupListResult
}

SecurityGroupsClientListResult contains the result from method SecurityGroupsClient.List.

type SecurityGroupsClientUpdateTagsOptions added in v0.3.0 

type SecurityGroupsClientUpdateTagsOptions struct {
}

SecurityGroupsClientUpdateTagsOptions contains the optional parameters for the SecurityGroupsClient.UpdateTags method.

type SecurityGroupsClientUpdateTagsResponse added in v0.3.0 

type SecurityGroupsClientUpdateTagsResponse struct {
	SecurityGroupsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityGroupsClientUpdateTagsResponse contains the response from method SecurityGroupsClient.UpdateTags.

type SecurityGroupsClientUpdateTagsResult added in v0.3.0 

type SecurityGroupsClientUpdateTagsResult struct {
	SecurityGroup
}

SecurityGroupsClientUpdateTagsResult contains the result from method SecurityGroupsClient.UpdateTags.

type SecurityPartnerProvider 

type SecurityPartnerProvider struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the Security Partner Provider.
	Properties *SecurityPartnerProviderPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

SecurityPartnerProvider - Security Partner Provider resource.

func (SecurityPartnerProvider) MarshalJSON 

func (s SecurityPartnerProvider) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityPartnerProvider.

type SecurityPartnerProviderConnectionStatus 

type SecurityPartnerProviderConnectionStatus string

SecurityPartnerProviderConnectionStatus - The current state of the connection with Security Partner Provider. 

const (
	SecurityPartnerProviderConnectionStatusConnected          SecurityPartnerProviderConnectionStatus = "Connected"
	SecurityPartnerProviderConnectionStatusNotConnected       SecurityPartnerProviderConnectionStatus = "NotConnected"
	SecurityPartnerProviderConnectionStatusPartiallyConnected SecurityPartnerProviderConnectionStatus = "PartiallyConnected"
	SecurityPartnerProviderConnectionStatusUnknown            SecurityPartnerProviderConnectionStatus = "Unknown"
)

func PossibleSecurityPartnerProviderConnectionStatusValues 

func PossibleSecurityPartnerProviderConnectionStatusValues() []SecurityPartnerProviderConnectionStatus

PossibleSecurityPartnerProviderConnectionStatusValues returns the possible values for the SecurityPartnerProviderConnectionStatus const type.

func (SecurityPartnerProviderConnectionStatus) ToPtr 

func (c SecurityPartnerProviderConnectionStatus) ToPtr() *SecurityPartnerProviderConnectionStatus

ToPtr returns a *SecurityPartnerProviderConnectionStatus pointing to the current value.

type SecurityPartnerProviderListResult 

type SecurityPartnerProviderListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Security Partner Providers in a resource group.
	Value []*SecurityPartnerProvider `json:"value,omitempty"`
}

SecurityPartnerProviderListResult - Response for ListSecurityPartnerProviders API service call.

func (SecurityPartnerProviderListResult) MarshalJSON 

func (s SecurityPartnerProviderListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityPartnerProviderListResult.

type SecurityPartnerProviderPropertiesFormat 

type SecurityPartnerProviderPropertiesFormat struct {
	// The security provider name.
	SecurityProviderName *SecurityProviderName `json:"securityProviderName,omitempty"`

	// The virtualHub to which the Security Partner Provider belongs.
	VirtualHub *SubResource `json:"virtualHub,omitempty"`

	// READ-ONLY; The connection status with the Security Partner Provider.
	ConnectionStatus *SecurityPartnerProviderConnectionStatus `json:"connectionStatus,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the Security Partner Provider resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

SecurityPartnerProviderPropertiesFormat - Properties of the Security Partner Provider.

type SecurityPartnerProvidersClient 

type SecurityPartnerProvidersClient struct {
	// contains filtered or unexported fields
}

SecurityPartnerProvidersClient contains the methods for the SecurityPartnerProviders group. Don't use this type directly, use NewSecurityPartnerProvidersClient() instead.

func NewSecurityPartnerProvidersClient 

func NewSecurityPartnerProvidersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *SecurityPartnerProvidersClient

NewSecurityPartnerProvidersClient creates a new instance of SecurityPartnerProvidersClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SecurityPartnerProvidersClient) BeginCreateOrUpdate 

func (client *SecurityPartnerProvidersClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, securityPartnerProviderName string, parameters SecurityPartnerProvider, options *SecurityPartnerProvidersClientBeginCreateOrUpdateOptions) (SecurityPartnerProvidersClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified Security Partner Provider. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. securityPartnerProviderName - The name of the Security Partner Provider. parameters - Parameters supplied to the create or update Security Partner Provider operation. options - SecurityPartnerProvidersClientBeginCreateOrUpdateOptions contains the optional parameters for the SecurityPartnerProvidersClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SecurityPartnerProviderPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityPartnerProvidersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<security-partner-provider-name>",
		armnetwork.SecurityPartnerProvider{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.SecurityPartnerProviderPropertiesFormat{
				SecurityProviderName: armnetwork.SecurityProviderName("ZScaler").ToPtr(),
				VirtualHub: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecurityPartnerProvidersClientCreateOrUpdateResult)
}

Output:

func (*SecurityPartnerProvidersClient) BeginDelete 

func (client *SecurityPartnerProvidersClient) BeginDelete(ctx context.Context, resourceGroupName string, securityPartnerProviderName string, options *SecurityPartnerProvidersClientBeginDeleteOptions) (SecurityPartnerProvidersClientDeletePollerResponse, error)

BeginDelete - Deletes the specified Security Partner Provider. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. securityPartnerProviderName - The name of the Security Partner Provider. options - SecurityPartnerProvidersClientBeginDeleteOptions contains the optional parameters for the SecurityPartnerProvidersClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SecurityPartnerProviderDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityPartnerProvidersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<security-partner-provider-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SecurityPartnerProvidersClient) Get 

func (client *SecurityPartnerProvidersClient) Get(ctx context.Context, resourceGroupName string, securityPartnerProviderName string, options *SecurityPartnerProvidersClientGetOptions) (SecurityPartnerProvidersClientGetResponse, error)

Get - Gets the specified Security Partner Provider. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. securityPartnerProviderName - The name of the Security Partner Provider. options - SecurityPartnerProvidersClientGetOptions contains the optional parameters for the SecurityPartnerProvidersClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SecurityPartnerProviderGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityPartnerProvidersClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<security-partner-provider-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecurityPartnerProvidersClientGetResult)
}

Output:

func (*SecurityPartnerProvidersClient) List 

func (client *SecurityPartnerProvidersClient) List(options *SecurityPartnerProvidersClientListOptions) *SecurityPartnerProvidersClientListPager

List - Gets all the Security Partner Providers in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - SecurityPartnerProvidersClientListOptions contains the optional parameters for the SecurityPartnerProvidersClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SecurityPartnerProviderListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityPartnerProvidersClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*SecurityPartnerProvidersClient) ListByResourceGroup 

func (client *SecurityPartnerProvidersClient) ListByResourceGroup(resourceGroupName string, options *SecurityPartnerProvidersClientListByResourceGroupOptions) *SecurityPartnerProvidersClientListByResourceGroupPager

ListByResourceGroup - Lists all Security Partner Providers in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - SecurityPartnerProvidersClientListByResourceGroupOptions contains the optional parameters for the SecurityPartnerProvidersClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SecurityPartnerProviderListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityPartnerProvidersClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*SecurityPartnerProvidersClient) UpdateTags 

func (client *SecurityPartnerProvidersClient) UpdateTags(ctx context.Context, resourceGroupName string, securityPartnerProviderName string, parameters TagsObject, options *SecurityPartnerProvidersClientUpdateTagsOptions) (SecurityPartnerProvidersClientUpdateTagsResponse, error)

UpdateTags - Updates tags of a Security Partner Provider resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. securityPartnerProviderName - The name of the Security Partner Provider. parameters - Parameters supplied to update Security Partner Provider tags. options - SecurityPartnerProvidersClientUpdateTagsOptions contains the optional parameters for the SecurityPartnerProvidersClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SecurityPartnerProviderUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityPartnerProvidersClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<security-partner-provider-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecurityPartnerProvidersClientUpdateTagsResult)
}

Output:

type SecurityPartnerProvidersClientBeginCreateOrUpdateOptions added in v0.3.0 

type SecurityPartnerProvidersClientBeginCreateOrUpdateOptions struct {
}

SecurityPartnerProvidersClientBeginCreateOrUpdateOptions contains the optional parameters for the SecurityPartnerProvidersClient.BeginCreateOrUpdate method.

type SecurityPartnerProvidersClientBeginDeleteOptions added in v0.3.0 

type SecurityPartnerProvidersClientBeginDeleteOptions struct {
}

SecurityPartnerProvidersClientBeginDeleteOptions contains the optional parameters for the SecurityPartnerProvidersClient.BeginDelete method.

type SecurityPartnerProvidersClientCreateOrUpdatePoller added in v0.3.0 

type SecurityPartnerProvidersClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

SecurityPartnerProvidersClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*SecurityPartnerProvidersClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *SecurityPartnerProvidersClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SecurityPartnerProvidersClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *SecurityPartnerProvidersClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (SecurityPartnerProvidersClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SecurityPartnerProvidersClientCreateOrUpdateResponse will be returned.

func (*SecurityPartnerProvidersClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *SecurityPartnerProvidersClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SecurityPartnerProvidersClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *SecurityPartnerProvidersClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SecurityPartnerProvidersClientCreateOrUpdatePollerResponse added in v0.3.0 

type SecurityPartnerProvidersClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SecurityPartnerProvidersClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityPartnerProvidersClientCreateOrUpdatePollerResponse contains the response from method SecurityPartnerProvidersClient.CreateOrUpdate.

func (SecurityPartnerProvidersClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l SecurityPartnerProvidersClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SecurityPartnerProvidersClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SecurityPartnerProvidersClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *SecurityPartnerProvidersClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *SecurityPartnerProvidersClient, token string) error

Resume rehydrates a SecurityPartnerProvidersClientCreateOrUpdatePollerResponse from the provided client and resume token.

type SecurityPartnerProvidersClientCreateOrUpdateResponse added in v0.3.0 

type SecurityPartnerProvidersClientCreateOrUpdateResponse struct {
	SecurityPartnerProvidersClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityPartnerProvidersClientCreateOrUpdateResponse contains the response from method SecurityPartnerProvidersClient.CreateOrUpdate.

type SecurityPartnerProvidersClientCreateOrUpdateResult added in v0.3.0 

type SecurityPartnerProvidersClientCreateOrUpdateResult struct {
	SecurityPartnerProvider
}

SecurityPartnerProvidersClientCreateOrUpdateResult contains the result from method SecurityPartnerProvidersClient.CreateOrUpdate.

type SecurityPartnerProvidersClientDeletePoller added in v0.3.0 

type SecurityPartnerProvidersClientDeletePoller struct {
	// contains filtered or unexported fields
}

SecurityPartnerProvidersClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*SecurityPartnerProvidersClientDeletePoller) Done added in v0.3.0 

func (p *SecurityPartnerProvidersClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SecurityPartnerProvidersClientDeletePoller) FinalResponse added in v0.3.0 

func (p *SecurityPartnerProvidersClientDeletePoller) FinalResponse(ctx context.Context) (SecurityPartnerProvidersClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SecurityPartnerProvidersClientDeleteResponse will be returned.

func (*SecurityPartnerProvidersClientDeletePoller) Poll added in v0.3.0 

func (p *SecurityPartnerProvidersClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SecurityPartnerProvidersClientDeletePoller) ResumeToken added in v0.3.0 

func (p *SecurityPartnerProvidersClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SecurityPartnerProvidersClientDeletePollerResponse added in v0.3.0 

type SecurityPartnerProvidersClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SecurityPartnerProvidersClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityPartnerProvidersClientDeletePollerResponse contains the response from method SecurityPartnerProvidersClient.Delete.

func (SecurityPartnerProvidersClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l SecurityPartnerProvidersClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SecurityPartnerProvidersClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SecurityPartnerProvidersClientDeletePollerResponse) Resume added in v0.3.0 

func (l *SecurityPartnerProvidersClientDeletePollerResponse) Resume(ctx context.Context, client *SecurityPartnerProvidersClient, token string) error

Resume rehydrates a SecurityPartnerProvidersClientDeletePollerResponse from the provided client and resume token.

type SecurityPartnerProvidersClientDeleteResponse added in v0.3.0 

type SecurityPartnerProvidersClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityPartnerProvidersClientDeleteResponse contains the response from method SecurityPartnerProvidersClient.Delete.

type SecurityPartnerProvidersClientGetOptions added in v0.3.0 

type SecurityPartnerProvidersClientGetOptions struct {
}

SecurityPartnerProvidersClientGetOptions contains the optional parameters for the SecurityPartnerProvidersClient.Get method.

type SecurityPartnerProvidersClientGetResponse added in v0.3.0 

type SecurityPartnerProvidersClientGetResponse struct {
	SecurityPartnerProvidersClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityPartnerProvidersClientGetResponse contains the response from method SecurityPartnerProvidersClient.Get.

type SecurityPartnerProvidersClientGetResult added in v0.3.0 

type SecurityPartnerProvidersClientGetResult struct {
	SecurityPartnerProvider
}

SecurityPartnerProvidersClientGetResult contains the result from method SecurityPartnerProvidersClient.Get.

type SecurityPartnerProvidersClientListByResourceGroupOptions added in v0.3.0 

type SecurityPartnerProvidersClientListByResourceGroupOptions struct {
}

SecurityPartnerProvidersClientListByResourceGroupOptions contains the optional parameters for the SecurityPartnerProvidersClient.ListByResourceGroup method.

type SecurityPartnerProvidersClientListByResourceGroupPager added in v0.3.0 

type SecurityPartnerProvidersClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

SecurityPartnerProvidersClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*SecurityPartnerProvidersClientListByResourceGroupPager) Err added in v0.3.0 

func (p *SecurityPartnerProvidersClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*SecurityPartnerProvidersClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *SecurityPartnerProvidersClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*SecurityPartnerProvidersClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *SecurityPartnerProvidersClientListByResourceGroupPager) PageResponse() SecurityPartnerProvidersClientListByResourceGroupResponse

PageResponse returns the current SecurityPartnerProvidersClientListByResourceGroupResponse page.

type SecurityPartnerProvidersClientListByResourceGroupResponse added in v0.3.0 

type SecurityPartnerProvidersClientListByResourceGroupResponse struct {
	SecurityPartnerProvidersClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityPartnerProvidersClientListByResourceGroupResponse contains the response from method SecurityPartnerProvidersClient.ListByResourceGroup.

type SecurityPartnerProvidersClientListByResourceGroupResult added in v0.3.0 

type SecurityPartnerProvidersClientListByResourceGroupResult struct {
	SecurityPartnerProviderListResult
}

SecurityPartnerProvidersClientListByResourceGroupResult contains the result from method SecurityPartnerProvidersClient.ListByResourceGroup.

type SecurityPartnerProvidersClientListOptions added in v0.3.0 

type SecurityPartnerProvidersClientListOptions struct {
}

SecurityPartnerProvidersClientListOptions contains the optional parameters for the SecurityPartnerProvidersClient.List method.

type SecurityPartnerProvidersClientListPager added in v0.3.0 

type SecurityPartnerProvidersClientListPager struct {
	// contains filtered or unexported fields
}

SecurityPartnerProvidersClientListPager provides operations for iterating over paged responses.

func (*SecurityPartnerProvidersClientListPager) Err added in v0.3.0 

func (p *SecurityPartnerProvidersClientListPager) Err() error

Err returns the last error encountered while paging.

func (*SecurityPartnerProvidersClientListPager) NextPage added in v0.3.0 

func (p *SecurityPartnerProvidersClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*SecurityPartnerProvidersClientListPager) PageResponse added in v0.3.0 

func (p *SecurityPartnerProvidersClientListPager) PageResponse() SecurityPartnerProvidersClientListResponse

PageResponse returns the current SecurityPartnerProvidersClientListResponse page.

type SecurityPartnerProvidersClientListResponse added in v0.3.0 

type SecurityPartnerProvidersClientListResponse struct {
	SecurityPartnerProvidersClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityPartnerProvidersClientListResponse contains the response from method SecurityPartnerProvidersClient.List.

type SecurityPartnerProvidersClientListResult added in v0.3.0 

type SecurityPartnerProvidersClientListResult struct {
	SecurityPartnerProviderListResult
}

SecurityPartnerProvidersClientListResult contains the result from method SecurityPartnerProvidersClient.List.

type SecurityPartnerProvidersClientUpdateTagsOptions added in v0.3.0 

type SecurityPartnerProvidersClientUpdateTagsOptions struct {
}

SecurityPartnerProvidersClientUpdateTagsOptions contains the optional parameters for the SecurityPartnerProvidersClient.UpdateTags method.

type SecurityPartnerProvidersClientUpdateTagsResponse added in v0.3.0 

type SecurityPartnerProvidersClientUpdateTagsResponse struct {
	SecurityPartnerProvidersClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityPartnerProvidersClientUpdateTagsResponse contains the response from method SecurityPartnerProvidersClient.UpdateTags.

type SecurityPartnerProvidersClientUpdateTagsResult added in v0.3.0 

type SecurityPartnerProvidersClientUpdateTagsResult struct {
	SecurityPartnerProvider
}

SecurityPartnerProvidersClientUpdateTagsResult contains the result from method SecurityPartnerProvidersClient.UpdateTags.

type SecurityProviderName 

type SecurityProviderName string

SecurityProviderName - The Security Providers. 

const (
	SecurityProviderNameCheckpoint SecurityProviderName = "Checkpoint"
	SecurityProviderNameIBoss      SecurityProviderName = "IBoss"
	SecurityProviderNameZScaler    SecurityProviderName = "ZScaler"
)

func PossibleSecurityProviderNameValues 

func PossibleSecurityProviderNameValues() []SecurityProviderName

PossibleSecurityProviderNameValues returns the possible values for the SecurityProviderName const type.

func (SecurityProviderName) ToPtr 

func (c SecurityProviderName) ToPtr() *SecurityProviderName

ToPtr returns a *SecurityProviderName pointing to the current value.

type SecurityRule 

type SecurityRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the security rule.
	Properties *SecurityRulePropertiesFormat `json:"properties,omitempty"`

	// The type of the resource.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

SecurityRule - Network security rule.

type SecurityRuleAccess 

type SecurityRuleAccess string

SecurityRuleAccess - Whether network traffic is allowed or denied. 

const (
	SecurityRuleAccessAllow SecurityRuleAccess = "Allow"
	SecurityRuleAccessDeny  SecurityRuleAccess = "Deny"
)

func PossibleSecurityRuleAccessValues 

func PossibleSecurityRuleAccessValues() []SecurityRuleAccess

PossibleSecurityRuleAccessValues returns the possible values for the SecurityRuleAccess const type.

func (SecurityRuleAccess) ToPtr 

func (c SecurityRuleAccess) ToPtr() *SecurityRuleAccess

ToPtr returns a *SecurityRuleAccess pointing to the current value.

type SecurityRuleAssociations 

type SecurityRuleAssociations struct {
	// Collection of default security rules of the network security group.
	DefaultSecurityRules []*SecurityRule `json:"defaultSecurityRules,omitempty"`

	// Collection of effective security rules.
	EffectiveSecurityRules []*EffectiveNetworkSecurityRule `json:"effectiveSecurityRules,omitempty"`

	// Network interface and it's custom security rules.
	NetworkInterfaceAssociation *InterfaceAssociation `json:"networkInterfaceAssociation,omitempty"`

	// Subnet and it's custom security rules.
	SubnetAssociation *SubnetAssociation `json:"subnetAssociation,omitempty"`
}

SecurityRuleAssociations - All security rules associated with the network interface.

func (SecurityRuleAssociations) MarshalJSON 

func (s SecurityRuleAssociations) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityRuleAssociations.

type SecurityRuleDirection 

type SecurityRuleDirection string

SecurityRuleDirection - The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. 

const (
	SecurityRuleDirectionInbound  SecurityRuleDirection = "Inbound"
	SecurityRuleDirectionOutbound SecurityRuleDirection = "Outbound"
)

func PossibleSecurityRuleDirectionValues 

func PossibleSecurityRuleDirectionValues() []SecurityRuleDirection

PossibleSecurityRuleDirectionValues returns the possible values for the SecurityRuleDirection const type.

func (SecurityRuleDirection) ToPtr 

func (c SecurityRuleDirection) ToPtr() *SecurityRuleDirection

ToPtr returns a *SecurityRuleDirection pointing to the current value.

type SecurityRuleListResult 

type SecurityRuleListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The security rules in a network security group.
	Value []*SecurityRule `json:"value,omitempty"`
}

SecurityRuleListResult - Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group.

func (SecurityRuleListResult) MarshalJSON 

func (s SecurityRuleListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityRuleListResult.

type SecurityRulePropertiesFormat 

type SecurityRulePropertiesFormat struct {
	// REQUIRED; The network traffic is allowed or denied.
	Access *SecurityRuleAccess `json:"access,omitempty"`

	// REQUIRED; The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.
	Direction *SecurityRuleDirection `json:"direction,omitempty"`

	// REQUIRED; Network protocol this rule applies to.
	Protocol *SecurityRuleProtocol `json:"protocol,omitempty"`

	// A description for this rule. Restricted to 140 chars.
	Description *string `json:"description,omitempty"`

	// The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default
	// tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also
	// be used.
	DestinationAddressPrefix *string `json:"destinationAddressPrefix,omitempty"`

	// The destination address prefixes. CIDR or destination IP ranges.
	DestinationAddressPrefixes []*string `json:"destinationAddressPrefixes,omitempty"`

	// The application security group specified as destination.
	DestinationApplicationSecurityGroups []*ApplicationSecurityGroup `json:"destinationApplicationSecurityGroups,omitempty"`

	// The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
	DestinationPortRange *string `json:"destinationPortRange,omitempty"`

	// The destination port ranges.
	DestinationPortRanges []*string `json:"destinationPortRanges,omitempty"`

	// The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the
	// collection. The lower the priority number, the higher the priority of the rule.
	Priority *int32 `json:"priority,omitempty"`

	// The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork',
	// 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress
	// rule, specifies where network traffic originates from.
	SourceAddressPrefix *string `json:"sourceAddressPrefix,omitempty"`

	// The CIDR or source IP ranges.
	SourceAddressPrefixes []*string `json:"sourceAddressPrefixes,omitempty"`

	// The application security group specified as source.
	SourceApplicationSecurityGroups []*ApplicationSecurityGroup `json:"sourceApplicationSecurityGroups,omitempty"`

	// The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
	SourcePortRange *string `json:"sourcePortRange,omitempty"`

	// The source port ranges.
	SourcePortRanges []*string `json:"sourcePortRanges,omitempty"`

	// READ-ONLY; The provisioning state of the security rule resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

SecurityRulePropertiesFormat - Security rule resource.

func (SecurityRulePropertiesFormat) MarshalJSON 

func (s SecurityRulePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityRulePropertiesFormat.

type SecurityRuleProtocol 

type SecurityRuleProtocol string

SecurityRuleProtocol - Network protocol this rule applies to. 

const (
	SecurityRuleProtocolAh       SecurityRuleProtocol = "Ah"
	SecurityRuleProtocolAsterisk SecurityRuleProtocol = "*"
	SecurityRuleProtocolEsp      SecurityRuleProtocol = "Esp"
	SecurityRuleProtocolIcmp     SecurityRuleProtocol = "Icmp"
	SecurityRuleProtocolTCP      SecurityRuleProtocol = "Tcp"
	SecurityRuleProtocolUDP      SecurityRuleProtocol = "Udp"
)

func PossibleSecurityRuleProtocolValues 

func PossibleSecurityRuleProtocolValues() []SecurityRuleProtocol

PossibleSecurityRuleProtocolValues returns the possible values for the SecurityRuleProtocol const type.

func (SecurityRuleProtocol) ToPtr 

func (c SecurityRuleProtocol) ToPtr() *SecurityRuleProtocol

ToPtr returns a *SecurityRuleProtocol pointing to the current value.

type SecurityRulesClient 

type SecurityRulesClient struct {
	// contains filtered or unexported fields
}

SecurityRulesClient contains the methods for the SecurityRules group. Don't use this type directly, use NewSecurityRulesClient() instead.

func NewSecurityRulesClient 

func NewSecurityRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *SecurityRulesClient

NewSecurityRulesClient creates a new instance of SecurityRulesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SecurityRulesClient) BeginCreateOrUpdate 

func (client *SecurityRulesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, securityRuleName string, securityRuleParameters SecurityRule, options *SecurityRulesClientBeginCreateOrUpdateOptions) (SecurityRulesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a security rule in the specified network security group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkSecurityGroupName - The name of the network security group. securityRuleName - The name of the security rule. securityRuleParameters - Parameters supplied to the create or update network security rule operation. options - SecurityRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the SecurityRulesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkSecurityGroupRuleCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityRulesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-security-group-name>",
		"<security-rule-name>",
		armnetwork.SecurityRule{
			Properties: &armnetwork.SecurityRulePropertiesFormat{
				Access:                   armnetwork.SecurityRuleAccess("Deny").ToPtr(),
				DestinationAddressPrefix: to.StringPtr("<destination-address-prefix>"),
				DestinationPortRange:     to.StringPtr("<destination-port-range>"),
				Direction:                armnetwork.SecurityRuleDirection("Outbound").ToPtr(),
				Priority:                 to.Int32Ptr(100),
				SourceAddressPrefix:      to.StringPtr("<source-address-prefix>"),
				SourcePortRange:          to.StringPtr("<source-port-range>"),
				Protocol:                 armnetwork.SecurityRuleProtocol("*").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecurityRulesClientCreateOrUpdateResult)
}

Output:

func (*SecurityRulesClient) BeginDelete 

func (client *SecurityRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, securityRuleName string, options *SecurityRulesClientBeginDeleteOptions) (SecurityRulesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified network security rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkSecurityGroupName - The name of the network security group. securityRuleName - The name of the security rule. options - SecurityRulesClientBeginDeleteOptions contains the optional parameters for the SecurityRulesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkSecurityGroupRuleDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityRulesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-security-group-name>",
		"<security-rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SecurityRulesClient) Get 

func (client *SecurityRulesClient) Get(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, securityRuleName string, options *SecurityRulesClientGetOptions) (SecurityRulesClientGetResponse, error)

Get - Get the specified network security rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkSecurityGroupName - The name of the network security group. securityRuleName - The name of the security rule. options - SecurityRulesClientGetOptions contains the optional parameters for the SecurityRulesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkSecurityGroupRuleGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityRulesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-security-group-name>",
		"<security-rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecurityRulesClientGetResult)
}

Output:

func (*SecurityRulesClient) List 

func (client *SecurityRulesClient) List(resourceGroupName string, networkSecurityGroupName string, options *SecurityRulesClientListOptions) *SecurityRulesClientListPager

List - Gets all security rules in a network security group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkSecurityGroupName - The name of the network security group. options - SecurityRulesClientListOptions contains the optional parameters for the SecurityRulesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkSecurityGroupRuleList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSecurityRulesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<network-security-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type SecurityRulesClientBeginCreateOrUpdateOptions added in v0.3.0 

type SecurityRulesClientBeginCreateOrUpdateOptions struct {
}

SecurityRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the SecurityRulesClient.BeginCreateOrUpdate method.

type SecurityRulesClientBeginDeleteOptions added in v0.3.0 

type SecurityRulesClientBeginDeleteOptions struct {
}

SecurityRulesClientBeginDeleteOptions contains the optional parameters for the SecurityRulesClient.BeginDelete method.

type SecurityRulesClientCreateOrUpdatePoller added in v0.3.0 

type SecurityRulesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

SecurityRulesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*SecurityRulesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *SecurityRulesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SecurityRulesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *SecurityRulesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (SecurityRulesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SecurityRulesClientCreateOrUpdateResponse will be returned.

func (*SecurityRulesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *SecurityRulesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SecurityRulesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *SecurityRulesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SecurityRulesClientCreateOrUpdatePollerResponse added in v0.3.0 

type SecurityRulesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SecurityRulesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityRulesClientCreateOrUpdatePollerResponse contains the response from method SecurityRulesClient.CreateOrUpdate.

func (SecurityRulesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l SecurityRulesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SecurityRulesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SecurityRulesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *SecurityRulesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *SecurityRulesClient, token string) error

Resume rehydrates a SecurityRulesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type SecurityRulesClientCreateOrUpdateResponse added in v0.3.0 

type SecurityRulesClientCreateOrUpdateResponse struct {
	SecurityRulesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityRulesClientCreateOrUpdateResponse contains the response from method SecurityRulesClient.CreateOrUpdate.

type SecurityRulesClientCreateOrUpdateResult added in v0.3.0 

type SecurityRulesClientCreateOrUpdateResult struct {
	SecurityRule
}

SecurityRulesClientCreateOrUpdateResult contains the result from method SecurityRulesClient.CreateOrUpdate.

type SecurityRulesClientDeletePoller added in v0.3.0 

type SecurityRulesClientDeletePoller struct {
	// contains filtered or unexported fields
}

SecurityRulesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*SecurityRulesClientDeletePoller) Done added in v0.3.0 

func (p *SecurityRulesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SecurityRulesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *SecurityRulesClientDeletePoller) FinalResponse(ctx context.Context) (SecurityRulesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SecurityRulesClientDeleteResponse will be returned.

func (*SecurityRulesClientDeletePoller) Poll added in v0.3.0 

func (p *SecurityRulesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SecurityRulesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *SecurityRulesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SecurityRulesClientDeletePollerResponse added in v0.3.0 

type SecurityRulesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SecurityRulesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityRulesClientDeletePollerResponse contains the response from method SecurityRulesClient.Delete.

func (SecurityRulesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l SecurityRulesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SecurityRulesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SecurityRulesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *SecurityRulesClientDeletePollerResponse) Resume(ctx context.Context, client *SecurityRulesClient, token string) error

Resume rehydrates a SecurityRulesClientDeletePollerResponse from the provided client and resume token.

type SecurityRulesClientDeleteResponse added in v0.3.0 

type SecurityRulesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityRulesClientDeleteResponse contains the response from method SecurityRulesClient.Delete.

type SecurityRulesClientGetOptions added in v0.3.0 

type SecurityRulesClientGetOptions struct {
}

SecurityRulesClientGetOptions contains the optional parameters for the SecurityRulesClient.Get method.

type SecurityRulesClientGetResponse added in v0.3.0 

type SecurityRulesClientGetResponse struct {
	SecurityRulesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityRulesClientGetResponse contains the response from method SecurityRulesClient.Get.

type SecurityRulesClientGetResult added in v0.3.0 

type SecurityRulesClientGetResult struct {
	SecurityRule
}

SecurityRulesClientGetResult contains the result from method SecurityRulesClient.Get.

type SecurityRulesClientListOptions added in v0.3.0 

type SecurityRulesClientListOptions struct {
}

SecurityRulesClientListOptions contains the optional parameters for the SecurityRulesClient.List method.

type SecurityRulesClientListPager added in v0.3.0 

type SecurityRulesClientListPager struct {
	// contains filtered or unexported fields
}

SecurityRulesClientListPager provides operations for iterating over paged responses.

func (*SecurityRulesClientListPager) Err added in v0.3.0 

func (p *SecurityRulesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*SecurityRulesClientListPager) NextPage added in v0.3.0 

func (p *SecurityRulesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*SecurityRulesClientListPager) PageResponse added in v0.3.0 

func (p *SecurityRulesClientListPager) PageResponse() SecurityRulesClientListResponse

PageResponse returns the current SecurityRulesClientListResponse page.

type SecurityRulesClientListResponse added in v0.3.0 

type SecurityRulesClientListResponse struct {
	SecurityRulesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecurityRulesClientListResponse contains the response from method SecurityRulesClient.List.

type SecurityRulesClientListResult added in v0.3.0 

type SecurityRulesClientListResult struct {
	SecurityRuleListResult
}

SecurityRulesClientListResult contains the result from method SecurityRulesClient.List.

type SecurityRulesEvaluationResult added in v0.3.0 

type SecurityRulesEvaluationResult struct {
	// Value indicating whether destination is matched.
	DestinationMatched *bool `json:"destinationMatched,omitempty"`

	// Value indicating whether destination port is matched.
	DestinationPortMatched *bool `json:"destinationPortMatched,omitempty"`

	// Name of the network security rule.
	Name *string `json:"name,omitempty"`

	// Value indicating whether protocol is matched.
	ProtocolMatched *bool `json:"protocolMatched,omitempty"`

	// Value indicating whether source is matched.
	SourceMatched *bool `json:"sourceMatched,omitempty"`

	// Value indicating whether source port is matched.
	SourcePortMatched *bool `json:"sourcePortMatched,omitempty"`
}

SecurityRulesEvaluationResult - Network security rules evaluation result. 

type ServiceAssociationLink struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Resource navigation link properties format.
	Properties *ServiceAssociationLinkPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ServiceAssociationLink resource.

type ServiceAssociationLinkPropertiesFormat 

type ServiceAssociationLinkPropertiesFormat struct {
	// If true, the resource can be deleted.
	AllowDelete *bool `json:"allowDelete,omitempty"`

	// Link to the external resource.
	Link *string `json:"link,omitempty"`

	// Resource type of the linked resource.
	LinkedResourceType *string `json:"linkedResourceType,omitempty"`

	// A list of locations.
	Locations []*string `json:"locations,omitempty"`

	// READ-ONLY; The provisioning state of the service association link resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ServiceAssociationLinkPropertiesFormat - Properties of ServiceAssociationLink.

func (ServiceAssociationLinkPropertiesFormat) MarshalJSON 

func (s ServiceAssociationLinkPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceAssociationLinkPropertiesFormat.

type ServiceAssociationLinksClient 

type ServiceAssociationLinksClient struct {
	// contains filtered or unexported fields
}

ServiceAssociationLinksClient contains the methods for the ServiceAssociationLinks group. Don't use this type directly, use NewServiceAssociationLinksClient() instead.

func NewServiceAssociationLinksClient 

func NewServiceAssociationLinksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ServiceAssociationLinksClient

NewServiceAssociationLinksClient creates a new instance of ServiceAssociationLinksClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ServiceAssociationLinksClient) List 

func (client *ServiceAssociationLinksClient) List(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, options *ServiceAssociationLinksClientListOptions) (ServiceAssociationLinksClientListResponse, error)

List - Gets a list of service association links for a subnet. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. subnetName - The name of the subnet. options - ServiceAssociationLinksClientListOptions contains the optional parameters for the ServiceAssociationLinksClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGetServiceAssociationLinks.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceAssociationLinksClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<subnet-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServiceAssociationLinksClientListResult)
}

Output:

type ServiceAssociationLinksClientListOptions added in v0.3.0 

type ServiceAssociationLinksClientListOptions struct {
}

ServiceAssociationLinksClientListOptions contains the optional parameters for the ServiceAssociationLinksClient.List method.

type ServiceAssociationLinksClientListResponse added in v0.3.0 

type ServiceAssociationLinksClientListResponse struct {
	ServiceAssociationLinksClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceAssociationLinksClientListResponse contains the response from method ServiceAssociationLinksClient.List.

type ServiceAssociationLinksClientListResult added in v0.3.0 

type ServiceAssociationLinksClientListResult struct {
	ServiceAssociationLinksListResult
}

ServiceAssociationLinksClientListResult contains the result from method ServiceAssociationLinksClient.List.

type ServiceAssociationLinksListResult 

type ServiceAssociationLinksListResult struct {
	// The service association links in a subnet.
	Value []*ServiceAssociationLink `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ServiceAssociationLinksListResult - Response for ServiceAssociationLinks_List operation.

func (ServiceAssociationLinksListResult) MarshalJSON 

func (s ServiceAssociationLinksListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceAssociationLinksListResult.

type ServiceDelegationPropertiesFormat 

type ServiceDelegationPropertiesFormat struct {
	// The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).
	ServiceName *string `json:"serviceName,omitempty"`

	// READ-ONLY; The actions permitted to the service upon delegation.
	Actions []*string `json:"actions,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the service delegation resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ServiceDelegationPropertiesFormat - Properties of a service delegation.

func (ServiceDelegationPropertiesFormat) MarshalJSON 

func (s ServiceDelegationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceDelegationPropertiesFormat.

type ServiceEndpointPoliciesClient 

type ServiceEndpointPoliciesClient struct {
	// contains filtered or unexported fields
}

ServiceEndpointPoliciesClient contains the methods for the ServiceEndpointPolicies group. Don't use this type directly, use NewServiceEndpointPoliciesClient() instead.

func NewServiceEndpointPoliciesClient 

func NewServiceEndpointPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ServiceEndpointPoliciesClient

NewServiceEndpointPoliciesClient creates a new instance of ServiceEndpointPoliciesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ServiceEndpointPoliciesClient) BeginCreateOrUpdate 

func (client *ServiceEndpointPoliciesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceEndpointPolicyName string, parameters ServiceEndpointPolicy, options *ServiceEndpointPoliciesClientBeginCreateOrUpdateOptions) (ServiceEndpointPoliciesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a service Endpoint Policies. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceEndpointPolicyName - The name of the service endpoint policy. parameters - Parameters supplied to the create or update service endpoint policy operation. options - ServiceEndpointPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServiceEndpointPoliciesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceEndpointPolicyCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceEndpointPoliciesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-endpoint-policy-name>",
		armnetwork.ServiceEndpointPolicy{
			Location: to.StringPtr("<location>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServiceEndpointPoliciesClientCreateOrUpdateResult)
}

Output:

func (*ServiceEndpointPoliciesClient) BeginDelete 

func (client *ServiceEndpointPoliciesClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceEndpointPolicyName string, options *ServiceEndpointPoliciesClientBeginDeleteOptions) (ServiceEndpointPoliciesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified service endpoint policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceEndpointPolicyName - The name of the service endpoint policy. options - ServiceEndpointPoliciesClientBeginDeleteOptions contains the optional parameters for the ServiceEndpointPoliciesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceEndpointPolicyDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceEndpointPoliciesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-endpoint-policy-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ServiceEndpointPoliciesClient) Get 

func (client *ServiceEndpointPoliciesClient) Get(ctx context.Context, resourceGroupName string, serviceEndpointPolicyName string, options *ServiceEndpointPoliciesClientGetOptions) (ServiceEndpointPoliciesClientGetResponse, error)

Get - Gets the specified service Endpoint Policies in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceEndpointPolicyName - The name of the service endpoint policy. options - ServiceEndpointPoliciesClientGetOptions contains the optional parameters for the ServiceEndpointPoliciesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceEndpointPolicyGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceEndpointPoliciesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-endpoint-policy-name>",
		&armnetwork.ServiceEndpointPoliciesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServiceEndpointPoliciesClientGetResult)
}

Output:

func (*ServiceEndpointPoliciesClient) List 

func (client *ServiceEndpointPoliciesClient) List(options *ServiceEndpointPoliciesClientListOptions) *ServiceEndpointPoliciesClientListPager

List - Gets all the service endpoint policies in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - ServiceEndpointPoliciesClientListOptions contains the optional parameters for the ServiceEndpointPoliciesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceEndpointPolicyListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceEndpointPoliciesClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ServiceEndpointPoliciesClient) ListByResourceGroup 

func (client *ServiceEndpointPoliciesClient) ListByResourceGroup(resourceGroupName string, options *ServiceEndpointPoliciesClientListByResourceGroupOptions) *ServiceEndpointPoliciesClientListByResourceGroupPager

ListByResourceGroup - Gets all service endpoint Policies in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - ServiceEndpointPoliciesClientListByResourceGroupOptions contains the optional parameters for the ServiceEndpointPoliciesClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceEndpointPolicyList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceEndpointPoliciesClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ServiceEndpointPoliciesClient) UpdateTags 

func (client *ServiceEndpointPoliciesClient) UpdateTags(ctx context.Context, resourceGroupName string, serviceEndpointPolicyName string, parameters TagsObject, options *ServiceEndpointPoliciesClientUpdateTagsOptions) (ServiceEndpointPoliciesClientUpdateTagsResponse, error)

UpdateTags - Updates tags of a service endpoint policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceEndpointPolicyName - The name of the service endpoint policy. parameters - Parameters supplied to update service endpoint policy tags. options - ServiceEndpointPoliciesClientUpdateTagsOptions contains the optional parameters for the ServiceEndpointPoliciesClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceEndpointPolicyUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceEndpointPoliciesClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<service-endpoint-policy-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServiceEndpointPoliciesClientUpdateTagsResult)
}

Output:

type ServiceEndpointPoliciesClientBeginCreateOrUpdateOptions added in v0.3.0 

type ServiceEndpointPoliciesClientBeginCreateOrUpdateOptions struct {
}

ServiceEndpointPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServiceEndpointPoliciesClient.BeginCreateOrUpdate method.

type ServiceEndpointPoliciesClientBeginDeleteOptions added in v0.3.0 

type ServiceEndpointPoliciesClientBeginDeleteOptions struct {
}

ServiceEndpointPoliciesClientBeginDeleteOptions contains the optional parameters for the ServiceEndpointPoliciesClient.BeginDelete method.

type ServiceEndpointPoliciesClientCreateOrUpdatePoller added in v0.3.0 

type ServiceEndpointPoliciesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ServiceEndpointPoliciesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ServiceEndpointPoliciesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ServiceEndpointPoliciesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServiceEndpointPoliciesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ServiceEndpointPoliciesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ServiceEndpointPoliciesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServiceEndpointPoliciesClientCreateOrUpdateResponse will be returned.

func (*ServiceEndpointPoliciesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ServiceEndpointPoliciesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServiceEndpointPoliciesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ServiceEndpointPoliciesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServiceEndpointPoliciesClientCreateOrUpdatePollerResponse added in v0.3.0 

type ServiceEndpointPoliciesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServiceEndpointPoliciesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPoliciesClientCreateOrUpdatePollerResponse contains the response from method ServiceEndpointPoliciesClient.CreateOrUpdate.

func (ServiceEndpointPoliciesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ServiceEndpointPoliciesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServiceEndpointPoliciesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServiceEndpointPoliciesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ServiceEndpointPoliciesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ServiceEndpointPoliciesClient, token string) error

Resume rehydrates a ServiceEndpointPoliciesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ServiceEndpointPoliciesClientCreateOrUpdateResponse added in v0.3.0 

type ServiceEndpointPoliciesClientCreateOrUpdateResponse struct {
	ServiceEndpointPoliciesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPoliciesClientCreateOrUpdateResponse contains the response from method ServiceEndpointPoliciesClient.CreateOrUpdate.

type ServiceEndpointPoliciesClientCreateOrUpdateResult added in v0.3.0 

type ServiceEndpointPoliciesClientCreateOrUpdateResult struct {
	ServiceEndpointPolicy
}

ServiceEndpointPoliciesClientCreateOrUpdateResult contains the result from method ServiceEndpointPoliciesClient.CreateOrUpdate.

type ServiceEndpointPoliciesClientDeletePoller added in v0.3.0 

type ServiceEndpointPoliciesClientDeletePoller struct {
	// contains filtered or unexported fields
}

ServiceEndpointPoliciesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ServiceEndpointPoliciesClientDeletePoller) Done added in v0.3.0 

func (p *ServiceEndpointPoliciesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServiceEndpointPoliciesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ServiceEndpointPoliciesClientDeletePoller) FinalResponse(ctx context.Context) (ServiceEndpointPoliciesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServiceEndpointPoliciesClientDeleteResponse will be returned.

func (*ServiceEndpointPoliciesClientDeletePoller) Poll added in v0.3.0 

func (p *ServiceEndpointPoliciesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServiceEndpointPoliciesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ServiceEndpointPoliciesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServiceEndpointPoliciesClientDeletePollerResponse added in v0.3.0 

type ServiceEndpointPoliciesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServiceEndpointPoliciesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPoliciesClientDeletePollerResponse contains the response from method ServiceEndpointPoliciesClient.Delete.

func (ServiceEndpointPoliciesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ServiceEndpointPoliciesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServiceEndpointPoliciesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServiceEndpointPoliciesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ServiceEndpointPoliciesClientDeletePollerResponse) Resume(ctx context.Context, client *ServiceEndpointPoliciesClient, token string) error

Resume rehydrates a ServiceEndpointPoliciesClientDeletePollerResponse from the provided client and resume token.

type ServiceEndpointPoliciesClientDeleteResponse added in v0.3.0 

type ServiceEndpointPoliciesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPoliciesClientDeleteResponse contains the response from method ServiceEndpointPoliciesClient.Delete.

type ServiceEndpointPoliciesClientGetOptions added in v0.3.0 

type ServiceEndpointPoliciesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

ServiceEndpointPoliciesClientGetOptions contains the optional parameters for the ServiceEndpointPoliciesClient.Get method.

type ServiceEndpointPoliciesClientGetResponse added in v0.3.0 

type ServiceEndpointPoliciesClientGetResponse struct {
	ServiceEndpointPoliciesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPoliciesClientGetResponse contains the response from method ServiceEndpointPoliciesClient.Get.

type ServiceEndpointPoliciesClientGetResult added in v0.3.0 

type ServiceEndpointPoliciesClientGetResult struct {
	ServiceEndpointPolicy
}

ServiceEndpointPoliciesClientGetResult contains the result from method ServiceEndpointPoliciesClient.Get.

type ServiceEndpointPoliciesClientListByResourceGroupOptions added in v0.3.0 

type ServiceEndpointPoliciesClientListByResourceGroupOptions struct {
}

ServiceEndpointPoliciesClientListByResourceGroupOptions contains the optional parameters for the ServiceEndpointPoliciesClient.ListByResourceGroup method.

type ServiceEndpointPoliciesClientListByResourceGroupPager added in v0.3.0 

type ServiceEndpointPoliciesClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

ServiceEndpointPoliciesClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*ServiceEndpointPoliciesClientListByResourceGroupPager) Err added in v0.3.0 

func (p *ServiceEndpointPoliciesClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*ServiceEndpointPoliciesClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *ServiceEndpointPoliciesClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ServiceEndpointPoliciesClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *ServiceEndpointPoliciesClientListByResourceGroupPager) PageResponse() ServiceEndpointPoliciesClientListByResourceGroupResponse

PageResponse returns the current ServiceEndpointPoliciesClientListByResourceGroupResponse page.

type ServiceEndpointPoliciesClientListByResourceGroupResponse added in v0.3.0 

type ServiceEndpointPoliciesClientListByResourceGroupResponse struct {
	ServiceEndpointPoliciesClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPoliciesClientListByResourceGroupResponse contains the response from method ServiceEndpointPoliciesClient.ListByResourceGroup.

type ServiceEndpointPoliciesClientListByResourceGroupResult added in v0.3.0 

type ServiceEndpointPoliciesClientListByResourceGroupResult struct {
	ServiceEndpointPolicyListResult
}

ServiceEndpointPoliciesClientListByResourceGroupResult contains the result from method ServiceEndpointPoliciesClient.ListByResourceGroup.

type ServiceEndpointPoliciesClientListOptions added in v0.3.0 

type ServiceEndpointPoliciesClientListOptions struct {
}

ServiceEndpointPoliciesClientListOptions contains the optional parameters for the ServiceEndpointPoliciesClient.List method.

type ServiceEndpointPoliciesClientListPager added in v0.3.0 

type ServiceEndpointPoliciesClientListPager struct {
	// contains filtered or unexported fields
}

ServiceEndpointPoliciesClientListPager provides operations for iterating over paged responses.

func (*ServiceEndpointPoliciesClientListPager) Err added in v0.3.0 

func (p *ServiceEndpointPoliciesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ServiceEndpointPoliciesClientListPager) NextPage added in v0.3.0 

func (p *ServiceEndpointPoliciesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ServiceEndpointPoliciesClientListPager) PageResponse added in v0.3.0 

func (p *ServiceEndpointPoliciesClientListPager) PageResponse() ServiceEndpointPoliciesClientListResponse

PageResponse returns the current ServiceEndpointPoliciesClientListResponse page.

type ServiceEndpointPoliciesClientListResponse added in v0.3.0 

type ServiceEndpointPoliciesClientListResponse struct {
	ServiceEndpointPoliciesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPoliciesClientListResponse contains the response from method ServiceEndpointPoliciesClient.List.

type ServiceEndpointPoliciesClientListResult added in v0.3.0 

type ServiceEndpointPoliciesClientListResult struct {
	ServiceEndpointPolicyListResult
}

ServiceEndpointPoliciesClientListResult contains the result from method ServiceEndpointPoliciesClient.List.

type ServiceEndpointPoliciesClientUpdateTagsOptions added in v0.3.0 

type ServiceEndpointPoliciesClientUpdateTagsOptions struct {
}

ServiceEndpointPoliciesClientUpdateTagsOptions contains the optional parameters for the ServiceEndpointPoliciesClient.UpdateTags method.

type ServiceEndpointPoliciesClientUpdateTagsResponse added in v0.3.0 

type ServiceEndpointPoliciesClientUpdateTagsResponse struct {
	ServiceEndpointPoliciesClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPoliciesClientUpdateTagsResponse contains the response from method ServiceEndpointPoliciesClient.UpdateTags.

type ServiceEndpointPoliciesClientUpdateTagsResult added in v0.3.0 

type ServiceEndpointPoliciesClientUpdateTagsResult struct {
	ServiceEndpointPolicy
}

ServiceEndpointPoliciesClientUpdateTagsResult contains the result from method ServiceEndpointPoliciesClient.UpdateTags.

type ServiceEndpointPolicy 

type ServiceEndpointPolicy struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the service end point policy.
	Properties *ServiceEndpointPolicyPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Kind of service endpoint policy. This is metadata used for the Azure portal experience.
	Kind *string `json:"kind,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ServiceEndpointPolicy - Service End point policy resource.

func (ServiceEndpointPolicy) MarshalJSON 

func (s ServiceEndpointPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceEndpointPolicy.

type ServiceEndpointPolicyDefinition 

type ServiceEndpointPolicyDefinition struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the service endpoint policy definition.
	Properties *ServiceEndpointPolicyDefinitionPropertiesFormat `json:"properties,omitempty"`

	// The type of the resource.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

ServiceEndpointPolicyDefinition - Service Endpoint policy definitions.

type ServiceEndpointPolicyDefinitionListResult 

type ServiceEndpointPolicyDefinitionListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The service endpoint policy definition in a service endpoint policy.
	Value []*ServiceEndpointPolicyDefinition `json:"value,omitempty"`
}

ServiceEndpointPolicyDefinitionListResult - Response for ListServiceEndpointPolicyDefinition API service call. Retrieves all service endpoint policy definition that belongs to a service endpoint policy.

func (ServiceEndpointPolicyDefinitionListResult) MarshalJSON 

func (s ServiceEndpointPolicyDefinitionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceEndpointPolicyDefinitionListResult.

type ServiceEndpointPolicyDefinitionPropertiesFormat 

type ServiceEndpointPolicyDefinitionPropertiesFormat struct {
	// A description for this rule. Restricted to 140 chars.
	Description *string `json:"description,omitempty"`

	// Service endpoint name.
	Service *string `json:"service,omitempty"`

	// A list of service resources.
	ServiceResources []*string `json:"serviceResources,omitempty"`

	// READ-ONLY; The provisioning state of the service endpoint policy definition resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ServiceEndpointPolicyDefinitionPropertiesFormat - Service Endpoint policy definition resource.

func (ServiceEndpointPolicyDefinitionPropertiesFormat) MarshalJSON 

func (s ServiceEndpointPolicyDefinitionPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceEndpointPolicyDefinitionPropertiesFormat.

type ServiceEndpointPolicyDefinitionsClient 

type ServiceEndpointPolicyDefinitionsClient struct {
	// contains filtered or unexported fields
}

ServiceEndpointPolicyDefinitionsClient contains the methods for the ServiceEndpointPolicyDefinitions group. Don't use this type directly, use NewServiceEndpointPolicyDefinitionsClient() instead.

func NewServiceEndpointPolicyDefinitionsClient 

func NewServiceEndpointPolicyDefinitionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ServiceEndpointPolicyDefinitionsClient

NewServiceEndpointPolicyDefinitionsClient creates a new instance of ServiceEndpointPolicyDefinitionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ServiceEndpointPolicyDefinitionsClient) BeginCreateOrUpdate 

func (client *ServiceEndpointPolicyDefinitionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, serviceEndpointPolicyName string, serviceEndpointPolicyDefinitionName string, serviceEndpointPolicyDefinitions ServiceEndpointPolicyDefinition, options *ServiceEndpointPolicyDefinitionsClientBeginCreateOrUpdateOptions) (ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a service endpoint policy definition in the specified service endpoint policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceEndpointPolicyName - The name of the service endpoint policy. serviceEndpointPolicyDefinitionName - The name of the service endpoint policy definition name. serviceEndpointPolicyDefinitions - Parameters supplied to the create or update service endpoint policy operation. options - ServiceEndpointPolicyDefinitionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceEndpointPolicyDefinitionCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceEndpointPolicyDefinitionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<service-endpoint-policy-name>",
		"<service-endpoint-policy-definition-name>",
		armnetwork.ServiceEndpointPolicyDefinition{
			Properties: &armnetwork.ServiceEndpointPolicyDefinitionPropertiesFormat{
				Description: to.StringPtr("<description>"),
				Service:     to.StringPtr("<service>"),
				ServiceResources: []*string{
					to.StringPtr("/subscriptions/subid1"),
					to.StringPtr("/subscriptions/subid1/resourceGroups/storageRg"),
					to.StringPtr("/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount")},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResult)
}

Output:

func (*ServiceEndpointPolicyDefinitionsClient) BeginDelete 

func (client *ServiceEndpointPolicyDefinitionsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceEndpointPolicyName string, serviceEndpointPolicyDefinitionName string, options *ServiceEndpointPolicyDefinitionsClientBeginDeleteOptions) (ServiceEndpointPolicyDefinitionsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified ServiceEndpoint policy definitions. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceEndpointPolicyName - The name of the Service Endpoint Policy. serviceEndpointPolicyDefinitionName - The name of the service endpoint policy definition. options - ServiceEndpointPolicyDefinitionsClientBeginDeleteOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceEndpointPolicyDefinitionDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceEndpointPolicyDefinitionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<service-endpoint-policy-name>",
		"<service-endpoint-policy-definition-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ServiceEndpointPolicyDefinitionsClient) Get 

func (client *ServiceEndpointPolicyDefinitionsClient) Get(ctx context.Context, resourceGroupName string, serviceEndpointPolicyName string, serviceEndpointPolicyDefinitionName string, options *ServiceEndpointPolicyDefinitionsClientGetOptions) (ServiceEndpointPolicyDefinitionsClientGetResponse, error)

Get - Get the specified service endpoint policy definitions from service endpoint policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceEndpointPolicyName - The name of the service endpoint policy name. serviceEndpointPolicyDefinitionName - The name of the service endpoint policy definition name. options - ServiceEndpointPolicyDefinitionsClientGetOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceEndpointPolicyDefinitionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceEndpointPolicyDefinitionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<service-endpoint-policy-name>",
		"<service-endpoint-policy-definition-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServiceEndpointPolicyDefinitionsClientGetResult)
}

Output:

func (*ServiceEndpointPolicyDefinitionsClient) ListByResourceGroup 

func (client *ServiceEndpointPolicyDefinitionsClient) ListByResourceGroup(resourceGroupName string, serviceEndpointPolicyName string, options *ServiceEndpointPolicyDefinitionsClientListByResourceGroupOptions) *ServiceEndpointPolicyDefinitionsClientListByResourceGroupPager

ListByResourceGroup - Gets all service endpoint policy definitions in a service end point policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. serviceEndpointPolicyName - The name of the service endpoint policy name. options - ServiceEndpointPolicyDefinitionsClientListByResourceGroupOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceEndpointPolicyDefinitionList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceEndpointPolicyDefinitionsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		"<service-endpoint-policy-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ServiceEndpointPolicyDefinitionsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientBeginCreateOrUpdateOptions struct {
}

ServiceEndpointPolicyDefinitionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.BeginCreateOrUpdate method.

type ServiceEndpointPolicyDefinitionsClientBeginDeleteOptions added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientBeginDeleteOptions struct {
}

ServiceEndpointPolicyDefinitionsClientBeginDeleteOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.BeginDelete method.

type ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResponse will be returned.

func (*ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePollerResponse contains the response from method ServiceEndpointPolicyDefinitionsClient.CreateOrUpdate.

func (ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ServiceEndpointPolicyDefinitionsClient, token string) error

Resume rehydrates a ServiceEndpointPolicyDefinitionsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResponse added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResponse struct {
	ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResponse contains the response from method ServiceEndpointPolicyDefinitionsClient.CreateOrUpdate.

type ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResult added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResult struct {
	ServiceEndpointPolicyDefinition
}

ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResult contains the result from method ServiceEndpointPolicyDefinitionsClient.CreateOrUpdate.

type ServiceEndpointPolicyDefinitionsClientDeletePoller added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ServiceEndpointPolicyDefinitionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ServiceEndpointPolicyDefinitionsClientDeletePoller) Done added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServiceEndpointPolicyDefinitionsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientDeletePoller) FinalResponse(ctx context.Context) (ServiceEndpointPolicyDefinitionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServiceEndpointPolicyDefinitionsClientDeleteResponse will be returned.

func (*ServiceEndpointPolicyDefinitionsClientDeletePoller) Poll added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServiceEndpointPolicyDefinitionsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServiceEndpointPolicyDefinitionsClientDeletePollerResponse added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServiceEndpointPolicyDefinitionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPolicyDefinitionsClientDeletePollerResponse contains the response from method ServiceEndpointPolicyDefinitionsClient.Delete.

func (ServiceEndpointPolicyDefinitionsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ServiceEndpointPolicyDefinitionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServiceEndpointPolicyDefinitionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServiceEndpointPolicyDefinitionsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ServiceEndpointPolicyDefinitionsClientDeletePollerResponse) Resume(ctx context.Context, client *ServiceEndpointPolicyDefinitionsClient, token string) error

Resume rehydrates a ServiceEndpointPolicyDefinitionsClientDeletePollerResponse from the provided client and resume token.

type ServiceEndpointPolicyDefinitionsClientDeleteResponse added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPolicyDefinitionsClientDeleteResponse contains the response from method ServiceEndpointPolicyDefinitionsClient.Delete.

type ServiceEndpointPolicyDefinitionsClientGetOptions added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientGetOptions struct {
}

ServiceEndpointPolicyDefinitionsClientGetOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.Get method.

type ServiceEndpointPolicyDefinitionsClientGetResponse added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientGetResponse struct {
	ServiceEndpointPolicyDefinitionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPolicyDefinitionsClientGetResponse contains the response from method ServiceEndpointPolicyDefinitionsClient.Get.

type ServiceEndpointPolicyDefinitionsClientGetResult added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientGetResult struct {
	ServiceEndpointPolicyDefinition
}

ServiceEndpointPolicyDefinitionsClientGetResult contains the result from method ServiceEndpointPolicyDefinitionsClient.Get.

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupOptions added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupOptions struct {
}

ServiceEndpointPolicyDefinitionsClientListByResourceGroupOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.ListByResourceGroup method.

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupPager added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

ServiceEndpointPolicyDefinitionsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*ServiceEndpointPolicyDefinitionsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*ServiceEndpointPolicyDefinitionsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ServiceEndpointPolicyDefinitionsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *ServiceEndpointPolicyDefinitionsClientListByResourceGroupPager) PageResponse() ServiceEndpointPolicyDefinitionsClientListByResourceGroupResponse

PageResponse returns the current ServiceEndpointPolicyDefinitionsClientListByResourceGroupResponse page.

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupResponse added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupResponse struct {
	ServiceEndpointPolicyDefinitionsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceEndpointPolicyDefinitionsClientListByResourceGroupResponse contains the response from method ServiceEndpointPolicyDefinitionsClient.ListByResourceGroup.

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupResult added in v0.3.0 

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupResult struct {
	ServiceEndpointPolicyDefinitionListResult
}

ServiceEndpointPolicyDefinitionsClientListByResourceGroupResult contains the result from method ServiceEndpointPolicyDefinitionsClient.ListByResourceGroup.

type ServiceEndpointPolicyListResult 

type ServiceEndpointPolicyListResult struct {
	// A list of ServiceEndpointPolicy resources.
	Value []*ServiceEndpointPolicy `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ServiceEndpointPolicyListResult - Response for ListServiceEndpointPolicies API service call.

func (ServiceEndpointPolicyListResult) MarshalJSON 

func (s ServiceEndpointPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceEndpointPolicyListResult.

type ServiceEndpointPolicyPropertiesFormat 

type ServiceEndpointPolicyPropertiesFormat struct {
	// A collection of contextual service endpoint policy.
	ContextualServiceEndpointPolicies []*string `json:"contextualServiceEndpointPolicies,omitempty"`

	// The alias indicating if the policy belongs to a service
	ServiceAlias *string `json:"serviceAlias,omitempty"`

	// A collection of service endpoint policy definitions of the service endpoint policy.
	ServiceEndpointPolicyDefinitions []*ServiceEndpointPolicyDefinition `json:"serviceEndpointPolicyDefinitions,omitempty"`

	// READ-ONLY; The provisioning state of the service endpoint policy resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the service endpoint policy resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`

	// READ-ONLY; A collection of references to subnets.
	Subnets []*Subnet `json:"subnets,omitempty" azure:"ro"`
}

ServiceEndpointPolicyPropertiesFormat - Service Endpoint Policy resource.

func (ServiceEndpointPolicyPropertiesFormat) MarshalJSON 

func (s ServiceEndpointPolicyPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceEndpointPolicyPropertiesFormat.

type ServiceEndpointPropertiesFormat 

type ServiceEndpointPropertiesFormat struct {
	// A list of locations.
	Locations []*string `json:"locations,omitempty"`

	// The type of the endpoint service.
	Service *string `json:"service,omitempty"`

	// READ-ONLY; The provisioning state of the service endpoint resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ServiceEndpointPropertiesFormat - The service endpoint properties.

func (ServiceEndpointPropertiesFormat) MarshalJSON 

func (s ServiceEndpointPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceEndpointPropertiesFormat.

type ServiceProviderProvisioningState 

type ServiceProviderProvisioningState string

ServiceProviderProvisioningState - The ServiceProviderProvisioningState state of the resource. 

const (
	ServiceProviderProvisioningStateDeprovisioning ServiceProviderProvisioningState = "Deprovisioning"
	ServiceProviderProvisioningStateNotProvisioned ServiceProviderProvisioningState = "NotProvisioned"
	ServiceProviderProvisioningStateProvisioned    ServiceProviderProvisioningState = "Provisioned"
	ServiceProviderProvisioningStateProvisioning   ServiceProviderProvisioningState = "Provisioning"
)

func PossibleServiceProviderProvisioningStateValues 

func PossibleServiceProviderProvisioningStateValues() []ServiceProviderProvisioningState

PossibleServiceProviderProvisioningStateValues returns the possible values for the ServiceProviderProvisioningState const type.

func (ServiceProviderProvisioningState) ToPtr 

func (c ServiceProviderProvisioningState) ToPtr() *ServiceProviderProvisioningState

ToPtr returns a *ServiceProviderProvisioningState pointing to the current value.

type ServiceTagInformation 

type ServiceTagInformation struct {
	// READ-ONLY; The ID of service tag.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of service tag.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Properties of the service tag information.
	Properties *ServiceTagInformationPropertiesFormat `json:"properties,omitempty" azure:"ro"`

	// READ-ONLY; The iteration number of service tag object for region.
	ServiceTagChangeNumber *string `json:"serviceTagChangeNumber,omitempty" azure:"ro"`
}

ServiceTagInformation - The service tag information.

type ServiceTagInformationClient 

type ServiceTagInformationClient struct {
	// contains filtered or unexported fields
}

ServiceTagInformationClient contains the methods for the ServiceTagInformation group. Don't use this type directly, use NewServiceTagInformationClient() instead.

func NewServiceTagInformationClient 

func NewServiceTagInformationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ServiceTagInformationClient

NewServiceTagInformationClient creates a new instance of ServiceTagInformationClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ServiceTagInformationClient) List 

func (client *ServiceTagInformationClient) List(location string, options *ServiceTagInformationClientListOptions) *ServiceTagInformationClientListPager

List - Gets a list of service tag information resources with pagination. If the operation fails it returns an *azcore.ResponseError type. location - The location that will be used as a reference for cloud (not as a filter based on location, you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to). options - ServiceTagInformationClientListOptions contains the optional parameters for the ServiceTagInformationClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceTagInformationListResult.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceTagInformationClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		&armnetwork.ServiceTagInformationClientListOptions{NoAddressPrefixes: nil,
			TagName: nil,
		})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ServiceTagInformationClientListOptions added in v0.3.0 

type ServiceTagInformationClientListOptions struct {
	// Do not return address prefixes for the tag(s).
	NoAddressPrefixes *bool
	// Return tag information for a particular tag.
	TagName *string
}

ServiceTagInformationClientListOptions contains the optional parameters for the ServiceTagInformationClient.List method.

type ServiceTagInformationClientListPager added in v0.3.0 

type ServiceTagInformationClientListPager struct {
	// contains filtered or unexported fields
}

ServiceTagInformationClientListPager provides operations for iterating over paged responses.

func (*ServiceTagInformationClientListPager) Err added in v0.3.0 

func (p *ServiceTagInformationClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ServiceTagInformationClientListPager) NextPage added in v0.3.0 

func (p *ServiceTagInformationClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ServiceTagInformationClientListPager) PageResponse added in v0.3.0 

func (p *ServiceTagInformationClientListPager) PageResponse() ServiceTagInformationClientListResponse

PageResponse returns the current ServiceTagInformationClientListResponse page.

type ServiceTagInformationClientListResponse added in v0.3.0 

type ServiceTagInformationClientListResponse struct {
	ServiceTagInformationClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceTagInformationClientListResponse contains the response from method ServiceTagInformationClient.List.

type ServiceTagInformationClientListResult added in v0.3.0 

type ServiceTagInformationClientListResult struct {
	ServiceTagInformationListResult
}

ServiceTagInformationClientListResult contains the result from method ServiceTagInformationClient.List.

type ServiceTagInformationListResult 

type ServiceTagInformationListResult struct {
	// The list of service tag information resources.
	Value []*ServiceTagInformation `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ServiceTagInformationListResult - Response for Get ServiceTagInformation API service call. Retrieves the list of service tag information resources.

func (ServiceTagInformationListResult) MarshalJSON 

func (s ServiceTagInformationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceTagInformationListResult.

type ServiceTagInformationPropertiesFormat 

type ServiceTagInformationPropertiesFormat struct {
	// READ-ONLY; The list of IP address prefixes.
	AddressPrefixes []*string `json:"addressPrefixes,omitempty" azure:"ro"`

	// READ-ONLY; The iteration number of service tag.
	ChangeNumber *string `json:"changeNumber,omitempty" azure:"ro"`

	// READ-ONLY; The region of service tag.
	Region *string `json:"region,omitempty" azure:"ro"`

	// READ-ONLY; The state of the service tag.
	State *string `json:"state,omitempty" azure:"ro"`

	// READ-ONLY; The name of system service.
	SystemService *string `json:"systemService,omitempty" azure:"ro"`
}

ServiceTagInformationPropertiesFormat - Properties of the service tag information.

func (ServiceTagInformationPropertiesFormat) MarshalJSON 

func (s ServiceTagInformationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceTagInformationPropertiesFormat.

type ServiceTagsClient 

type ServiceTagsClient struct {
	// contains filtered or unexported fields
}

ServiceTagsClient contains the methods for the ServiceTags group. Don't use this type directly, use NewServiceTagsClient() instead.

func NewServiceTagsClient 

func NewServiceTagsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ServiceTagsClient

NewServiceTagsClient creates a new instance of ServiceTagsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ServiceTagsClient) List 

func (client *ServiceTagsClient) List(ctx context.Context, location string, options *ServiceTagsClientListOptions) (ServiceTagsClientListResponse, error)

List - Gets a list of service tag information resources. If the operation fails it returns an *azcore.ResponseError type. location - The location that will be used as a reference for version (not as a filter based on location, you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to). options - ServiceTagsClientListOptions contains the optional parameters for the ServiceTagsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/ServiceTagsList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewServiceTagsClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<location>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServiceTagsClientListResult)
}

Output:

type ServiceTagsClientListOptions added in v0.3.0 

type ServiceTagsClientListOptions struct {
}

ServiceTagsClientListOptions contains the optional parameters for the ServiceTagsClient.List method.

type ServiceTagsClientListResponse added in v0.3.0 

type ServiceTagsClientListResponse struct {
	ServiceTagsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServiceTagsClientListResponse contains the response from method ServiceTagsClient.List.

type ServiceTagsClientListResult added in v0.3.0 

type ServiceTagsClientListResult struct {
	ServiceTagsListResult
}

ServiceTagsClientListResult contains the result from method ServiceTagsClient.List.

type ServiceTagsListResult 

type ServiceTagsListResult struct {
	// READ-ONLY; The iteration number.
	ChangeNumber *string `json:"changeNumber,omitempty" azure:"ro"`

	// READ-ONLY; The name of the cloud.
	Cloud *string `json:"cloud,omitempty" azure:"ro"`

	// READ-ONLY; The ID of the cloud.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the cloud.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The URL to get next page of service tag information resources.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; The azure resource type.
	Type *string `json:"type,omitempty" azure:"ro"`

	// READ-ONLY; The list of service tag information resources.
	Values []*ServiceTagInformation `json:"values,omitempty" azure:"ro"`
}

ServiceTagsListResult - Response for the ListServiceTags API service call.

func (ServiceTagsListResult) MarshalJSON 

func (s ServiceTagsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceTagsListResult.

type SessionIDs 

type SessionIDs struct {
	// List of session IDs.
	SessionIDs []*string `json:"sessionIds,omitempty"`
}

SessionIDs - List of session IDs.

func (SessionIDs) MarshalJSON 

func (s SessionIDs) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SessionIDs.

type Severity 

type Severity string

Severity - The severity of the issue. 

const (
	SeverityError   Severity = "Error"
	SeverityWarning Severity = "Warning"
)

func PossibleSeverityValues 

func PossibleSeverityValues() []Severity

PossibleSeverityValues returns the possible values for the Severity const type.

func (Severity) ToPtr 

func (c Severity) ToPtr() *Severity

ToPtr returns a *Severity pointing to the current value.

type SignatureOverridesFilterValuesQuery added in v0.2.0 

type SignatureOverridesFilterValuesQuery struct {
	// Describes the name of the column which values will be returned
	FilterName *string `json:"filterName,omitempty"`
}

SignatureOverridesFilterValuesQuery - Describes the filter values possibles for a given column

type SignatureOverridesFilterValuesResponse added in v0.2.0 

type SignatureOverridesFilterValuesResponse struct {
	// Describes the possible values
	FilterValues []*string `json:"filterValues,omitempty"`
}

SignatureOverridesFilterValuesResponse - Describes the list of all possible values for a specific filter value

func (SignatureOverridesFilterValuesResponse) MarshalJSON added in v0.2.0 

func (s SignatureOverridesFilterValuesResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SignatureOverridesFilterValuesResponse.

type SignaturesOverrides added in v0.2.0 

type SignaturesOverrides struct {
	// Will contain the resource id of the signature override resource
	ID *string `json:"id,omitempty"`

	// Contains the name of the resource (default)
	Name *string `json:"name,omitempty"`

	// Will contain the properties of the resource (the actual signature overrides)
	Properties *SignaturesOverridesProperties `json:"properties,omitempty"`

	// Will contain the type of the resource: Microsoft.Network/firewallPolicies/intrusionDetectionSignaturesOverrides
	Type *string `json:"type,omitempty"`
}

SignaturesOverrides - Contains all specific policy signatures overrides for the IDPS

func (SignaturesOverrides) MarshalJSON added in v0.2.0 

func (s SignaturesOverrides) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SignaturesOverrides.

type SignaturesOverridesList added in v0.2.0 

type SignaturesOverridesList struct {
	// Describes a list consisting exactly one item describing the policy's signature override status
	Value []*SignaturesOverrides `json:"value,omitempty"`
}

SignaturesOverridesList - Describes an object containing an array with a single item

func (SignaturesOverridesList) MarshalJSON added in v0.2.0 

func (s SignaturesOverridesList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SignaturesOverridesList.

type SignaturesOverridesProperties added in v0.2.0 

type SignaturesOverridesProperties struct {
	// Dictionary of
	Signatures map[string]*string `json:"signatures,omitempty"`
}

SignaturesOverridesProperties - Will contain the properties of the resource (the actual signature overrides)

func (SignaturesOverridesProperties) MarshalJSON added in v0.2.0 

func (s SignaturesOverridesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SignaturesOverridesProperties.

type SingleQueryResult added in v0.2.0 

type SingleQueryResult struct {
	// Describes what is the signature enforces
	Description *string `json:"description,omitempty"`

	// Describes the list of destination ports related to this signature
	DestinationPorts []*string `json:"destinationPorts,omitempty"`

	// Describes in which direction signature is being enforced: 0 - Inbound, 1 - OutBound, 2 - Bidirectional
	Direction *SingleQueryResultDirection `json:"direction,omitempty"`

	// Describes the groups the signature belongs to
	Group *string `json:"group,omitempty"`

	// Describes if this override is inherited from base policy or not
	InheritedFromParentPolicy *bool `json:"inheritedFromParentPolicy,omitempty"`

	// Describes the last updated time of the signature (provided from 3rd party vendor)
	LastUpdated *string `json:"lastUpdated,omitempty"`

	// The current mode enforced, 0 - Disabled, 1 - Alert, 2 -Deny
	Mode *SingleQueryResultMode `json:"mode,omitempty"`

	// Describes the protocol the signatures is being enforced in
	Protocol *string `json:"protocol,omitempty"`

	// Describes the severity of signature: 1 - Low, 2 - Medium, 3 - High
	Severity *SingleQueryResultSeverity `json:"severity,omitempty"`

	// The ID of the signature
	SignatureID *int32 `json:"signatureId,omitempty"`

	// Describes the list of source ports related to this signature
	SourcePorts []*string `json:"sourcePorts,omitempty"`
}

func (SingleQueryResult) MarshalJSON added in v0.2.0 

func (s SingleQueryResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SingleQueryResult.

type SingleQueryResultDirection added in v0.2.0 

type SingleQueryResultDirection int32

SingleQueryResultDirection - Describes in which direction signature is being enforced: 0 - Inbound, 1 - OutBound, 2 - Bidirectional 

const (
	SingleQueryResultDirectionOne  SingleQueryResultDirection = 1
	SingleQueryResultDirectionTwo  SingleQueryResultDirection = 2
	SingleQueryResultDirectionZero SingleQueryResultDirection = 0
)

func PossibleSingleQueryResultDirectionValues added in v0.2.0 

func PossibleSingleQueryResultDirectionValues() []SingleQueryResultDirection

PossibleSingleQueryResultDirectionValues returns the possible values for the SingleQueryResultDirection const type.

func (SingleQueryResultDirection) ToPtr added in v0.2.0 

func (c SingleQueryResultDirection) ToPtr() *SingleQueryResultDirection

ToPtr returns a *SingleQueryResultDirection pointing to the current value.

type SingleQueryResultMode added in v0.2.0 

type SingleQueryResultMode int32

SingleQueryResultMode - The current mode enforced, 0 - Disabled, 1 - Alert, 2 -Deny 

const (
	SingleQueryResultModeOne  SingleQueryResultMode = 1
	SingleQueryResultModeTwo  SingleQueryResultMode = 2
	SingleQueryResultModeZero SingleQueryResultMode = 0
)

func PossibleSingleQueryResultModeValues added in v0.2.0 

func PossibleSingleQueryResultModeValues() []SingleQueryResultMode

PossibleSingleQueryResultModeValues returns the possible values for the SingleQueryResultMode const type.

func (SingleQueryResultMode) ToPtr added in v0.2.0 

func (c SingleQueryResultMode) ToPtr() *SingleQueryResultMode

ToPtr returns a *SingleQueryResultMode pointing to the current value.

type SingleQueryResultSeverity added in v0.2.0 

type SingleQueryResultSeverity int32

SingleQueryResultSeverity - Describes the severity of signature: 1 - Low, 2 - Medium, 3 - High 

const (
	SingleQueryResultSeverityOne   SingleQueryResultSeverity = 1
	SingleQueryResultSeverityThree SingleQueryResultSeverity = 3
	SingleQueryResultSeverityTwo   SingleQueryResultSeverity = 2
)

func PossibleSingleQueryResultSeverityValues added in v0.2.0 

func PossibleSingleQueryResultSeverityValues() []SingleQueryResultSeverity

PossibleSingleQueryResultSeverityValues returns the possible values for the SingleQueryResultSeverity const type.

func (SingleQueryResultSeverity) ToPtr added in v0.2.0 

func (c SingleQueryResultSeverity) ToPtr() *SingleQueryResultSeverity

ToPtr returns a *SingleQueryResultSeverity pointing to the current value.

type StaticRoute 

type StaticRoute struct {
	// List of all address prefixes.
	AddressPrefixes []*string `json:"addressPrefixes,omitempty"`

	// The name of the StaticRoute that is unique within a VnetRoute.
	Name *string `json:"name,omitempty"`

	// The ip address of the next hop.
	NextHopIPAddress *string `json:"nextHopIpAddress,omitempty"`
}

StaticRoute - List of all Static Routes.

func (StaticRoute) MarshalJSON 

func (s StaticRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StaticRoute.

type SubResource 

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

SubResource - Reference to another subresource.

type Subnet 

type Subnet struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the subnet.
	Properties *SubnetPropertiesFormat `json:"properties,omitempty"`

	// Resource type.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

Subnet in a virtual network resource.

type SubnetAssociation 

type SubnetAssociation struct {
	// Collection of custom security rules.
	SecurityRules []*SecurityRule `json:"securityRules,omitempty"`

	// READ-ONLY; Subnet ID.
	ID *string `json:"id,omitempty" azure:"ro"`
}

SubnetAssociation - Subnet and it's custom security rules.

func (SubnetAssociation) MarshalJSON 

func (s SubnetAssociation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubnetAssociation.

type SubnetListResult 

type SubnetListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The subnets in a virtual network.
	Value []*Subnet `json:"value,omitempty"`
}

SubnetListResult - Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network.

func (SubnetListResult) MarshalJSON 

func (s SubnetListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubnetListResult.

type SubnetPropertiesFormat 

type SubnetPropertiesFormat struct {
	// The address prefix for the subnet.
	AddressPrefix *string `json:"addressPrefix,omitempty"`

	// List of address prefixes for the subnet.
	AddressPrefixes []*string `json:"addressPrefixes,omitempty"`

	// Application gateway IP configurations of virtual network resource.
	ApplicationGatewayIPConfigurations []*ApplicationGatewayIPConfiguration `json:"applicationGatewayIpConfigurations,omitempty"`

	// An array of references to the delegations on the subnet.
	Delegations []*Delegation `json:"delegations,omitempty"`

	// Array of IpAllocation which reference this subnet.
	IPAllocations []*SubResource `json:"ipAllocations,omitempty"`

	// Nat gateway associated with this subnet.
	NatGateway *SubResource `json:"natGateway,omitempty"`

	// The reference to the NetworkSecurityGroup resource.
	NetworkSecurityGroup *SecurityGroup `json:"networkSecurityGroup,omitempty"`

	// Enable or Disable apply network policies on private end point in the subnet.
	PrivateEndpointNetworkPolicies *VirtualNetworkPrivateEndpointNetworkPolicies `json:"privateEndpointNetworkPolicies,omitempty"`

	// Enable or Disable apply network policies on private link service in the subnet.
	PrivateLinkServiceNetworkPolicies *VirtualNetworkPrivateLinkServiceNetworkPolicies `json:"privateLinkServiceNetworkPolicies,omitempty"`

	// The reference to the RouteTable resource.
	RouteTable *RouteTable `json:"routeTable,omitempty"`

	// An array of service endpoint policies.
	ServiceEndpointPolicies []*ServiceEndpointPolicy `json:"serviceEndpointPolicies,omitempty"`

	// An array of service endpoints.
	ServiceEndpoints []*ServiceEndpointPropertiesFormat `json:"serviceEndpoints,omitempty"`

	// READ-ONLY; Array of IP configuration profiles which reference this subnet.
	IPConfigurationProfiles []*IPConfigurationProfile `json:"ipConfigurationProfiles,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to the network interface IP configurations using subnet.
	IPConfigurations []*IPConfiguration `json:"ipConfigurations,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to private endpoints.
	PrivateEndpoints []*PrivateEndpoint `json:"privateEndpoints,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the subnet resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; A read-only string identifying the intention of use for this subnet based on delegations and other user-defined
	// properties.
	Purpose *string `json:"purpose,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to the external resources using subnet.
	ResourceNavigationLinks []*ResourceNavigationLink `json:"resourceNavigationLinks,omitempty" azure:"ro"`

	// READ-ONLY; An array of references to services injecting into this subnet.
	ServiceAssociationLinks []*ServiceAssociationLink `json:"serviceAssociationLinks,omitempty" azure:"ro"`
}

SubnetPropertiesFormat - Properties of the subnet.

func (SubnetPropertiesFormat) MarshalJSON 

func (s SubnetPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubnetPropertiesFormat.

type SubnetsClient 

type SubnetsClient struct {
	// contains filtered or unexported fields
}

SubnetsClient contains the methods for the Subnets group. Don't use this type directly, use NewSubnetsClient() instead.

func NewSubnetsClient 

func NewSubnetsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *SubnetsClient

NewSubnetsClient creates a new instance of SubnetsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SubnetsClient) BeginCreateOrUpdate 

func (client *SubnetsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, subnetParameters Subnet, options *SubnetsClientBeginCreateOrUpdateOptions) (SubnetsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a subnet in the specified virtual network. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. subnetName - The name of the subnet. subnetParameters - Parameters supplied to the create or update subnet operation. options - SubnetsClientBeginCreateOrUpdateOptions contains the optional parameters for the SubnetsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SubnetCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSubnetsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<subnet-name>",
		armnetwork.Subnet{
			Properties: &armnetwork.SubnetPropertiesFormat{
				AddressPrefix: to.StringPtr("<address-prefix>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SubnetsClientCreateOrUpdateResult)
}

Output:

func (*SubnetsClient) BeginDelete 

func (client *SubnetsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, options *SubnetsClientBeginDeleteOptions) (SubnetsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified subnet. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. subnetName - The name of the subnet. options - SubnetsClientBeginDeleteOptions contains the optional parameters for the SubnetsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SubnetDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSubnetsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<subnet-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SubnetsClient) BeginPrepareNetworkPolicies 

func (client *SubnetsClient) BeginPrepareNetworkPolicies(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, prepareNetworkPoliciesRequestParameters PrepareNetworkPoliciesRequest, options *SubnetsClientBeginPrepareNetworkPoliciesOptions) (SubnetsClientPrepareNetworkPoliciesPollerResponse, error)

BeginPrepareNetworkPolicies - Prepares a subnet by applying network intent policies. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. subnetName - The name of the subnet. prepareNetworkPoliciesRequestParameters - Parameters supplied to prepare subnet by applying network intent policies. options - SubnetsClientBeginPrepareNetworkPoliciesOptions contains the optional parameters for the SubnetsClient.BeginPrepareNetworkPolicies method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SubnetPrepareNetworkPolicies.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSubnetsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginPrepareNetworkPolicies(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<subnet-name>",
		armnetwork.PrepareNetworkPoliciesRequest{
			ServiceName: to.StringPtr("<service-name>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SubnetsClient) BeginUnprepareNetworkPolicies 

func (client *SubnetsClient) BeginUnprepareNetworkPolicies(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, unprepareNetworkPoliciesRequestParameters UnprepareNetworkPoliciesRequest, options *SubnetsClientBeginUnprepareNetworkPoliciesOptions) (SubnetsClientUnprepareNetworkPoliciesPollerResponse, error)

BeginUnprepareNetworkPolicies - Unprepares a subnet by removing network intent policies. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. subnetName - The name of the subnet. unprepareNetworkPoliciesRequestParameters - Parameters supplied to unprepare subnet to remove network intent policies. options - SubnetsClientBeginUnprepareNetworkPoliciesOptions contains the optional parameters for the SubnetsClient.BeginUnprepareNetworkPolicies method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SubnetUnprepareNetworkPolicies.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSubnetsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUnprepareNetworkPolicies(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<subnet-name>",
		armnetwork.UnprepareNetworkPoliciesRequest{
			ServiceName: to.StringPtr("<service-name>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SubnetsClient) Get 

func (client *SubnetsClient) Get(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, options *SubnetsClientGetOptions) (SubnetsClientGetResponse, error)

Get - Gets the specified subnet by virtual network and resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. subnetName - The name of the subnet. options - SubnetsClientGetOptions contains the optional parameters for the SubnetsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SubnetGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSubnetsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<subnet-name>",
		&armnetwork.SubnetsClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SubnetsClientGetResult)
}

Output:

func (*SubnetsClient) List 

func (client *SubnetsClient) List(resourceGroupName string, virtualNetworkName string, options *SubnetsClientListOptions) *SubnetsClientListPager

List - Gets all subnets in a virtual network. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. options - SubnetsClientListOptions contains the optional parameters for the SubnetsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/SubnetList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewSubnetsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<virtual-network-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type SubnetsClientBeginCreateOrUpdateOptions added in v0.3.0 

type SubnetsClientBeginCreateOrUpdateOptions struct {
}

SubnetsClientBeginCreateOrUpdateOptions contains the optional parameters for the SubnetsClient.BeginCreateOrUpdate method.

type SubnetsClientBeginDeleteOptions added in v0.3.0 

type SubnetsClientBeginDeleteOptions struct {
}

SubnetsClientBeginDeleteOptions contains the optional parameters for the SubnetsClient.BeginDelete method.

type SubnetsClientBeginPrepareNetworkPoliciesOptions added in v0.3.0 

type SubnetsClientBeginPrepareNetworkPoliciesOptions struct {
}

SubnetsClientBeginPrepareNetworkPoliciesOptions contains the optional parameters for the SubnetsClient.BeginPrepareNetworkPolicies method.

type SubnetsClientBeginUnprepareNetworkPoliciesOptions added in v0.3.0 

type SubnetsClientBeginUnprepareNetworkPoliciesOptions struct {
}

SubnetsClientBeginUnprepareNetworkPoliciesOptions contains the optional parameters for the SubnetsClient.BeginUnprepareNetworkPolicies method.

type SubnetsClientCreateOrUpdatePoller added in v0.3.0 

type SubnetsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

SubnetsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*SubnetsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *SubnetsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SubnetsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *SubnetsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (SubnetsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SubnetsClientCreateOrUpdateResponse will be returned.

func (*SubnetsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *SubnetsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SubnetsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *SubnetsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SubnetsClientCreateOrUpdatePollerResponse added in v0.3.0 

type SubnetsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SubnetsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubnetsClientCreateOrUpdatePollerResponse contains the response from method SubnetsClient.CreateOrUpdate.

func (SubnetsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l SubnetsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SubnetsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SubnetsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *SubnetsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *SubnetsClient, token string) error

Resume rehydrates a SubnetsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type SubnetsClientCreateOrUpdateResponse added in v0.3.0 

type SubnetsClientCreateOrUpdateResponse struct {
	SubnetsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubnetsClientCreateOrUpdateResponse contains the response from method SubnetsClient.CreateOrUpdate.

type SubnetsClientCreateOrUpdateResult added in v0.3.0 

type SubnetsClientCreateOrUpdateResult struct {
	Subnet
}

SubnetsClientCreateOrUpdateResult contains the result from method SubnetsClient.CreateOrUpdate.

type SubnetsClientDeletePoller added in v0.3.0 

type SubnetsClientDeletePoller struct {
	// contains filtered or unexported fields
}

SubnetsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*SubnetsClientDeletePoller) Done added in v0.3.0 

func (p *SubnetsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SubnetsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *SubnetsClientDeletePoller) FinalResponse(ctx context.Context) (SubnetsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SubnetsClientDeleteResponse will be returned.

func (*SubnetsClientDeletePoller) Poll added in v0.3.0 

func (p *SubnetsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SubnetsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *SubnetsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SubnetsClientDeletePollerResponse added in v0.3.0 

type SubnetsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SubnetsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubnetsClientDeletePollerResponse contains the response from method SubnetsClient.Delete.

func (SubnetsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l SubnetsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SubnetsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SubnetsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *SubnetsClientDeletePollerResponse) Resume(ctx context.Context, client *SubnetsClient, token string) error

Resume rehydrates a SubnetsClientDeletePollerResponse from the provided client and resume token.

type SubnetsClientDeleteResponse added in v0.3.0 

type SubnetsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubnetsClientDeleteResponse contains the response from method SubnetsClient.Delete.

type SubnetsClientGetOptions added in v0.3.0 

type SubnetsClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

SubnetsClientGetOptions contains the optional parameters for the SubnetsClient.Get method.

type SubnetsClientGetResponse added in v0.3.0 

type SubnetsClientGetResponse struct {
	SubnetsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubnetsClientGetResponse contains the response from method SubnetsClient.Get.

type SubnetsClientGetResult added in v0.3.0 

type SubnetsClientGetResult struct {
	Subnet
}

SubnetsClientGetResult contains the result from method SubnetsClient.Get.

type SubnetsClientListOptions added in v0.3.0 

type SubnetsClientListOptions struct {
}

SubnetsClientListOptions contains the optional parameters for the SubnetsClient.List method.

type SubnetsClientListPager added in v0.3.0 

type SubnetsClientListPager struct {
	// contains filtered or unexported fields
}

SubnetsClientListPager provides operations for iterating over paged responses.

func (*SubnetsClientListPager) Err added in v0.3.0 

func (p *SubnetsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*SubnetsClientListPager) NextPage added in v0.3.0 

func (p *SubnetsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*SubnetsClientListPager) PageResponse added in v0.3.0 

func (p *SubnetsClientListPager) PageResponse() SubnetsClientListResponse

PageResponse returns the current SubnetsClientListResponse page.

type SubnetsClientListResponse added in v0.3.0 

type SubnetsClientListResponse struct {
	SubnetsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubnetsClientListResponse contains the response from method SubnetsClient.List.

type SubnetsClientListResult added in v0.3.0 

type SubnetsClientListResult struct {
	SubnetListResult
}

SubnetsClientListResult contains the result from method SubnetsClient.List.

type SubnetsClientPrepareNetworkPoliciesPoller added in v0.3.0 

type SubnetsClientPrepareNetworkPoliciesPoller struct {
	// contains filtered or unexported fields
}

SubnetsClientPrepareNetworkPoliciesPoller provides polling facilities until the operation reaches a terminal state.

func (*SubnetsClientPrepareNetworkPoliciesPoller) Done added in v0.3.0 

func (p *SubnetsClientPrepareNetworkPoliciesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SubnetsClientPrepareNetworkPoliciesPoller) FinalResponse added in v0.3.0 

func (p *SubnetsClientPrepareNetworkPoliciesPoller) FinalResponse(ctx context.Context) (SubnetsClientPrepareNetworkPoliciesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SubnetsClientPrepareNetworkPoliciesResponse will be returned.

func (*SubnetsClientPrepareNetworkPoliciesPoller) Poll added in v0.3.0 

func (p *SubnetsClientPrepareNetworkPoliciesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SubnetsClientPrepareNetworkPoliciesPoller) ResumeToken added in v0.3.0 

func (p *SubnetsClientPrepareNetworkPoliciesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SubnetsClientPrepareNetworkPoliciesPollerResponse added in v0.3.0 

type SubnetsClientPrepareNetworkPoliciesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SubnetsClientPrepareNetworkPoliciesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubnetsClientPrepareNetworkPoliciesPollerResponse contains the response from method SubnetsClient.PrepareNetworkPolicies.

func (SubnetsClientPrepareNetworkPoliciesPollerResponse) PollUntilDone added in v0.3.0 

func (l SubnetsClientPrepareNetworkPoliciesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SubnetsClientPrepareNetworkPoliciesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SubnetsClientPrepareNetworkPoliciesPollerResponse) Resume added in v0.3.0 

func (l *SubnetsClientPrepareNetworkPoliciesPollerResponse) Resume(ctx context.Context, client *SubnetsClient, token string) error

Resume rehydrates a SubnetsClientPrepareNetworkPoliciesPollerResponse from the provided client and resume token.

type SubnetsClientPrepareNetworkPoliciesResponse added in v0.3.0 

type SubnetsClientPrepareNetworkPoliciesResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubnetsClientPrepareNetworkPoliciesResponse contains the response from method SubnetsClient.PrepareNetworkPolicies.

type SubnetsClientUnprepareNetworkPoliciesPoller added in v0.3.0 

type SubnetsClientUnprepareNetworkPoliciesPoller struct {
	// contains filtered or unexported fields
}

SubnetsClientUnprepareNetworkPoliciesPoller provides polling facilities until the operation reaches a terminal state.

func (*SubnetsClientUnprepareNetworkPoliciesPoller) Done added in v0.3.0 

func (p *SubnetsClientUnprepareNetworkPoliciesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SubnetsClientUnprepareNetworkPoliciesPoller) FinalResponse added in v0.3.0 

func (p *SubnetsClientUnprepareNetworkPoliciesPoller) FinalResponse(ctx context.Context) (SubnetsClientUnprepareNetworkPoliciesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SubnetsClientUnprepareNetworkPoliciesResponse will be returned.

func (*SubnetsClientUnprepareNetworkPoliciesPoller) Poll added in v0.3.0 

func (p *SubnetsClientUnprepareNetworkPoliciesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SubnetsClientUnprepareNetworkPoliciesPoller) ResumeToken added in v0.3.0 

func (p *SubnetsClientUnprepareNetworkPoliciesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SubnetsClientUnprepareNetworkPoliciesPollerResponse added in v0.3.0 

type SubnetsClientUnprepareNetworkPoliciesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SubnetsClientUnprepareNetworkPoliciesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubnetsClientUnprepareNetworkPoliciesPollerResponse contains the response from method SubnetsClient.UnprepareNetworkPolicies.

func (SubnetsClientUnprepareNetworkPoliciesPollerResponse) PollUntilDone added in v0.3.0 

func (l SubnetsClientUnprepareNetworkPoliciesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SubnetsClientUnprepareNetworkPoliciesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SubnetsClientUnprepareNetworkPoliciesPollerResponse) Resume added in v0.3.0 

func (l *SubnetsClientUnprepareNetworkPoliciesPollerResponse) Resume(ctx context.Context, client *SubnetsClient, token string) error

Resume rehydrates a SubnetsClientUnprepareNetworkPoliciesPollerResponse from the provided client and resume token.

type SubnetsClientUnprepareNetworkPoliciesResponse added in v0.3.0 

type SubnetsClientUnprepareNetworkPoliciesResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SubnetsClientUnprepareNetworkPoliciesResponse contains the response from method SubnetsClient.UnprepareNetworkPolicies.

type SyncRemoteAddressSpace 

type SyncRemoteAddressSpace string
const (
	SyncRemoteAddressSpaceTrue SyncRemoteAddressSpace = "true"
)

func PossibleSyncRemoteAddressSpaceValues 

func PossibleSyncRemoteAddressSpaceValues() []SyncRemoteAddressSpace

PossibleSyncRemoteAddressSpaceValues returns the possible values for the SyncRemoteAddressSpace const type.

func (SyncRemoteAddressSpace) ToPtr 

func (c SyncRemoteAddressSpace) ToPtr() *SyncRemoteAddressSpace

ToPtr returns a *SyncRemoteAddressSpace pointing to the current value.

type TagsObject 

type TagsObject struct {
	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

TagsObject - Tags object for patch operations.

func (TagsObject) MarshalJSON 

func (t TagsObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagsObject.

type Topology 

type Topology struct {
	// A list of topology resources.
	Resources []*TopologyResource `json:"resources,omitempty"`

	// READ-ONLY; The datetime when the topology was initially created for the resource group.
	CreatedDateTime *time.Time `json:"createdDateTime,omitempty" azure:"ro"`

	// READ-ONLY; GUID representing the operation id.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The datetime when the topology was last modified.
	LastModified *time.Time `json:"lastModified,omitempty" azure:"ro"`
}

Topology of the specified resource group.

func (Topology) MarshalJSON 

func (t Topology) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Topology.

func (*Topology) UnmarshalJSON 

func (t *Topology) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Topology.

type TopologyAssociation 

type TopologyAssociation struct {
	// The association type of the child resource to the parent resource.
	AssociationType *AssociationType `json:"associationType,omitempty"`

	// The name of the resource that is associated with the parent resource.
	Name *string `json:"name,omitempty"`

	// The ID of the resource that is associated with the parent resource.
	ResourceID *string `json:"resourceId,omitempty"`
}

TopologyAssociation - Resources that have an association with the parent resource.

type TopologyParameters 

type TopologyParameters struct {
	// The name of the target resource group to perform topology on.
	TargetResourceGroupName *string `json:"targetResourceGroupName,omitempty"`

	// The reference to the Subnet resource.
	TargetSubnet *SubResource `json:"targetSubnet,omitempty"`

	// The reference to the Virtual Network resource.
	TargetVirtualNetwork *SubResource `json:"targetVirtualNetwork,omitempty"`
}

TopologyParameters - Parameters that define the representation of topology.

type TopologyResource 

type TopologyResource struct {
	// Holds the associations the resource has with other resources in the resource group.
	Associations []*TopologyAssociation `json:"associations,omitempty"`

	// ID of the resource.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Name of the resource.
	Name *string `json:"name,omitempty"`
}

TopologyResource - The network resource topology information for the given resource group.

func (TopologyResource) MarshalJSON 

func (t TopologyResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopologyResource.

type TrafficAnalyticsConfigurationProperties 

type TrafficAnalyticsConfigurationProperties struct {
	// Flag to enable/disable traffic analytics.
	Enabled *bool `json:"enabled,omitempty"`

	// The interval in minutes which would decide how frequently TA service should do flow analytics.
	TrafficAnalyticsInterval *int32 `json:"trafficAnalyticsInterval,omitempty"`

	// The resource guid of the attached workspace.
	WorkspaceID *string `json:"workspaceId,omitempty"`

	// The location of the attached workspace.
	WorkspaceRegion *string `json:"workspaceRegion,omitempty"`

	// Resource Id of the attached workspace.
	WorkspaceResourceID *string `json:"workspaceResourceId,omitempty"`
}

TrafficAnalyticsConfigurationProperties - Parameters that define the configuration of traffic analytics.

type TrafficAnalyticsProperties 

type TrafficAnalyticsProperties struct {
	// Parameters that define the configuration of traffic analytics.
	NetworkWatcherFlowAnalyticsConfiguration *TrafficAnalyticsConfigurationProperties `json:"networkWatcherFlowAnalyticsConfiguration,omitempty"`
}

TrafficAnalyticsProperties - Parameters that define the configuration of traffic analytics.

type TrafficSelectorPolicy 

type TrafficSelectorPolicy struct {
	// REQUIRED; A collection of local address spaces in CIDR format.
	LocalAddressRanges []*string `json:"localAddressRanges,omitempty"`

	// REQUIRED; A collection of remote address spaces in CIDR format.
	RemoteAddressRanges []*string `json:"remoteAddressRanges,omitempty"`
}

TrafficSelectorPolicy - An traffic selector policy for a virtual network gateway connection.

func (TrafficSelectorPolicy) MarshalJSON 

func (t TrafficSelectorPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrafficSelectorPolicy.

type TransportProtocol 

type TransportProtocol string

TransportProtocol - The transport protocol for the endpoint. 

const (
	TransportProtocolAll TransportProtocol = "All"
	TransportProtocolTCP TransportProtocol = "Tcp"
	TransportProtocolUDP TransportProtocol = "Udp"
)

func PossibleTransportProtocolValues 

func PossibleTransportProtocolValues() []TransportProtocol

PossibleTransportProtocolValues returns the possible values for the TransportProtocol const type.

func (TransportProtocol) ToPtr 

func (c TransportProtocol) ToPtr() *TransportProtocol

ToPtr returns a *TransportProtocol pointing to the current value.

type TroubleshootingDetails 

type TroubleshootingDetails struct {
	// Details on troubleshooting results.
	Detail *string `json:"detail,omitempty"`

	// The id of the get troubleshoot operation.
	ID *string `json:"id,omitempty"`

	// Reason type of failure.
	ReasonType *string `json:"reasonType,omitempty"`

	// List of recommended actions.
	RecommendedActions []*TroubleshootingRecommendedActions `json:"recommendedActions,omitempty"`

	// A summary of troubleshooting.
	Summary *string `json:"summary,omitempty"`
}

TroubleshootingDetails - Information gained from troubleshooting of specified resource.

func (TroubleshootingDetails) MarshalJSON 

func (t TroubleshootingDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TroubleshootingDetails.

type TroubleshootingParameters 

type TroubleshootingParameters struct {
	// REQUIRED; Properties of the troubleshooting resource.
	Properties *TroubleshootingProperties `json:"properties,omitempty"`

	// REQUIRED; The target resource to troubleshoot.
	TargetResourceID *string `json:"targetResourceId,omitempty"`
}

TroubleshootingParameters - Parameters that define the resource to troubleshoot.

type TroubleshootingProperties 

type TroubleshootingProperties struct {
	// REQUIRED; The ID for the storage account to save the troubleshoot result.
	StorageID *string `json:"storageId,omitempty"`

	// REQUIRED; The path to the blob to save the troubleshoot result in.
	StoragePath *string `json:"storagePath,omitempty"`
}

TroubleshootingProperties - Storage location provided for troubleshoot.

type TroubleshootingRecommendedActions 

type TroubleshootingRecommendedActions struct {
	// ID of the recommended action.
	ActionID *string `json:"actionId,omitempty"`

	// Description of recommended actions.
	ActionText *string `json:"actionText,omitempty"`

	// The uri linking to a documentation for the recommended troubleshooting actions.
	ActionURI *string `json:"actionUri,omitempty"`

	// The information from the URI for the recommended troubleshooting actions.
	ActionURIText *string `json:"actionUriText,omitempty"`
}

TroubleshootingRecommendedActions - Recommended actions based on discovered issues.

type TroubleshootingResult 

type TroubleshootingResult struct {
	// The result code of the troubleshooting.
	Code *string `json:"code,omitempty"`

	// The end time of the troubleshooting.
	EndTime *time.Time `json:"endTime,omitempty"`

	// Information from troubleshooting.
	Results []*TroubleshootingDetails `json:"results,omitempty"`

	// The start time of the troubleshooting.
	StartTime *time.Time `json:"startTime,omitempty"`
}

TroubleshootingResult - Troubleshooting information gained from specified resource.

func (TroubleshootingResult) MarshalJSON 

func (t TroubleshootingResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TroubleshootingResult.

func (*TroubleshootingResult) UnmarshalJSON 

func (t *TroubleshootingResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TroubleshootingResult.

type TunnelConnectionHealth 

type TunnelConnectionHealth struct {
	// READ-ONLY; Virtual Network Gateway connection status.
	ConnectionStatus *VirtualNetworkGatewayConnectionStatus `json:"connectionStatus,omitempty" azure:"ro"`

	// READ-ONLY; The Egress Bytes Transferred in this connection.
	EgressBytesTransferred *int64 `json:"egressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The Ingress Bytes Transferred in this connection.
	IngressBytesTransferred *int64 `json:"ingressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The time at which connection was established in Utc format.
	LastConnectionEstablishedUTCTime *string `json:"lastConnectionEstablishedUtcTime,omitempty" azure:"ro"`

	// READ-ONLY; Tunnel name.
	Tunnel *string `json:"tunnel,omitempty" azure:"ro"`
}

TunnelConnectionHealth - VirtualNetworkGatewayConnection properties.

type TunnelConnectionStatus 

type TunnelConnectionStatus string

TunnelConnectionStatus - The current state of the tunnel. 

const (
	TunnelConnectionStatusConnected    TunnelConnectionStatus = "Connected"
	TunnelConnectionStatusConnecting   TunnelConnectionStatus = "Connecting"
	TunnelConnectionStatusNotConnected TunnelConnectionStatus = "NotConnected"
	TunnelConnectionStatusUnknown      TunnelConnectionStatus = "Unknown"
)

func PossibleTunnelConnectionStatusValues 

func PossibleTunnelConnectionStatusValues() []TunnelConnectionStatus

PossibleTunnelConnectionStatusValues returns the possible values for the TunnelConnectionStatus const type.

func (TunnelConnectionStatus) ToPtr 

func (c TunnelConnectionStatus) ToPtr() *TunnelConnectionStatus

ToPtr returns a *TunnelConnectionStatus pointing to the current value.

type UnprepareNetworkPoliciesRequest 

type UnprepareNetworkPoliciesRequest struct {
	// The name of the service for which subnet is being unprepared for.
	ServiceName *string `json:"serviceName,omitempty"`
}

UnprepareNetworkPoliciesRequest - Details of UnprepareNetworkPolicies for Subnet.

type Usage 

type Usage struct {
	// REQUIRED; The current value of the usage.
	CurrentValue *int64 `json:"currentValue,omitempty"`

	// REQUIRED; The limit of usage.
	Limit *int64 `json:"limit,omitempty"`

	// REQUIRED; The name of the type of usage.
	Name *UsageName `json:"name,omitempty"`

	// REQUIRED; An enum describing the unit of measurement.
	Unit *UsageUnit `json:"unit,omitempty"`

	// READ-ONLY; Resource identifier.
	ID *string `json:"id,omitempty" azure:"ro"`
}

Usage - The network resource usage.

type UsageName 

type UsageName struct {
	// A localized string describing the resource name.
	LocalizedValue *string `json:"localizedValue,omitempty"`

	// A string describing the resource name.
	Value *string `json:"value,omitempty"`
}

UsageName - The usage names.

type UsageUnit 

type UsageUnit string

UsageUnit - An enum describing the unit of measurement. 

const (
	UsageUnitCount UsageUnit = "Count"
)

func PossibleUsageUnitValues 

func PossibleUsageUnitValues() []UsageUnit

PossibleUsageUnitValues returns the possible values for the UsageUnit const type.

func (UsageUnit) ToPtr 

func (c UsageUnit) ToPtr() *UsageUnit

ToPtr returns a *UsageUnit pointing to the current value.

type UsagesClient 

type UsagesClient struct {
	// contains filtered or unexported fields
}

UsagesClient contains the methods for the Usages group. Don't use this type directly, use NewUsagesClient() instead.

func NewUsagesClient 

func NewUsagesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *UsagesClient

NewUsagesClient creates a new instance of UsagesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*UsagesClient) List 

func (client *UsagesClient) List(location string, options *UsagesClientListOptions) *UsagesClientListPager

List - List network usages for a subscription. If the operation fails it returns an *azcore.ResponseError type. location - The location where resource usage is queried. options - UsagesClientListOptions contains the optional parameters for the UsagesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/UsageList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewUsagesClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type UsagesClientListOptions added in v0.3.0 

type UsagesClientListOptions struct {
}

UsagesClientListOptions contains the optional parameters for the UsagesClient.List method.

type UsagesClientListPager added in v0.3.0 

type UsagesClientListPager struct {
	// contains filtered or unexported fields
}

UsagesClientListPager provides operations for iterating over paged responses.

func (*UsagesClientListPager) Err added in v0.3.0 

func (p *UsagesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*UsagesClientListPager) NextPage added in v0.3.0 

func (p *UsagesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*UsagesClientListPager) PageResponse added in v0.3.0 

func (p *UsagesClientListPager) PageResponse() UsagesClientListResponse

PageResponse returns the current UsagesClientListResponse page.

type UsagesClientListResponse added in v0.3.0 

type UsagesClientListResponse struct {
	UsagesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

UsagesClientListResponse contains the response from method UsagesClient.List.

type UsagesClientListResult added in v0.3.0 

type UsagesClientListResult struct {
	UsagesListResult
}

UsagesClientListResult contains the result from method UsagesClient.List.

type UsagesListResult 

type UsagesListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The list network resource usages.
	Value []*Usage `json:"value,omitempty"`
}

UsagesListResult - The list usages operation response.

func (UsagesListResult) MarshalJSON 

func (u UsagesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UsagesListResult.

type VM 

type VM struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VM - Describes a Virtual Machine.

func (VM) MarshalJSON added in v0.3.0 

func (v VM) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VM.

type VPNAuthenticationType 

type VPNAuthenticationType string

VPNAuthenticationType - VPN authentication types enabled for the virtual network gateway. 

const (
	VPNAuthenticationTypeAAD         VPNAuthenticationType = "AAD"
	VPNAuthenticationTypeCertificate VPNAuthenticationType = "Certificate"
	VPNAuthenticationTypeRadius      VPNAuthenticationType = "Radius"
)

func PossibleVPNAuthenticationTypeValues 

func PossibleVPNAuthenticationTypeValues() []VPNAuthenticationType

PossibleVPNAuthenticationTypeValues returns the possible values for the VPNAuthenticationType const type.

func (VPNAuthenticationType) ToPtr 

func (c VPNAuthenticationType) ToPtr() *VPNAuthenticationType

ToPtr returns a *VPNAuthenticationType pointing to the current value.

type VPNClientConfiguration 

type VPNClientConfiguration struct {
	// The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.
	AADAudience *string `json:"aadAudience,omitempty"`

	// The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.
	AADIssuer *string `json:"aadIssuer,omitempty"`

	// The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.
	AADTenant *string `json:"aadTenant,omitempty"`

	// The radius server address property of the VirtualNetworkGateway resource for vpn client connection.
	RadiusServerAddress *string `json:"radiusServerAddress,omitempty"`

	// The radius secret property of the VirtualNetworkGateway resource for vpn client connection.
	RadiusServerSecret *string `json:"radiusServerSecret,omitempty"`

	// The radiusServers property for multiple radius server configuration.
	RadiusServers []*RadiusServer `json:"radiusServers,omitempty"`

	// VPN authentication types for the virtual network gateway..
	VPNAuthenticationTypes []*VPNAuthenticationType `json:"vpnAuthenticationTypes,omitempty"`

	// The reference to the address space resource which represents Address space for P2S VpnClient.
	VPNClientAddressPool *AddressSpace `json:"vpnClientAddressPool,omitempty"`

	// VpnClientIpsecPolicies for virtual network gateway P2S client.
	VPNClientIPSecPolicies []*IPSecPolicy `json:"vpnClientIpsecPolicies,omitempty"`

	// VpnClientProtocols for Virtual network gateway.
	VPNClientProtocols []*VPNClientProtocol `json:"vpnClientProtocols,omitempty"`

	// VpnClientRevokedCertificate for Virtual network gateway.
	VPNClientRevokedCertificates []*VPNClientRevokedCertificate `json:"vpnClientRevokedCertificates,omitempty"`

	// VpnClientRootCertificate for virtual network gateway.
	VPNClientRootCertificates []*VPNClientRootCertificate `json:"vpnClientRootCertificates,omitempty"`
}

VPNClientConfiguration - VpnClientConfiguration for P2S client.

func (VPNClientConfiguration) MarshalJSON 

func (v VPNClientConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNClientConfiguration.

type VPNClientConnectionHealth 

type VPNClientConnectionHealth struct {
	// List of allocated ip addresses to the connected p2s vpn clients.
	AllocatedIPAddresses []*string `json:"allocatedIpAddresses,omitempty"`

	// The total of p2s vpn clients connected at this time to this P2SVpnGateway.
	VPNClientConnectionsCount *int32 `json:"vpnClientConnectionsCount,omitempty"`

	// READ-ONLY; Total of the Egress Bytes Transferred in this connection.
	TotalEgressBytesTransferred *int64 `json:"totalEgressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; Total of the Ingress Bytes Transferred in this P2S Vpn connection.
	TotalIngressBytesTransferred *int64 `json:"totalIngressBytesTransferred,omitempty" azure:"ro"`
}

VPNClientConnectionHealth - VpnClientConnectionHealth properties.

func (VPNClientConnectionHealth) MarshalJSON 

func (v VPNClientConnectionHealth) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNClientConnectionHealth.

type VPNClientConnectionHealthDetail 

type VPNClientConnectionHealthDetail struct {
	// READ-ONLY; The egress bytes per second.
	EgressBytesTransferred *int64 `json:"egressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The egress packets per second.
	EgressPacketsTransferred *int64 `json:"egressPacketsTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The ingress bytes per second.
	IngressBytesTransferred *int64 `json:"ingressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The ingress packets per second.
	IngressPacketsTransferred *int64 `json:"ingressPacketsTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The max band width.
	MaxBandwidth *int64 `json:"maxBandwidth,omitempty" azure:"ro"`

	// READ-ONLY; The max packets transferred per second.
	MaxPacketsPerSecond *int64 `json:"maxPacketsPerSecond,omitempty" azure:"ro"`

	// READ-ONLY; The assigned private Ip of a connected vpn client.
	PrivateIPAddress *string `json:"privateIpAddress,omitempty" azure:"ro"`

	// READ-ONLY; The public Ip of a connected vpn client.
	PublicIPAddress *string `json:"publicIpAddress,omitempty" azure:"ro"`

	// READ-ONLY; The duration time of a connected vpn client.
	VPNConnectionDuration *int64 `json:"vpnConnectionDuration,omitempty" azure:"ro"`

	// READ-ONLY; The vpn client Id.
	VPNConnectionID *string `json:"vpnConnectionId,omitempty" azure:"ro"`

	// READ-ONLY; The start time of a connected vpn client.
	VPNConnectionTime *string `json:"vpnConnectionTime,omitempty" azure:"ro"`

	// READ-ONLY; The user name of a connected vpn client.
	VPNUserName *string `json:"vpnUserName,omitempty" azure:"ro"`
}

VPNClientConnectionHealthDetail - VPN client connection health detail.

type VPNClientConnectionHealthDetailListResult 

type VPNClientConnectionHealthDetailListResult struct {
	// List of vpn client connection health.
	Value []*VPNClientConnectionHealthDetail `json:"value,omitempty"`
}

VPNClientConnectionHealthDetailListResult - List of virtual network gateway vpn client connection health.

func (VPNClientConnectionHealthDetailListResult) MarshalJSON 

func (v VPNClientConnectionHealthDetailListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNClientConnectionHealthDetailListResult.

type VPNClientIPsecParameters 

type VPNClientIPsecParameters struct {
	// REQUIRED; The DH Group used in IKE Phase 1 for initial SA.
	DhGroup *DhGroup `json:"dhGroup,omitempty"`

	// REQUIRED; The IPSec encryption algorithm (IKE phase 1).
	IPSecEncryption *IPSecEncryption `json:"ipsecEncryption,omitempty"`

	// REQUIRED; The IPSec integrity algorithm (IKE phase 1).
	IPSecIntegrity *IPSecIntegrity `json:"ipsecIntegrity,omitempty"`

	// REQUIRED; The IKE encryption algorithm (IKE phase 2).
	IkeEncryption *IkeEncryption `json:"ikeEncryption,omitempty"`

	// REQUIRED; The IKE integrity algorithm (IKE phase 2).
	IkeIntegrity *IkeIntegrity `json:"ikeIntegrity,omitempty"`

	// REQUIRED; The Pfs Group used in IKE Phase 2 for new child SA.
	PfsGroup *PfsGroup `json:"pfsGroup,omitempty"`

	// REQUIRED; The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for P2S client..
	SaDataSizeKilobytes *int32 `json:"saDataSizeKilobytes,omitempty"`

	// REQUIRED; The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for P2S client.
	SaLifeTimeSeconds *int32 `json:"saLifeTimeSeconds,omitempty"`
}

VPNClientIPsecParameters - An IPSec parameters for a virtual network gateway P2S connection.

type VPNClientParameters 

type VPNClientParameters struct {
	// VPN client authentication method.
	AuthenticationMethod *AuthenticationMethod `json:"authenticationMethod,omitempty"`

	// A list of client root certificates public certificate data encoded as Base-64 strings. Optional parameter for external
	// radius based authentication with EAPTLS.
	ClientRootCertificates []*string `json:"clientRootCertificates,omitempty"`

	// VPN client Processor Architecture.
	ProcessorArchitecture *ProcessorArchitecture `json:"processorArchitecture,omitempty"`

	// The public certificate data for the radius server authentication certificate as a Base-64 encoded string. Required only
	// if external radius authentication has been configured with EAPTLS
	// authentication.
	RadiusServerAuthCertificate *string `json:"radiusServerAuthCertificate,omitempty"`
}

VPNClientParameters - Vpn Client Parameters for package generation.

func (VPNClientParameters) MarshalJSON 

func (v VPNClientParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNClientParameters.

type VPNClientProtocol 

type VPNClientProtocol string

VPNClientProtocol - VPN client protocol enabled for the virtual network gateway. 

const (
	VPNClientProtocolIkeV2   VPNClientProtocol = "IkeV2"
	VPNClientProtocolOpenVPN VPNClientProtocol = "OpenVPN"
	VPNClientProtocolSSTP    VPNClientProtocol = "SSTP"
)

func PossibleVPNClientProtocolValues 

func PossibleVPNClientProtocolValues() []VPNClientProtocol

PossibleVPNClientProtocolValues returns the possible values for the VPNClientProtocol const type.

func (VPNClientProtocol) ToPtr 

func (c VPNClientProtocol) ToPtr() *VPNClientProtocol

ToPtr returns a *VPNClientProtocol pointing to the current value.

type VPNClientRevokedCertificate 

type VPNClientRevokedCertificate struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the vpn client revoked certificate.
	Properties *VPNClientRevokedCertificatePropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

VPNClientRevokedCertificate - VPN client revoked certificate of virtual network gateway.

type VPNClientRevokedCertificatePropertiesFormat 

type VPNClientRevokedCertificatePropertiesFormat struct {
	// The revoked VPN client certificate thumbprint.
	Thumbprint *string `json:"thumbprint,omitempty"`

	// READ-ONLY; The provisioning state of the VPN client revoked certificate resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VPNClientRevokedCertificatePropertiesFormat - Properties of the revoked VPN client certificate of virtual network gateway.

type VPNClientRootCertificate 

type VPNClientRootCertificate struct {
	// REQUIRED; Properties of the vpn client root certificate.
	Properties *VPNClientRootCertificatePropertiesFormat `json:"properties,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

VPNClientRootCertificate - VPN client root certificate of virtual network gateway.

type VPNClientRootCertificatePropertiesFormat 

type VPNClientRootCertificatePropertiesFormat struct {
	// REQUIRED; The certificate public data.
	PublicCertData *string `json:"publicCertData,omitempty"`

	// READ-ONLY; The provisioning state of the VPN client root certificate resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VPNClientRootCertificatePropertiesFormat - Properties of SSL certificates of application gateway.

type VPNConnection 

type VPNConnection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the VPN connection.
	Properties *VPNConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

VPNConnection - VpnConnection Resource.

type VPNConnectionPacketCaptureStartParameters 

type VPNConnectionPacketCaptureStartParameters struct {
	// Start Packet capture parameters on vpn connection.
	FilterData *string `json:"filterData,omitempty"`

	// List of site link connection names.
	LinkConnectionNames []*string `json:"linkConnectionNames,omitempty"`
}

VPNConnectionPacketCaptureStartParameters - Vpn Connection packet capture parameters supplied to start packet capture on gateway connection.

func (VPNConnectionPacketCaptureStartParameters) MarshalJSON 

func (v VPNConnectionPacketCaptureStartParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNConnectionPacketCaptureStartParameters.

type VPNConnectionPacketCaptureStopParameters 

type VPNConnectionPacketCaptureStopParameters struct {
	// List of site link connection names.
	LinkConnectionNames []*string `json:"linkConnectionNames,omitempty"`

	// SAS url for packet capture on vpn connection.
	SasURL *string `json:"sasUrl,omitempty"`
}

VPNConnectionPacketCaptureStopParameters - Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection.

func (VPNConnectionPacketCaptureStopParameters) MarshalJSON 

func (v VPNConnectionPacketCaptureStopParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNConnectionPacketCaptureStopParameters.

type VPNConnectionProperties 

type VPNConnectionProperties struct {
	// Expected bandwidth in MBPS.
	ConnectionBandwidth *int32 `json:"connectionBandwidth,omitempty"`

	// DPD timeout in seconds for vpn connection.
	DpdTimeoutSeconds *int32 `json:"dpdTimeoutSeconds,omitempty"`

	// EnableBgp flag.
	EnableBgp *bool `json:"enableBgp,omitempty"`

	// Enable internet security.
	EnableInternetSecurity *bool `json:"enableInternetSecurity,omitempty"`

	// EnableBgp flag.
	EnableRateLimiting *bool `json:"enableRateLimiting,omitempty"`

	// The IPSec Policies to be considered by this connection.
	IPSecPolicies []*IPSecPolicy `json:"ipsecPolicies,omitempty"`

	// Id of the connected vpn site.
	RemoteVPNSite *SubResource `json:"remoteVpnSite,omitempty"`

	// The Routing Configuration indicating the associated and propagated route tables on this connection.
	RoutingConfiguration *RoutingConfiguration `json:"routingConfiguration,omitempty"`

	// Routing weight for vpn connection.
	RoutingWeight *int32 `json:"routingWeight,omitempty"`

	// SharedKey for the vpn connection.
	SharedKey *string `json:"sharedKey,omitempty"`

	// The Traffic Selector Policies to be considered by this connection.
	TrafficSelectorPolicies []*TrafficSelectorPolicy `json:"trafficSelectorPolicies,omitempty"`

	// Use local azure ip to initiate connection.
	UseLocalAzureIPAddress *bool `json:"useLocalAzureIpAddress,omitempty"`

	// Enable policy-based traffic selectors.
	UsePolicyBasedTrafficSelectors *bool `json:"usePolicyBasedTrafficSelectors,omitempty"`

	// Connection protocol used for this connection.
	VPNConnectionProtocolType *VirtualNetworkGatewayConnectionProtocol `json:"vpnConnectionProtocolType,omitempty"`

	// List of all vpn site link connections to the gateway.
	VPNLinkConnections []*VPNSiteLinkConnection `json:"vpnLinkConnections,omitempty"`

	// READ-ONLY; The connection status.
	ConnectionStatus *VPNConnectionStatus `json:"connectionStatus,omitempty" azure:"ro"`

	// READ-ONLY; Egress bytes transferred.
	EgressBytesTransferred *int64 `json:"egressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; Ingress bytes transferred.
	IngressBytesTransferred *int64 `json:"ingressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the VPN connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VPNConnectionProperties - Parameters for VpnConnection.

func (VPNConnectionProperties) MarshalJSON 

func (v VPNConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNConnectionProperties.

type VPNConnectionStatus 

type VPNConnectionStatus string

VPNConnectionStatus - The current state of the vpn connection. 

const (
	VPNConnectionStatusConnected    VPNConnectionStatus = "Connected"
	VPNConnectionStatusConnecting   VPNConnectionStatus = "Connecting"
	VPNConnectionStatusNotConnected VPNConnectionStatus = "NotConnected"
	VPNConnectionStatusUnknown      VPNConnectionStatus = "Unknown"
)

func PossibleVPNConnectionStatusValues 

func PossibleVPNConnectionStatusValues() []VPNConnectionStatus

PossibleVPNConnectionStatusValues returns the possible values for the VPNConnectionStatus const type.

func (VPNConnectionStatus) ToPtr 

func (c VPNConnectionStatus) ToPtr() *VPNConnectionStatus

ToPtr returns a *VPNConnectionStatus pointing to the current value.

type VPNConnectionsClient 

type VPNConnectionsClient struct {
	// contains filtered or unexported fields
}

VPNConnectionsClient contains the methods for the VPNConnections group. Don't use this type directly, use NewVPNConnectionsClient() instead.

func NewVPNConnectionsClient 

func NewVPNConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VPNConnectionsClient

NewVPNConnectionsClient creates a new instance of VPNConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VPNConnectionsClient) BeginCreateOrUpdate 

func (client *VPNConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, gatewayName string, connectionName string, vpnConnectionParameters VPNConnection, options *VPNConnectionsClientBeginCreateOrUpdateOptions) (VPNConnectionsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. connectionName - The name of the connection. vpnConnectionParameters - Parameters supplied to create or Update a VPN Connection. options - VPNConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNConnectionsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnConnectionPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<connection-name>",
		armnetwork.VPNConnection{
			Properties: &armnetwork.VPNConnectionProperties{
				RemoteVPNSite: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
				TrafficSelectorPolicies: []*armnetwork.TrafficSelectorPolicy{},
				VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.VPNSiteLinkConnectionProperties{
							ConnectionBandwidth:            to.Int32Ptr(200),
							SharedKey:                      to.StringPtr("<shared-key>"),
							UsePolicyBasedTrafficSelectors: to.BoolPtr(false),
							VPNConnectionProtocolType:      armnetwork.VirtualNetworkGatewayConnectionProtocol("IKEv2").ToPtr(),
							VPNLinkConnectionMode:          armnetwork.VPNLinkConnectionMode("Default").ToPtr(),
							VPNSiteLink: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNConnectionsClientCreateOrUpdateResult)
}

Output:

func (*VPNConnectionsClient) BeginDelete 

func (client *VPNConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, gatewayName string, connectionName string, options *VPNConnectionsClientBeginDeleteOptions) (VPNConnectionsClientDeletePollerResponse, error)

BeginDelete - Deletes a vpn connection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. connectionName - The name of the connection. options - VPNConnectionsClientBeginDeleteOptions contains the optional parameters for the VPNConnectionsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnConnectionDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VPNConnectionsClient) BeginStartPacketCapture 

func (client *VPNConnectionsClient) BeginStartPacketCapture(ctx context.Context, resourceGroupName string, gatewayName string, vpnConnectionName string, options *VPNConnectionsClientBeginStartPacketCaptureOptions) (VPNConnectionsClientStartPacketCapturePollerResponse, error)

BeginStartPacketCapture - Starts packet capture on Vpn connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. gatewayName - The name of the gateway. vpnConnectionName - The name of the vpn connection. options - VPNConnectionsClientBeginStartPacketCaptureOptions contains the optional parameters for the VPNConnectionsClient.BeginStartPacketCapture method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnConnectionStartPacketCaptureFilterData.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStartPacketCapture(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<vpn-connection-name>",
		&armnetwork.VPNConnectionsClientBeginStartPacketCaptureOptions{Parameters: &armnetwork.VPNConnectionPacketCaptureStartParameters{
			FilterData: to.StringPtr("<filter-data>"),
			LinkConnectionNames: []*string{
				to.StringPtr("siteLink1"),
				to.StringPtr("siteLink2")},
		},
		})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNConnectionsClientStartPacketCaptureResult)
}

Output:

func (*VPNConnectionsClient) BeginStopPacketCapture 

func (client *VPNConnectionsClient) BeginStopPacketCapture(ctx context.Context, resourceGroupName string, gatewayName string, vpnConnectionName string, options *VPNConnectionsClientBeginStopPacketCaptureOptions) (VPNConnectionsClientStopPacketCapturePollerResponse, error)

BeginStopPacketCapture - Stops packet capture on Vpn connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. gatewayName - The name of the gateway. vpnConnectionName - The name of the vpn connection. options - VPNConnectionsClientBeginStopPacketCaptureOptions contains the optional parameters for the VPNConnectionsClient.BeginStopPacketCapture method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnConnectionStopPacketCapture.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStopPacketCapture(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<vpn-connection-name>",
		&armnetwork.VPNConnectionsClientBeginStopPacketCaptureOptions{Parameters: &armnetwork.VPNConnectionPacketCaptureStopParameters{
			LinkConnectionNames: []*string{
				to.StringPtr("vpnSiteLink1"),
				to.StringPtr("vpnSiteLink2")},
			SasURL: to.StringPtr("<sas-url>"),
		},
		})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNConnectionsClientStopPacketCaptureResult)
}

Output:

func (*VPNConnectionsClient) Get 

func (client *VPNConnectionsClient) Get(ctx context.Context, resourceGroupName string, gatewayName string, connectionName string, options *VPNConnectionsClientGetOptions) (VPNConnectionsClientGetResponse, error)

Get - Retrieves the details of a vpn connection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. connectionName - The name of the vpn connection. options - VPNConnectionsClientGetOptions contains the optional parameters for the VPNConnectionsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnConnectionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNConnectionsClientGetResult)
}

Output:

func (*VPNConnectionsClient) ListByVPNGateway 

func (client *VPNConnectionsClient) ListByVPNGateway(resourceGroupName string, gatewayName string, options *VPNConnectionsClientListByVPNGatewayOptions) *VPNConnectionsClientListByVPNGatewayPager

ListByVPNGateway - Retrieves all vpn connections for a particular virtual wan vpn gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. options - VPNConnectionsClientListByVPNGatewayOptions contains the optional parameters for the VPNConnectionsClient.ListByVPNGateway method.

type VPNConnectionsClientBeginCreateOrUpdateOptions added in v0.3.0 

type VPNConnectionsClientBeginCreateOrUpdateOptions struct {
}

VPNConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNConnectionsClient.BeginCreateOrUpdate method.

type VPNConnectionsClientBeginDeleteOptions added in v0.3.0 

type VPNConnectionsClientBeginDeleteOptions struct {
}

VPNConnectionsClientBeginDeleteOptions contains the optional parameters for the VPNConnectionsClient.BeginDelete method.

type VPNConnectionsClientBeginStartPacketCaptureOptions added in v0.3.0 

type VPNConnectionsClientBeginStartPacketCaptureOptions struct {
	// Vpn Connection packet capture parameters supplied to start packet capture on gateway connection.
	Parameters *VPNConnectionPacketCaptureStartParameters
}

VPNConnectionsClientBeginStartPacketCaptureOptions contains the optional parameters for the VPNConnectionsClient.BeginStartPacketCapture method.

type VPNConnectionsClientBeginStopPacketCaptureOptions added in v0.3.0 

type VPNConnectionsClientBeginStopPacketCaptureOptions struct {
	// Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection.
	Parameters *VPNConnectionPacketCaptureStopParameters
}

VPNConnectionsClientBeginStopPacketCaptureOptions contains the optional parameters for the VPNConnectionsClient.BeginStopPacketCapture method.

type VPNConnectionsClientCreateOrUpdatePoller added in v0.3.0 

type VPNConnectionsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VPNConnectionsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNConnectionsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VPNConnectionsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNConnectionsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VPNConnectionsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VPNConnectionsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNConnectionsClientCreateOrUpdateResponse will be returned.

func (*VPNConnectionsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VPNConnectionsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNConnectionsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VPNConnectionsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNConnectionsClientCreateOrUpdatePollerResponse added in v0.3.0 

type VPNConnectionsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNConnectionsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNConnectionsClientCreateOrUpdatePollerResponse contains the response from method VPNConnectionsClient.CreateOrUpdate.

func (VPNConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNConnectionsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNConnectionsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VPNConnectionsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VPNConnectionsClient, token string) error

Resume rehydrates a VPNConnectionsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VPNConnectionsClientCreateOrUpdateResponse added in v0.3.0 

type VPNConnectionsClientCreateOrUpdateResponse struct {
	VPNConnectionsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNConnectionsClientCreateOrUpdateResponse contains the response from method VPNConnectionsClient.CreateOrUpdate.

type VPNConnectionsClientCreateOrUpdateResult added in v0.3.0 

type VPNConnectionsClientCreateOrUpdateResult struct {
	VPNConnection
}

VPNConnectionsClientCreateOrUpdateResult contains the result from method VPNConnectionsClient.CreateOrUpdate.

type VPNConnectionsClientDeletePoller added in v0.3.0 

type VPNConnectionsClientDeletePoller struct {
	// contains filtered or unexported fields
}

VPNConnectionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNConnectionsClientDeletePoller) Done added in v0.3.0 

func (p *VPNConnectionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNConnectionsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VPNConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (VPNConnectionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNConnectionsClientDeleteResponse will be returned.

func (*VPNConnectionsClientDeletePoller) Poll added in v0.3.0 

func (p *VPNConnectionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNConnectionsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VPNConnectionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNConnectionsClientDeletePollerResponse added in v0.3.0 

type VPNConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNConnectionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNConnectionsClientDeletePollerResponse contains the response from method VPNConnectionsClient.Delete.

func (VPNConnectionsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNConnectionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNConnectionsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VPNConnectionsClientDeletePollerResponse) Resume(ctx context.Context, client *VPNConnectionsClient, token string) error

Resume rehydrates a VPNConnectionsClientDeletePollerResponse from the provided client and resume token.

type VPNConnectionsClientDeleteResponse added in v0.3.0 

type VPNConnectionsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNConnectionsClientDeleteResponse contains the response from method VPNConnectionsClient.Delete.

type VPNConnectionsClientGetOptions added in v0.3.0 

type VPNConnectionsClientGetOptions struct {
}

VPNConnectionsClientGetOptions contains the optional parameters for the VPNConnectionsClient.Get method.

type VPNConnectionsClientGetResponse added in v0.3.0 

type VPNConnectionsClientGetResponse struct {
	VPNConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNConnectionsClientGetResponse contains the response from method VPNConnectionsClient.Get.

type VPNConnectionsClientGetResult added in v0.3.0 

type VPNConnectionsClientGetResult struct {
	VPNConnection
}

VPNConnectionsClientGetResult contains the result from method VPNConnectionsClient.Get.

type VPNConnectionsClientListByVPNGatewayOptions added in v0.3.0 

type VPNConnectionsClientListByVPNGatewayOptions struct {
}

VPNConnectionsClientListByVPNGatewayOptions contains the optional parameters for the VPNConnectionsClient.ListByVPNGateway method.

type VPNConnectionsClientListByVPNGatewayPager added in v0.3.0 

type VPNConnectionsClientListByVPNGatewayPager struct {
	// contains filtered or unexported fields
}

VPNConnectionsClientListByVPNGatewayPager provides operations for iterating over paged responses.

func (*VPNConnectionsClientListByVPNGatewayPager) Err added in v0.3.0 

func (p *VPNConnectionsClientListByVPNGatewayPager) Err() error

Err returns the last error encountered while paging.

func (*VPNConnectionsClientListByVPNGatewayPager) NextPage added in v0.3.0 

func (p *VPNConnectionsClientListByVPNGatewayPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VPNConnectionsClientListByVPNGatewayPager) PageResponse added in v0.3.0 

func (p *VPNConnectionsClientListByVPNGatewayPager) PageResponse() VPNConnectionsClientListByVPNGatewayResponse

PageResponse returns the current VPNConnectionsClientListByVPNGatewayResponse page.

type VPNConnectionsClientListByVPNGatewayResponse added in v0.3.0 

type VPNConnectionsClientListByVPNGatewayResponse struct {
	VPNConnectionsClientListByVPNGatewayResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNConnectionsClientListByVPNGatewayResponse contains the response from method VPNConnectionsClient.ListByVPNGateway.

type VPNConnectionsClientListByVPNGatewayResult added in v0.3.0 

type VPNConnectionsClientListByVPNGatewayResult struct {
	ListVPNConnectionsResult
}

VPNConnectionsClientListByVPNGatewayResult contains the result from method VPNConnectionsClient.ListByVPNGateway.

type VPNConnectionsClientStartPacketCapturePoller added in v0.3.0 

type VPNConnectionsClientStartPacketCapturePoller struct {
	// contains filtered or unexported fields
}

VPNConnectionsClientStartPacketCapturePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNConnectionsClientStartPacketCapturePoller) Done added in v0.3.0 

func (p *VPNConnectionsClientStartPacketCapturePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNConnectionsClientStartPacketCapturePoller) FinalResponse added in v0.3.0 

func (p *VPNConnectionsClientStartPacketCapturePoller) FinalResponse(ctx context.Context) (VPNConnectionsClientStartPacketCaptureResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNConnectionsClientStartPacketCaptureResponse will be returned.

func (*VPNConnectionsClientStartPacketCapturePoller) Poll added in v0.3.0 

func (p *VPNConnectionsClientStartPacketCapturePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNConnectionsClientStartPacketCapturePoller) ResumeToken added in v0.3.0 

func (p *VPNConnectionsClientStartPacketCapturePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNConnectionsClientStartPacketCapturePollerResponse added in v0.3.0 

type VPNConnectionsClientStartPacketCapturePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNConnectionsClientStartPacketCapturePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNConnectionsClientStartPacketCapturePollerResponse contains the response from method VPNConnectionsClient.StartPacketCapture.

func (VPNConnectionsClientStartPacketCapturePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNConnectionsClientStartPacketCapturePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNConnectionsClientStartPacketCaptureResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNConnectionsClientStartPacketCapturePollerResponse) Resume added in v0.3.0 

func (l *VPNConnectionsClientStartPacketCapturePollerResponse) Resume(ctx context.Context, client *VPNConnectionsClient, token string) error

Resume rehydrates a VPNConnectionsClientStartPacketCapturePollerResponse from the provided client and resume token.

type VPNConnectionsClientStartPacketCaptureResponse added in v0.3.0 

type VPNConnectionsClientStartPacketCaptureResponse struct {
	VPNConnectionsClientStartPacketCaptureResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNConnectionsClientStartPacketCaptureResponse contains the response from method VPNConnectionsClient.StartPacketCapture.

type VPNConnectionsClientStartPacketCaptureResult added in v0.3.0 

type VPNConnectionsClientStartPacketCaptureResult struct {
	Value *string
}

VPNConnectionsClientStartPacketCaptureResult contains the result from method VPNConnectionsClient.StartPacketCapture.

type VPNConnectionsClientStopPacketCapturePoller added in v0.3.0 

type VPNConnectionsClientStopPacketCapturePoller struct {
	// contains filtered or unexported fields
}

VPNConnectionsClientStopPacketCapturePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNConnectionsClientStopPacketCapturePoller) Done added in v0.3.0 

func (p *VPNConnectionsClientStopPacketCapturePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNConnectionsClientStopPacketCapturePoller) FinalResponse added in v0.3.0 

func (p *VPNConnectionsClientStopPacketCapturePoller) FinalResponse(ctx context.Context) (VPNConnectionsClientStopPacketCaptureResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNConnectionsClientStopPacketCaptureResponse will be returned.

func (*VPNConnectionsClientStopPacketCapturePoller) Poll added in v0.3.0 

func (p *VPNConnectionsClientStopPacketCapturePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNConnectionsClientStopPacketCapturePoller) ResumeToken added in v0.3.0 

func (p *VPNConnectionsClientStopPacketCapturePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNConnectionsClientStopPacketCapturePollerResponse added in v0.3.0 

type VPNConnectionsClientStopPacketCapturePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNConnectionsClientStopPacketCapturePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNConnectionsClientStopPacketCapturePollerResponse contains the response from method VPNConnectionsClient.StopPacketCapture.

func (VPNConnectionsClientStopPacketCapturePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNConnectionsClientStopPacketCapturePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNConnectionsClientStopPacketCaptureResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNConnectionsClientStopPacketCapturePollerResponse) Resume added in v0.3.0 

func (l *VPNConnectionsClientStopPacketCapturePollerResponse) Resume(ctx context.Context, client *VPNConnectionsClient, token string) error

Resume rehydrates a VPNConnectionsClientStopPacketCapturePollerResponse from the provided client and resume token.

type VPNConnectionsClientStopPacketCaptureResponse added in v0.3.0 

type VPNConnectionsClientStopPacketCaptureResponse struct {
	VPNConnectionsClientStopPacketCaptureResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNConnectionsClientStopPacketCaptureResponse contains the response from method VPNConnectionsClient.StopPacketCapture.

type VPNConnectionsClientStopPacketCaptureResult added in v0.3.0 

type VPNConnectionsClientStopPacketCaptureResult struct {
	Value *string
}

VPNConnectionsClientStopPacketCaptureResult contains the result from method VPNConnectionsClient.StopPacketCapture.

type VPNDeviceScriptParameters 

type VPNDeviceScriptParameters struct {
	// The device family for the vpn device.
	DeviceFamily *string `json:"deviceFamily,omitempty"`

	// The firmware version for the vpn device.
	FirmwareVersion *string `json:"firmwareVersion,omitempty"`

	// The vendor for the vpn device.
	Vendor *string `json:"vendor,omitempty"`
}

VPNDeviceScriptParameters - Vpn device configuration script generation parameters.

type VPNGateway 

type VPNGateway struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the VPN gateway.
	Properties *VPNGatewayProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VPNGateway - VpnGateway Resource.

func (VPNGateway) MarshalJSON 

func (v VPNGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNGateway.

type VPNGatewayGeneration 

type VPNGatewayGeneration string

VPNGatewayGeneration - The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. 

const (
	VPNGatewayGenerationGeneration1 VPNGatewayGeneration = "Generation1"
	VPNGatewayGenerationGeneration2 VPNGatewayGeneration = "Generation2"
	VPNGatewayGenerationNone        VPNGatewayGeneration = "None"
)

func PossibleVPNGatewayGenerationValues 

func PossibleVPNGatewayGenerationValues() []VPNGatewayGeneration

PossibleVPNGatewayGenerationValues returns the possible values for the VPNGatewayGeneration const type.

func (VPNGatewayGeneration) ToPtr 

func (c VPNGatewayGeneration) ToPtr() *VPNGatewayGeneration

ToPtr returns a *VPNGatewayGeneration pointing to the current value.

type VPNGatewayIPConfiguration 

type VPNGatewayIPConfiguration struct {
	// The identifier of the IP configuration for a VPN Gateway.
	ID *string `json:"id,omitempty"`

	// The private IP address of this IP configuration.
	PrivateIPAddress *string `json:"privateIpAddress,omitempty"`

	// The public IP address of this IP configuration.
	PublicIPAddress *string `json:"publicIpAddress,omitempty"`
}

VPNGatewayIPConfiguration - IP Configuration of a VPN Gateway Resource.

type VPNGatewayNatRule 

type VPNGatewayNatRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the VpnGateway NAT rule.
	Properties *VPNGatewayNatRuleProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VPNGatewayNatRule - VpnGatewayNatRule Resource.

type VPNGatewayNatRuleProperties 

type VPNGatewayNatRuleProperties struct {
	// The private IP address external mapping for NAT.
	ExternalMappings []*VPNNatRuleMapping `json:"externalMappings,omitempty"`

	// The IP Configuration ID this NAT rule applies to.
	IPConfigurationID *string `json:"ipConfigurationId,omitempty"`

	// The private IP address internal mapping for NAT.
	InternalMappings []*VPNNatRuleMapping `json:"internalMappings,omitempty"`

	// The Source NAT direction of a VPN NAT.
	Mode *VPNNatRuleMode `json:"mode,omitempty"`

	// The type of NAT rule for VPN NAT.
	Type *VPNNatRuleType `json:"type,omitempty"`

	// READ-ONLY; List of egress VpnSiteLinkConnections.
	EgressVPNSiteLinkConnections []*SubResource `json:"egressVpnSiteLinkConnections,omitempty" azure:"ro"`

	// READ-ONLY; List of ingress VpnSiteLinkConnections.
	IngressVPNSiteLinkConnections []*SubResource `json:"ingressVpnSiteLinkConnections,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the NAT Rule resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VPNGatewayNatRuleProperties - Parameters for VpnGatewayNatRule.

func (VPNGatewayNatRuleProperties) MarshalJSON 

func (v VPNGatewayNatRuleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNGatewayNatRuleProperties.

type VPNGatewayPacketCaptureStartParameters 

type VPNGatewayPacketCaptureStartParameters struct {
	// Start Packet capture parameters on vpn gateway.
	FilterData *string `json:"filterData,omitempty"`
}

VPNGatewayPacketCaptureStartParameters - Start packet capture parameters.

type VPNGatewayPacketCaptureStopParameters 

type VPNGatewayPacketCaptureStopParameters struct {
	// SAS url for packet capture on vpn gateway.
	SasURL *string `json:"sasUrl,omitempty"`
}

VPNGatewayPacketCaptureStopParameters - Stop packet capture parameters.

type VPNGatewayProperties 

type VPNGatewayProperties struct {
	// Local network gateway's BGP speaker settings.
	BgpSettings *BgpSettings `json:"bgpSettings,omitempty"`

	// List of all vpn connections to the gateway.
	Connections []*VPNConnection `json:"connections,omitempty"`

	// Enable BGP routes translation for NAT on this VpnGateway.
	EnableBgpRouteTranslationForNat *bool `json:"enableBgpRouteTranslationForNat,omitempty"`

	// Enable Routing Preference property for the Public IP Interface of the VpnGateway.
	IsRoutingPreferenceInternet *bool `json:"isRoutingPreferenceInternet,omitempty"`

	// List of all the nat Rules associated with the gateway.
	NatRules []*VPNGatewayNatRule `json:"natRules,omitempty"`

	// The scale unit for this vpn gateway.
	VPNGatewayScaleUnit *int32 `json:"vpnGatewayScaleUnit,omitempty"`

	// The VirtualHub to which the gateway belongs.
	VirtualHub *SubResource `json:"virtualHub,omitempty"`

	// READ-ONLY; List of all IPs configured on the gateway.
	IPConfigurations []*VPNGatewayIPConfiguration `json:"ipConfigurations,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the VPN gateway resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VPNGatewayProperties - Parameters for VpnGateway.

func (VPNGatewayProperties) MarshalJSON 

func (v VPNGatewayProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNGatewayProperties.

type VPNGatewayTunnelingProtocol 

type VPNGatewayTunnelingProtocol string

VPNGatewayTunnelingProtocol - VPN protocol enabled for the VpnServerConfiguration. 

const (
	VPNGatewayTunnelingProtocolIkeV2   VPNGatewayTunnelingProtocol = "IkeV2"
	VPNGatewayTunnelingProtocolOpenVPN VPNGatewayTunnelingProtocol = "OpenVPN"
)

func PossibleVPNGatewayTunnelingProtocolValues 

func PossibleVPNGatewayTunnelingProtocolValues() []VPNGatewayTunnelingProtocol

PossibleVPNGatewayTunnelingProtocolValues returns the possible values for the VPNGatewayTunnelingProtocol const type.

func (VPNGatewayTunnelingProtocol) ToPtr 

func (c VPNGatewayTunnelingProtocol) ToPtr() *VPNGatewayTunnelingProtocol

ToPtr returns a *VPNGatewayTunnelingProtocol pointing to the current value.

type VPNGatewaysClient 

type VPNGatewaysClient struct {
	// contains filtered or unexported fields
}

VPNGatewaysClient contains the methods for the VPNGateways group. Don't use this type directly, use NewVPNGatewaysClient() instead.

func NewVPNGatewaysClient 

func NewVPNGatewaysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VPNGatewaysClient

NewVPNGatewaysClient creates a new instance of VPNGatewaysClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VPNGatewaysClient) BeginCreateOrUpdate 

func (client *VPNGatewaysClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, gatewayName string, vpnGatewayParameters VPNGateway, options *VPNGatewaysClientBeginCreateOrUpdateOptions) (VPNGatewaysClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. vpnGatewayParameters - Parameters supplied to create or Update a virtual wan vpn gateway. options - VPNGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNGatewaysClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnGatewayPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		armnetwork.VPNGateway{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.VPNGatewayProperties{
				BgpSettings: &armnetwork.BgpSettings{
					Asn: to.Int64Ptr(65515),
					BgpPeeringAddresses: []*armnetwork.IPConfigurationBgpPeeringAddress{
						{
							CustomBgpIPAddresses: []*string{
								to.StringPtr("169.254.21.5")},
							IPConfigurationID: to.StringPtr("<ipconfiguration-id>"),
						},
						{
							CustomBgpIPAddresses: []*string{
								to.StringPtr("169.254.21.10")},
							IPConfigurationID: to.StringPtr("<ipconfiguration-id>"),
						}},
					PeerWeight: to.Int32Ptr(0),
				},
				Connections: []*armnetwork.VPNConnection{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.VPNConnectionProperties{
							RemoteVPNSite: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
								{
									Name: to.StringPtr("<name>"),
									Properties: &armnetwork.VPNSiteLinkConnectionProperties{
										ConnectionBandwidth: to.Int32Ptr(200),
										EgressNatRules: []*armnetwork.SubResource{
											{
												ID: to.StringPtr("<id>"),
											}},
										SharedKey:                 to.StringPtr("<shared-key>"),
										VPNConnectionProtocolType: armnetwork.VirtualNetworkGatewayConnectionProtocol("IKEv2").ToPtr(),
										VPNSiteLink: &armnetwork.SubResource{
											ID: to.StringPtr("<id>"),
										},
									},
								}},
						},
					}},
				EnableBgpRouteTranslationForNat: to.BoolPtr(false),
				IsRoutingPreferenceInternet:     to.BoolPtr(false),
				NatRules: []*armnetwork.VPNGatewayNatRule{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.VPNGatewayNatRuleProperties{
							Type: armnetwork.VPNNatRuleType("Static").ToPtr(),
							ExternalMappings: []*armnetwork.VPNNatRuleMapping{
								{
									AddressSpace: to.StringPtr("<address-space>"),
								}},
							InternalMappings: []*armnetwork.VPNNatRuleMapping{
								{
									AddressSpace: to.StringPtr("<address-space>"),
								}},
							IPConfigurationID: to.StringPtr("<ipconfiguration-id>"),
							Mode:              armnetwork.VPNNatRuleMode("EgressSnat").ToPtr(),
						},
					}},
				VirtualHub: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNGatewaysClientCreateOrUpdateResult)
}

Output:

func (*VPNGatewaysClient) BeginDelete 

func (client *VPNGatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, gatewayName string, options *VPNGatewaysClientBeginDeleteOptions) (VPNGatewaysClientDeletePollerResponse, error)

BeginDelete - Deletes a virtual wan vpn gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. options - VPNGatewaysClientBeginDeleteOptions contains the optional parameters for the VPNGatewaysClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnGatewayDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VPNGatewaysClient) BeginReset 

func (client *VPNGatewaysClient) BeginReset(ctx context.Context, resourceGroupName string, gatewayName string, options *VPNGatewaysClientBeginResetOptions) (VPNGatewaysClientResetPollerResponse, error)

BeginReset - Resets the primary of the vpn gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. options - VPNGatewaysClientBeginResetOptions contains the optional parameters for the VPNGatewaysClient.BeginReset method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnGatewayReset.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginReset(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNGatewaysClientResetResult)
}

Output:

func (*VPNGatewaysClient) BeginStartPacketCapture 

func (client *VPNGatewaysClient) BeginStartPacketCapture(ctx context.Context, resourceGroupName string, gatewayName string, options *VPNGatewaysClientBeginStartPacketCaptureOptions) (VPNGatewaysClientStartPacketCapturePollerResponse, error)

BeginStartPacketCapture - Starts packet capture on vpn gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. options - VPNGatewaysClientBeginStartPacketCaptureOptions contains the optional parameters for the VPNGatewaysClient.BeginStartPacketCapture method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnGatewayStartPacketCaptureFilterData.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStartPacketCapture(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		&armnetwork.VPNGatewaysClientBeginStartPacketCaptureOptions{Parameters: &armnetwork.VPNGatewayPacketCaptureStartParameters{
			FilterData: to.StringPtr("<filter-data>"),
		},
		})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNGatewaysClientStartPacketCaptureResult)
}

Output:

func (*VPNGatewaysClient) BeginStopPacketCapture 

func (client *VPNGatewaysClient) BeginStopPacketCapture(ctx context.Context, resourceGroupName string, gatewayName string, options *VPNGatewaysClientBeginStopPacketCaptureOptions) (VPNGatewaysClientStopPacketCapturePollerResponse, error)

BeginStopPacketCapture - Stops packet capture on vpn gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. options - VPNGatewaysClientBeginStopPacketCaptureOptions contains the optional parameters for the VPNGatewaysClient.BeginStopPacketCapture method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnGatewayStopPacketCapture.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStopPacketCapture(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		&armnetwork.VPNGatewaysClientBeginStopPacketCaptureOptions{Parameters: &armnetwork.VPNGatewayPacketCaptureStopParameters{
			SasURL: to.StringPtr("<sas-url>"),
		},
		})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNGatewaysClientStopPacketCaptureResult)
}

Output:

func (*VPNGatewaysClient) BeginUpdateTags 

func (client *VPNGatewaysClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, gatewayName string, vpnGatewayParameters TagsObject, options *VPNGatewaysClientBeginUpdateTagsOptions) (VPNGatewaysClientUpdateTagsPollerResponse, error)

BeginUpdateTags - Updates virtual wan vpn gateway tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. vpnGatewayParameters - Parameters supplied to update a virtual wan vpn gateway tags. options - VPNGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the VPNGatewaysClient.BeginUpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnGatewayUpdateTags.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdateTags(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNGatewaysClientUpdateTagsResult)
}

Output:

func (*VPNGatewaysClient) Get 

func (client *VPNGatewaysClient) Get(ctx context.Context, resourceGroupName string, gatewayName string, options *VPNGatewaysClientGetOptions) (VPNGatewaysClientGetResponse, error)

Get - Retrieves the details of a virtual wan vpn gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. options - VPNGatewaysClientGetOptions contains the optional parameters for the VPNGatewaysClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnGatewayGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNGatewaysClientGetResult)
}

Output:

func (*VPNGatewaysClient) List 

func (client *VPNGatewaysClient) List(options *VPNGatewaysClientListOptions) *VPNGatewaysClientListPager

List - Lists all the VpnGateways in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - VPNGatewaysClientListOptions contains the optional parameters for the VPNGatewaysClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnGatewayList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNGatewaysClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VPNGatewaysClient) ListByResourceGroup 

func (client *VPNGatewaysClient) ListByResourceGroup(resourceGroupName string, options *VPNGatewaysClientListByResourceGroupOptions) *VPNGatewaysClientListByResourceGroupPager

ListByResourceGroup - Lists all the VpnGateways in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. options - VPNGatewaysClientListByResourceGroupOptions contains the optional parameters for the VPNGatewaysClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnGatewayListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNGatewaysClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VPNGatewaysClientBeginCreateOrUpdateOptions added in v0.3.0 

type VPNGatewaysClientBeginCreateOrUpdateOptions struct {
}

VPNGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNGatewaysClient.BeginCreateOrUpdate method.

type VPNGatewaysClientBeginDeleteOptions added in v0.3.0 

type VPNGatewaysClientBeginDeleteOptions struct {
}

VPNGatewaysClientBeginDeleteOptions contains the optional parameters for the VPNGatewaysClient.BeginDelete method.

type VPNGatewaysClientBeginResetOptions added in v0.3.0 

type VPNGatewaysClientBeginResetOptions struct {
}

VPNGatewaysClientBeginResetOptions contains the optional parameters for the VPNGatewaysClient.BeginReset method.

type VPNGatewaysClientBeginStartPacketCaptureOptions added in v0.3.0 

type VPNGatewaysClientBeginStartPacketCaptureOptions struct {
	// Vpn gateway packet capture parameters supplied to start packet capture on vpn gateway.
	Parameters *VPNGatewayPacketCaptureStartParameters
}

VPNGatewaysClientBeginStartPacketCaptureOptions contains the optional parameters for the VPNGatewaysClient.BeginStartPacketCapture method.

type VPNGatewaysClientBeginStopPacketCaptureOptions added in v0.3.0 

type VPNGatewaysClientBeginStopPacketCaptureOptions struct {
	// Vpn gateway packet capture parameters supplied to stop packet capture on vpn gateway.
	Parameters *VPNGatewayPacketCaptureStopParameters
}

VPNGatewaysClientBeginStopPacketCaptureOptions contains the optional parameters for the VPNGatewaysClient.BeginStopPacketCapture method.

type VPNGatewaysClientBeginUpdateTagsOptions added in v0.3.0 

type VPNGatewaysClientBeginUpdateTagsOptions struct {
}

VPNGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the VPNGatewaysClient.BeginUpdateTags method.

type VPNGatewaysClientCreateOrUpdatePoller added in v0.3.0 

type VPNGatewaysClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VPNGatewaysClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNGatewaysClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VPNGatewaysClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNGatewaysClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VPNGatewaysClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VPNGatewaysClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNGatewaysClientCreateOrUpdateResponse will be returned.

func (*VPNGatewaysClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VPNGatewaysClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNGatewaysClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VPNGatewaysClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNGatewaysClientCreateOrUpdatePollerResponse added in v0.3.0 

type VPNGatewaysClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNGatewaysClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientCreateOrUpdatePollerResponse contains the response from method VPNGatewaysClient.CreateOrUpdate.

func (VPNGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNGatewaysClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNGatewaysClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VPNGatewaysClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VPNGatewaysClient, token string) error

Resume rehydrates a VPNGatewaysClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VPNGatewaysClientCreateOrUpdateResponse added in v0.3.0 

type VPNGatewaysClientCreateOrUpdateResponse struct {
	VPNGatewaysClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientCreateOrUpdateResponse contains the response from method VPNGatewaysClient.CreateOrUpdate.

type VPNGatewaysClientCreateOrUpdateResult added in v0.3.0 

type VPNGatewaysClientCreateOrUpdateResult struct {
	VPNGateway
}

VPNGatewaysClientCreateOrUpdateResult contains the result from method VPNGatewaysClient.CreateOrUpdate.

type VPNGatewaysClientDeletePoller added in v0.3.0 

type VPNGatewaysClientDeletePoller struct {
	// contains filtered or unexported fields
}

VPNGatewaysClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNGatewaysClientDeletePoller) Done added in v0.3.0 

func (p *VPNGatewaysClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNGatewaysClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VPNGatewaysClientDeletePoller) FinalResponse(ctx context.Context) (VPNGatewaysClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNGatewaysClientDeleteResponse will be returned.

func (*VPNGatewaysClientDeletePoller) Poll added in v0.3.0 

func (p *VPNGatewaysClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNGatewaysClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VPNGatewaysClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNGatewaysClientDeletePollerResponse added in v0.3.0 

type VPNGatewaysClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNGatewaysClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientDeletePollerResponse contains the response from method VPNGatewaysClient.Delete.

func (VPNGatewaysClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNGatewaysClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNGatewaysClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNGatewaysClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VPNGatewaysClientDeletePollerResponse) Resume(ctx context.Context, client *VPNGatewaysClient, token string) error

Resume rehydrates a VPNGatewaysClientDeletePollerResponse from the provided client and resume token.

type VPNGatewaysClientDeleteResponse added in v0.3.0 

type VPNGatewaysClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientDeleteResponse contains the response from method VPNGatewaysClient.Delete.

type VPNGatewaysClientGetOptions added in v0.3.0 

type VPNGatewaysClientGetOptions struct {
}

VPNGatewaysClientGetOptions contains the optional parameters for the VPNGatewaysClient.Get method.

type VPNGatewaysClientGetResponse added in v0.3.0 

type VPNGatewaysClientGetResponse struct {
	VPNGatewaysClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientGetResponse contains the response from method VPNGatewaysClient.Get.

type VPNGatewaysClientGetResult added in v0.3.0 

type VPNGatewaysClientGetResult struct {
	VPNGateway
}

VPNGatewaysClientGetResult contains the result from method VPNGatewaysClient.Get.

type VPNGatewaysClientListByResourceGroupOptions added in v0.3.0 

type VPNGatewaysClientListByResourceGroupOptions struct {
}

VPNGatewaysClientListByResourceGroupOptions contains the optional parameters for the VPNGatewaysClient.ListByResourceGroup method.

type VPNGatewaysClientListByResourceGroupPager added in v0.3.0 

type VPNGatewaysClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

VPNGatewaysClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*VPNGatewaysClientListByResourceGroupPager) Err added in v0.3.0 

func (p *VPNGatewaysClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*VPNGatewaysClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *VPNGatewaysClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VPNGatewaysClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *VPNGatewaysClientListByResourceGroupPager) PageResponse() VPNGatewaysClientListByResourceGroupResponse

PageResponse returns the current VPNGatewaysClientListByResourceGroupResponse page.

type VPNGatewaysClientListByResourceGroupResponse added in v0.3.0 

type VPNGatewaysClientListByResourceGroupResponse struct {
	VPNGatewaysClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientListByResourceGroupResponse contains the response from method VPNGatewaysClient.ListByResourceGroup.

type VPNGatewaysClientListByResourceGroupResult added in v0.3.0 

type VPNGatewaysClientListByResourceGroupResult struct {
	ListVPNGatewaysResult
}

VPNGatewaysClientListByResourceGroupResult contains the result from method VPNGatewaysClient.ListByResourceGroup.

type VPNGatewaysClientListOptions added in v0.3.0 

type VPNGatewaysClientListOptions struct {
}

VPNGatewaysClientListOptions contains the optional parameters for the VPNGatewaysClient.List method.

type VPNGatewaysClientListPager added in v0.3.0 

type VPNGatewaysClientListPager struct {
	// contains filtered or unexported fields
}

VPNGatewaysClientListPager provides operations for iterating over paged responses.

func (*VPNGatewaysClientListPager) Err added in v0.3.0 

func (p *VPNGatewaysClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VPNGatewaysClientListPager) NextPage added in v0.3.0 

func (p *VPNGatewaysClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VPNGatewaysClientListPager) PageResponse added in v0.3.0 

func (p *VPNGatewaysClientListPager) PageResponse() VPNGatewaysClientListResponse

PageResponse returns the current VPNGatewaysClientListResponse page.

type VPNGatewaysClientListResponse added in v0.3.0 

type VPNGatewaysClientListResponse struct {
	VPNGatewaysClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientListResponse contains the response from method VPNGatewaysClient.List.

type VPNGatewaysClientListResult added in v0.3.0 

type VPNGatewaysClientListResult struct {
	ListVPNGatewaysResult
}

VPNGatewaysClientListResult contains the result from method VPNGatewaysClient.List.

type VPNGatewaysClientResetPoller added in v0.3.0 

type VPNGatewaysClientResetPoller struct {
	// contains filtered or unexported fields
}

VPNGatewaysClientResetPoller provides polling facilities until the operation reaches a terminal state.

func (*VPNGatewaysClientResetPoller) Done added in v0.3.0 

func (p *VPNGatewaysClientResetPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNGatewaysClientResetPoller) FinalResponse added in v0.3.0 

func (p *VPNGatewaysClientResetPoller) FinalResponse(ctx context.Context) (VPNGatewaysClientResetResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNGatewaysClientResetResponse will be returned.

func (*VPNGatewaysClientResetPoller) Poll added in v0.3.0 

func (p *VPNGatewaysClientResetPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNGatewaysClientResetPoller) ResumeToken added in v0.3.0 

func (p *VPNGatewaysClientResetPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNGatewaysClientResetPollerResponse added in v0.3.0 

type VPNGatewaysClientResetPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNGatewaysClientResetPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientResetPollerResponse contains the response from method VPNGatewaysClient.Reset.

func (VPNGatewaysClientResetPollerResponse) PollUntilDone added in v0.3.0 

func (l VPNGatewaysClientResetPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNGatewaysClientResetResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNGatewaysClientResetPollerResponse) Resume added in v0.3.0 

func (l *VPNGatewaysClientResetPollerResponse) Resume(ctx context.Context, client *VPNGatewaysClient, token string) error

Resume rehydrates a VPNGatewaysClientResetPollerResponse from the provided client and resume token.

type VPNGatewaysClientResetResponse added in v0.3.0 

type VPNGatewaysClientResetResponse struct {
	VPNGatewaysClientResetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientResetResponse contains the response from method VPNGatewaysClient.Reset.

type VPNGatewaysClientResetResult added in v0.3.0 

type VPNGatewaysClientResetResult struct {
	VPNGateway
}

VPNGatewaysClientResetResult contains the result from method VPNGatewaysClient.Reset.

type VPNGatewaysClientStartPacketCapturePoller added in v0.3.0 

type VPNGatewaysClientStartPacketCapturePoller struct {
	// contains filtered or unexported fields
}

VPNGatewaysClientStartPacketCapturePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNGatewaysClientStartPacketCapturePoller) Done added in v0.3.0 

func (p *VPNGatewaysClientStartPacketCapturePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNGatewaysClientStartPacketCapturePoller) FinalResponse added in v0.3.0 

func (p *VPNGatewaysClientStartPacketCapturePoller) FinalResponse(ctx context.Context) (VPNGatewaysClientStartPacketCaptureResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNGatewaysClientStartPacketCaptureResponse will be returned.

func (*VPNGatewaysClientStartPacketCapturePoller) Poll added in v0.3.0 

func (p *VPNGatewaysClientStartPacketCapturePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNGatewaysClientStartPacketCapturePoller) ResumeToken added in v0.3.0 

func (p *VPNGatewaysClientStartPacketCapturePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNGatewaysClientStartPacketCapturePollerResponse added in v0.3.0 

type VPNGatewaysClientStartPacketCapturePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNGatewaysClientStartPacketCapturePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientStartPacketCapturePollerResponse contains the response from method VPNGatewaysClient.StartPacketCapture.

func (VPNGatewaysClientStartPacketCapturePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNGatewaysClientStartPacketCapturePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNGatewaysClientStartPacketCaptureResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNGatewaysClientStartPacketCapturePollerResponse) Resume added in v0.3.0 

func (l *VPNGatewaysClientStartPacketCapturePollerResponse) Resume(ctx context.Context, client *VPNGatewaysClient, token string) error

Resume rehydrates a VPNGatewaysClientStartPacketCapturePollerResponse from the provided client and resume token.

type VPNGatewaysClientStartPacketCaptureResponse added in v0.3.0 

type VPNGatewaysClientStartPacketCaptureResponse struct {
	VPNGatewaysClientStartPacketCaptureResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientStartPacketCaptureResponse contains the response from method VPNGatewaysClient.StartPacketCapture.

type VPNGatewaysClientStartPacketCaptureResult added in v0.3.0 

type VPNGatewaysClientStartPacketCaptureResult struct {
	Value *string
}

VPNGatewaysClientStartPacketCaptureResult contains the result from method VPNGatewaysClient.StartPacketCapture.

type VPNGatewaysClientStopPacketCapturePoller added in v0.3.0 

type VPNGatewaysClientStopPacketCapturePoller struct {
	// contains filtered or unexported fields
}

VPNGatewaysClientStopPacketCapturePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNGatewaysClientStopPacketCapturePoller) Done added in v0.3.0 

func (p *VPNGatewaysClientStopPacketCapturePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNGatewaysClientStopPacketCapturePoller) FinalResponse added in v0.3.0 

func (p *VPNGatewaysClientStopPacketCapturePoller) FinalResponse(ctx context.Context) (VPNGatewaysClientStopPacketCaptureResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNGatewaysClientStopPacketCaptureResponse will be returned.

func (*VPNGatewaysClientStopPacketCapturePoller) Poll added in v0.3.0 

func (p *VPNGatewaysClientStopPacketCapturePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNGatewaysClientStopPacketCapturePoller) ResumeToken added in v0.3.0 

func (p *VPNGatewaysClientStopPacketCapturePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNGatewaysClientStopPacketCapturePollerResponse added in v0.3.0 

type VPNGatewaysClientStopPacketCapturePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNGatewaysClientStopPacketCapturePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientStopPacketCapturePollerResponse contains the response from method VPNGatewaysClient.StopPacketCapture.

func (VPNGatewaysClientStopPacketCapturePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNGatewaysClientStopPacketCapturePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNGatewaysClientStopPacketCaptureResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNGatewaysClientStopPacketCapturePollerResponse) Resume added in v0.3.0 

func (l *VPNGatewaysClientStopPacketCapturePollerResponse) Resume(ctx context.Context, client *VPNGatewaysClient, token string) error

Resume rehydrates a VPNGatewaysClientStopPacketCapturePollerResponse from the provided client and resume token.

type VPNGatewaysClientStopPacketCaptureResponse added in v0.3.0 

type VPNGatewaysClientStopPacketCaptureResponse struct {
	VPNGatewaysClientStopPacketCaptureResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientStopPacketCaptureResponse contains the response from method VPNGatewaysClient.StopPacketCapture.

type VPNGatewaysClientStopPacketCaptureResult added in v0.3.0 

type VPNGatewaysClientStopPacketCaptureResult struct {
	Value *string
}

VPNGatewaysClientStopPacketCaptureResult contains the result from method VPNGatewaysClient.StopPacketCapture.

type VPNGatewaysClientUpdateTagsPoller added in v0.3.0 

type VPNGatewaysClientUpdateTagsPoller struct {
	// contains filtered or unexported fields
}

VPNGatewaysClientUpdateTagsPoller provides polling facilities until the operation reaches a terminal state.

func (*VPNGatewaysClientUpdateTagsPoller) Done added in v0.3.0 

func (p *VPNGatewaysClientUpdateTagsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNGatewaysClientUpdateTagsPoller) FinalResponse added in v0.3.0 

func (p *VPNGatewaysClientUpdateTagsPoller) FinalResponse(ctx context.Context) (VPNGatewaysClientUpdateTagsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNGatewaysClientUpdateTagsResponse will be returned.

func (*VPNGatewaysClientUpdateTagsPoller) Poll added in v0.3.0 

func (p *VPNGatewaysClientUpdateTagsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNGatewaysClientUpdateTagsPoller) ResumeToken added in v0.3.0 

func (p *VPNGatewaysClientUpdateTagsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNGatewaysClientUpdateTagsPollerResponse added in v0.3.0 

type VPNGatewaysClientUpdateTagsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNGatewaysClientUpdateTagsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientUpdateTagsPollerResponse contains the response from method VPNGatewaysClient.UpdateTags.

func (VPNGatewaysClientUpdateTagsPollerResponse) PollUntilDone added in v0.3.0 

func (l VPNGatewaysClientUpdateTagsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNGatewaysClientUpdateTagsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNGatewaysClientUpdateTagsPollerResponse) Resume added in v0.3.0 

func (l *VPNGatewaysClientUpdateTagsPollerResponse) Resume(ctx context.Context, client *VPNGatewaysClient, token string) error

Resume rehydrates a VPNGatewaysClientUpdateTagsPollerResponse from the provided client and resume token.

type VPNGatewaysClientUpdateTagsResponse added in v0.3.0 

type VPNGatewaysClientUpdateTagsResponse struct {
	VPNGatewaysClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNGatewaysClientUpdateTagsResponse contains the response from method VPNGatewaysClient.UpdateTags.

type VPNGatewaysClientUpdateTagsResult added in v0.3.0 

type VPNGatewaysClientUpdateTagsResult struct {
	VPNGateway
}

VPNGatewaysClientUpdateTagsResult contains the result from method VPNGatewaysClient.UpdateTags.

type VPNLinkBgpSettings 

type VPNLinkBgpSettings struct {
	// The BGP speaker's ASN.
	Asn *int64 `json:"asn,omitempty"`

	// The BGP peering address and BGP identifier of this BGP speaker.
	BgpPeeringAddress *string `json:"bgpPeeringAddress,omitempty"`
}

VPNLinkBgpSettings - BGP settings details for a link.

type VPNLinkConnectionMode 

type VPNLinkConnectionMode string

VPNLinkConnectionMode - Vpn link connection mode. 

const (
	VPNLinkConnectionModeDefault       VPNLinkConnectionMode = "Default"
	VPNLinkConnectionModeInitiatorOnly VPNLinkConnectionMode = "InitiatorOnly"
	VPNLinkConnectionModeResponderOnly VPNLinkConnectionMode = "ResponderOnly"
)

func PossibleVPNLinkConnectionModeValues 

func PossibleVPNLinkConnectionModeValues() []VPNLinkConnectionMode

PossibleVPNLinkConnectionModeValues returns the possible values for the VPNLinkConnectionMode const type.

func (VPNLinkConnectionMode) ToPtr 

func (c VPNLinkConnectionMode) ToPtr() *VPNLinkConnectionMode

ToPtr returns a *VPNLinkConnectionMode pointing to the current value.

type VPNLinkConnectionsClient 

type VPNLinkConnectionsClient struct {
	// contains filtered or unexported fields
}

VPNLinkConnectionsClient contains the methods for the VPNLinkConnections group. Don't use this type directly, use NewVPNLinkConnectionsClient() instead.

func NewVPNLinkConnectionsClient 

func NewVPNLinkConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VPNLinkConnectionsClient

NewVPNLinkConnectionsClient creates a new instance of VPNLinkConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VPNLinkConnectionsClient) BeginGetIkeSas 

func (client *VPNLinkConnectionsClient) BeginGetIkeSas(ctx context.Context, resourceGroupName string, gatewayName string, connectionName string, linkConnectionName string, options *VPNLinkConnectionsClientBeginGetIkeSasOptions) (VPNLinkConnectionsClientGetIkeSasPollerResponse, error)

BeginGetIkeSas - Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. gatewayName - The name of the gateway. connectionName - The name of the vpn connection. linkConnectionName - The name of the vpn link connection. options - VPNLinkConnectionsClientBeginGetIkeSasOptions contains the optional parameters for the VPNLinkConnectionsClient.BeginGetIkeSas method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSiteLinkConnectionGetIkeSas.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNLinkConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetIkeSas(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<connection-name>",
		"<link-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNLinkConnectionsClientGetIkeSasResult)
}

Output:

func (*VPNLinkConnectionsClient) BeginResetConnection 

func (client *VPNLinkConnectionsClient) BeginResetConnection(ctx context.Context, resourceGroupName string, gatewayName string, connectionName string, linkConnectionName string, options *VPNLinkConnectionsClientBeginResetConnectionOptions) (VPNLinkConnectionsClientResetConnectionPollerResponse, error)

BeginResetConnection - Resets the VpnLink connection specified. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. gatewayName - The name of the gateway. connectionName - The name of the vpn connection. linkConnectionName - The name of the vpn link connection. options - VPNLinkConnectionsClientBeginResetConnectionOptions contains the optional parameters for the VPNLinkConnectionsClient.BeginResetConnection method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSiteLinkConnectionReset.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNLinkConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginResetConnection(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<connection-name>",
		"<link-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VPNLinkConnectionsClient) ListByVPNConnection 

func (client *VPNLinkConnectionsClient) ListByVPNConnection(resourceGroupName string, gatewayName string, connectionName string, options *VPNLinkConnectionsClientListByVPNConnectionOptions) *VPNLinkConnectionsClientListByVPNConnectionPager

ListByVPNConnection - Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the vpn gateway. gatewayName - The name of the gateway. connectionName - The name of the vpn connection. options - VPNLinkConnectionsClientListByVPNConnectionOptions contains the optional parameters for the VPNLinkConnectionsClient.ListByVPNConnection method.

type VPNLinkConnectionsClientBeginGetIkeSasOptions added in v0.3.0 

type VPNLinkConnectionsClientBeginGetIkeSasOptions struct {
}

VPNLinkConnectionsClientBeginGetIkeSasOptions contains the optional parameters for the VPNLinkConnectionsClient.BeginGetIkeSas method.

type VPNLinkConnectionsClientBeginResetConnectionOptions added in v0.3.0 

type VPNLinkConnectionsClientBeginResetConnectionOptions struct {
}

VPNLinkConnectionsClientBeginResetConnectionOptions contains the optional parameters for the VPNLinkConnectionsClient.BeginResetConnection method.

type VPNLinkConnectionsClientGetIkeSasPoller added in v0.3.0 

type VPNLinkConnectionsClientGetIkeSasPoller struct {
	// contains filtered or unexported fields
}

VPNLinkConnectionsClientGetIkeSasPoller provides polling facilities until the operation reaches a terminal state.

func (*VPNLinkConnectionsClientGetIkeSasPoller) Done added in v0.3.0 

func (p *VPNLinkConnectionsClientGetIkeSasPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNLinkConnectionsClientGetIkeSasPoller) FinalResponse added in v0.3.0 

func (p *VPNLinkConnectionsClientGetIkeSasPoller) FinalResponse(ctx context.Context) (VPNLinkConnectionsClientGetIkeSasResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNLinkConnectionsClientGetIkeSasResponse will be returned.

func (*VPNLinkConnectionsClientGetIkeSasPoller) Poll added in v0.3.0 

func (p *VPNLinkConnectionsClientGetIkeSasPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNLinkConnectionsClientGetIkeSasPoller) ResumeToken added in v0.3.0 

func (p *VPNLinkConnectionsClientGetIkeSasPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNLinkConnectionsClientGetIkeSasPollerResponse added in v0.3.0 

type VPNLinkConnectionsClientGetIkeSasPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNLinkConnectionsClientGetIkeSasPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNLinkConnectionsClientGetIkeSasPollerResponse contains the response from method VPNLinkConnectionsClient.GetIkeSas.

func (VPNLinkConnectionsClientGetIkeSasPollerResponse) PollUntilDone added in v0.3.0 

func (l VPNLinkConnectionsClientGetIkeSasPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNLinkConnectionsClientGetIkeSasResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNLinkConnectionsClientGetIkeSasPollerResponse) Resume added in v0.3.0 

func (l *VPNLinkConnectionsClientGetIkeSasPollerResponse) Resume(ctx context.Context, client *VPNLinkConnectionsClient, token string) error

Resume rehydrates a VPNLinkConnectionsClientGetIkeSasPollerResponse from the provided client and resume token.

type VPNLinkConnectionsClientGetIkeSasResponse added in v0.3.0 

type VPNLinkConnectionsClientGetIkeSasResponse struct {
	VPNLinkConnectionsClientGetIkeSasResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNLinkConnectionsClientGetIkeSasResponse contains the response from method VPNLinkConnectionsClient.GetIkeSas.

type VPNLinkConnectionsClientGetIkeSasResult added in v0.3.0 

type VPNLinkConnectionsClientGetIkeSasResult struct {
	Value *string
}

VPNLinkConnectionsClientGetIkeSasResult contains the result from method VPNLinkConnectionsClient.GetIkeSas.

type VPNLinkConnectionsClientListByVPNConnectionOptions added in v0.3.0 

type VPNLinkConnectionsClientListByVPNConnectionOptions struct {
}

VPNLinkConnectionsClientListByVPNConnectionOptions contains the optional parameters for the VPNLinkConnectionsClient.ListByVPNConnection method.

type VPNLinkConnectionsClientListByVPNConnectionPager added in v0.3.0 

type VPNLinkConnectionsClientListByVPNConnectionPager struct {
	// contains filtered or unexported fields
}

VPNLinkConnectionsClientListByVPNConnectionPager provides operations for iterating over paged responses.

func (*VPNLinkConnectionsClientListByVPNConnectionPager) Err added in v0.3.0 

func (p *VPNLinkConnectionsClientListByVPNConnectionPager) Err() error

Err returns the last error encountered while paging.

func (*VPNLinkConnectionsClientListByVPNConnectionPager) NextPage added in v0.3.0 

func (p *VPNLinkConnectionsClientListByVPNConnectionPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VPNLinkConnectionsClientListByVPNConnectionPager) PageResponse added in v0.3.0 

func (p *VPNLinkConnectionsClientListByVPNConnectionPager) PageResponse() VPNLinkConnectionsClientListByVPNConnectionResponse

PageResponse returns the current VPNLinkConnectionsClientListByVPNConnectionResponse page.

type VPNLinkConnectionsClientListByVPNConnectionResponse added in v0.3.0 

type VPNLinkConnectionsClientListByVPNConnectionResponse struct {
	VPNLinkConnectionsClientListByVPNConnectionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNLinkConnectionsClientListByVPNConnectionResponse contains the response from method VPNLinkConnectionsClient.ListByVPNConnection.

type VPNLinkConnectionsClientListByVPNConnectionResult added in v0.3.0 

type VPNLinkConnectionsClientListByVPNConnectionResult struct {
	ListVPNSiteLinkConnectionsResult
}

VPNLinkConnectionsClientListByVPNConnectionResult contains the result from method VPNLinkConnectionsClient.ListByVPNConnection.

type VPNLinkConnectionsClientResetConnectionPoller added in v0.3.0 

type VPNLinkConnectionsClientResetConnectionPoller struct {
	// contains filtered or unexported fields
}

VPNLinkConnectionsClientResetConnectionPoller provides polling facilities until the operation reaches a terminal state.

func (*VPNLinkConnectionsClientResetConnectionPoller) Done added in v0.3.0 

func (p *VPNLinkConnectionsClientResetConnectionPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNLinkConnectionsClientResetConnectionPoller) FinalResponse added in v0.3.0 

func (p *VPNLinkConnectionsClientResetConnectionPoller) FinalResponse(ctx context.Context) (VPNLinkConnectionsClientResetConnectionResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNLinkConnectionsClientResetConnectionResponse will be returned.

func (*VPNLinkConnectionsClientResetConnectionPoller) Poll added in v0.3.0 

func (p *VPNLinkConnectionsClientResetConnectionPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNLinkConnectionsClientResetConnectionPoller) ResumeToken added in v0.3.0 

func (p *VPNLinkConnectionsClientResetConnectionPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNLinkConnectionsClientResetConnectionPollerResponse added in v0.3.0 

type VPNLinkConnectionsClientResetConnectionPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNLinkConnectionsClientResetConnectionPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNLinkConnectionsClientResetConnectionPollerResponse contains the response from method VPNLinkConnectionsClient.ResetConnection.

func (VPNLinkConnectionsClientResetConnectionPollerResponse) PollUntilDone added in v0.3.0 

func (l VPNLinkConnectionsClientResetConnectionPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNLinkConnectionsClientResetConnectionResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNLinkConnectionsClientResetConnectionPollerResponse) Resume added in v0.3.0 

func (l *VPNLinkConnectionsClientResetConnectionPollerResponse) Resume(ctx context.Context, client *VPNLinkConnectionsClient, token string) error

Resume rehydrates a VPNLinkConnectionsClientResetConnectionPollerResponse from the provided client and resume token.

type VPNLinkConnectionsClientResetConnectionResponse added in v0.3.0 

type VPNLinkConnectionsClientResetConnectionResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNLinkConnectionsClientResetConnectionResponse contains the response from method VPNLinkConnectionsClient.ResetConnection.

type VPNLinkProviderProperties 

type VPNLinkProviderProperties struct {
	// Name of the link provider.
	LinkProviderName *string `json:"linkProviderName,omitempty"`

	// Link speed.
	LinkSpeedInMbps *int32 `json:"linkSpeedInMbps,omitempty"`
}

VPNLinkProviderProperties - List of properties of a link provider.

type VPNNatRuleMapping 

type VPNNatRuleMapping struct {
	// Address space for Vpn NatRule mapping.
	AddressSpace *string `json:"addressSpace,omitempty"`

	// Port range for Vpn NatRule mapping.
	PortRange *string `json:"portRange,omitempty"`
}

VPNNatRuleMapping - Vpn NatRule mapping.

type VPNNatRuleMode 

type VPNNatRuleMode string

VPNNatRuleMode - The Source NAT direction of a VPN NAT. 

const (
	VPNNatRuleModeEgressSnat  VPNNatRuleMode = "EgressSnat"
	VPNNatRuleModeIngressSnat VPNNatRuleMode = "IngressSnat"
)

func PossibleVPNNatRuleModeValues 

func PossibleVPNNatRuleModeValues() []VPNNatRuleMode

PossibleVPNNatRuleModeValues returns the possible values for the VPNNatRuleMode const type.

func (VPNNatRuleMode) ToPtr 

func (c VPNNatRuleMode) ToPtr() *VPNNatRuleMode

ToPtr returns a *VPNNatRuleMode pointing to the current value.

type VPNNatRuleType 

type VPNNatRuleType string

VPNNatRuleType - The type of NAT rule for VPN NAT. 

const (
	VPNNatRuleTypeDynamic VPNNatRuleType = "Dynamic"
	VPNNatRuleTypeStatic  VPNNatRuleType = "Static"
)

func PossibleVPNNatRuleTypeValues 

func PossibleVPNNatRuleTypeValues() []VPNNatRuleType

PossibleVPNNatRuleTypeValues returns the possible values for the VPNNatRuleType const type.

func (VPNNatRuleType) ToPtr 

func (c VPNNatRuleType) ToPtr() *VPNNatRuleType

ToPtr returns a *VPNNatRuleType pointing to the current value.

type VPNPacketCaptureStartParameters 

type VPNPacketCaptureStartParameters struct {
	// Start Packet capture parameters.
	FilterData *string `json:"filterData,omitempty"`
}

VPNPacketCaptureStartParameters - Start packet capture parameters on virtual network gateway.

type VPNPacketCaptureStopParameters 

type VPNPacketCaptureStopParameters struct {
	// SAS url for packet capture on virtual network gateway.
	SasURL *string `json:"sasUrl,omitempty"`
}

VPNPacketCaptureStopParameters - Stop packet capture parameters.

type VPNProfileResponse 

type VPNProfileResponse struct {
	// URL to the VPN profile.
	ProfileURL *string `json:"profileUrl,omitempty"`
}

VPNProfileResponse - Vpn Profile Response for package generation.

type VPNServerConfigRadiusClientRootCertificate 

type VPNServerConfigRadiusClientRootCertificate struct {
	// The certificate name.
	Name *string `json:"name,omitempty"`

	// The Radius client root certificate thumbprint.
	Thumbprint *string `json:"thumbprint,omitempty"`
}

VPNServerConfigRadiusClientRootCertificate - Properties of the Radius client root certificate of VpnServerConfiguration.

type VPNServerConfigRadiusServerRootCertificate 

type VPNServerConfigRadiusServerRootCertificate struct {
	// The certificate name.
	Name *string `json:"name,omitempty"`

	// The certificate public data.
	PublicCertData *string `json:"publicCertData,omitempty"`
}

VPNServerConfigRadiusServerRootCertificate - Properties of Radius Server root certificate of VpnServerConfiguration.

type VPNServerConfigVPNClientRevokedCertificate 

type VPNServerConfigVPNClientRevokedCertificate struct {
	// The certificate name.
	Name *string `json:"name,omitempty"`

	// The revoked VPN client certificate thumbprint.
	Thumbprint *string `json:"thumbprint,omitempty"`
}

VPNServerConfigVPNClientRevokedCertificate - Properties of the revoked VPN client certificate of VpnServerConfiguration.

type VPNServerConfigVPNClientRootCertificate 

type VPNServerConfigVPNClientRootCertificate struct {
	// The certificate name.
	Name *string `json:"name,omitempty"`

	// The certificate public data.
	PublicCertData *string `json:"publicCertData,omitempty"`
}

VPNServerConfigVPNClientRootCertificate - Properties of VPN client root certificate of VpnServerConfiguration.

type VPNServerConfiguration 

type VPNServerConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the P2SVpnServer configuration.
	Properties *VPNServerConfigurationProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VPNServerConfiguration - VpnServerConfiguration Resource.

func (VPNServerConfiguration) MarshalJSON 

func (v VPNServerConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNServerConfiguration.

type VPNServerConfigurationProperties 

type VPNServerConfigurationProperties struct {
	// The set of aad vpn authentication parameters.
	AADAuthenticationParameters *AADAuthenticationParameters `json:"aadAuthenticationParameters,omitempty"`

	// The name of the VpnServerConfiguration that is unique within a resource group.
	Name *string `json:"name,omitempty"`

	// Radius client root certificate of VpnServerConfiguration.
	RadiusClientRootCertificates []*VPNServerConfigRadiusClientRootCertificate `json:"radiusClientRootCertificates,omitempty"`

	// The radius server address property of the VpnServerConfiguration resource for point to site client connection.
	RadiusServerAddress *string `json:"radiusServerAddress,omitempty"`

	// Radius Server root certificate of VpnServerConfiguration.
	RadiusServerRootCertificates []*VPNServerConfigRadiusServerRootCertificate `json:"radiusServerRootCertificates,omitempty"`

	// The radius secret property of the VpnServerConfiguration resource for point to site client connection.
	RadiusServerSecret *string `json:"radiusServerSecret,omitempty"`

	// Multiple Radius Server configuration for VpnServerConfiguration.
	RadiusServers []*RadiusServer `json:"radiusServers,omitempty"`

	// VPN authentication types for the VpnServerConfiguration.
	VPNAuthenticationTypes []*VPNAuthenticationType `json:"vpnAuthenticationTypes,omitempty"`

	// VpnClientIpsecPolicies for VpnServerConfiguration.
	VPNClientIPSecPolicies []*IPSecPolicy `json:"vpnClientIpsecPolicies,omitempty"`

	// VPN client revoked certificate of VpnServerConfiguration.
	VPNClientRevokedCertificates []*VPNServerConfigVPNClientRevokedCertificate `json:"vpnClientRevokedCertificates,omitempty"`

	// VPN client root certificate of VpnServerConfiguration.
	VPNClientRootCertificates []*VPNServerConfigVPNClientRootCertificate `json:"vpnClientRootCertificates,omitempty"`

	// VPN protocols for the VpnServerConfiguration.
	VPNProtocols []*VPNGatewayTunnelingProtocol `json:"vpnProtocols,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; List of references to P2SVpnGateways.
	P2SVPNGateways []*P2SVPNGateway `json:"p2SVpnGateways,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting',
	// and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

VPNServerConfigurationProperties - Parameters for VpnServerConfiguration.

func (VPNServerConfigurationProperties) MarshalJSON 

func (v VPNServerConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNServerConfigurationProperties.

type VPNServerConfigurationsAssociatedWithVirtualWanClient 

type VPNServerConfigurationsAssociatedWithVirtualWanClient struct {
	// contains filtered or unexported fields
}

VPNServerConfigurationsAssociatedWithVirtualWanClient contains the methods for the VPNServerConfigurationsAssociatedWithVirtualWan group. Don't use this type directly, use NewVPNServerConfigurationsAssociatedWithVirtualWanClient() instead.

func NewVPNServerConfigurationsAssociatedWithVirtualWanClient 

func NewVPNServerConfigurationsAssociatedWithVirtualWanClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VPNServerConfigurationsAssociatedWithVirtualWanClient

NewVPNServerConfigurationsAssociatedWithVirtualWanClient creates a new instance of VPNServerConfigurationsAssociatedWithVirtualWanClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VPNServerConfigurationsAssociatedWithVirtualWanClient) BeginList 

func (client *VPNServerConfigurationsAssociatedWithVirtualWanClient) BeginList(ctx context.Context, resourceGroupName string, virtualWANName string, options *VPNServerConfigurationsAssociatedWithVirtualWanClientBeginListOptions) (VPNServerConfigurationsAssociatedWithVirtualWanClientListPollerResponse, error)

BeginList - Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name. virtualWANName - The name of the VirtualWAN whose associated VpnServerConfigurations is needed. options - VPNServerConfigurationsAssociatedWithVirtualWanClientBeginListOptions contains the optional parameters for the VPNServerConfigurationsAssociatedWithVirtualWanClient.BeginList method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/GetVirtualWanVpnServerConfigurations.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNServerConfigurationsAssociatedWithVirtualWanClient("<subscription-id>", cred, nil)
	poller, err := client.BeginList(ctx,
		"<resource-group-name>",
		"<virtual-wanname>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNServerConfigurationsAssociatedWithVirtualWanClientListResult)
}

Output:

type VPNServerConfigurationsAssociatedWithVirtualWanClientBeginListOptions added in v0.3.0 

type VPNServerConfigurationsAssociatedWithVirtualWanClientBeginListOptions struct {
}

VPNServerConfigurationsAssociatedWithVirtualWanClientBeginListOptions contains the optional parameters for the VPNServerConfigurationsAssociatedWithVirtualWanClient.BeginList method.

type VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller added in v0.3.0 

type VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller struct {
	// contains filtered or unexported fields
}

VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller provides polling facilities until the operation reaches a terminal state.

func (*VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller) Done added in v0.3.0 

func (p *VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller) FinalResponse added in v0.3.0 

func (p *VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller) FinalResponse(ctx context.Context) (VPNServerConfigurationsAssociatedWithVirtualWanClientListResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNServerConfigurationsAssociatedWithVirtualWanClientListResponse will be returned.

func (*VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller) Poll added in v0.3.0 

func (p *VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller) ResumeToken added in v0.3.0 

func (p *VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNServerConfigurationsAssociatedWithVirtualWanClientListPollerResponse added in v0.3.0 

type VPNServerConfigurationsAssociatedWithVirtualWanClientListPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNServerConfigurationsAssociatedWithVirtualWanClientListPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNServerConfigurationsAssociatedWithVirtualWanClientListPollerResponse contains the response from method VPNServerConfigurationsAssociatedWithVirtualWanClient.List.

func (VPNServerConfigurationsAssociatedWithVirtualWanClientListPollerResponse) PollUntilDone added in v0.3.0 

func (l VPNServerConfigurationsAssociatedWithVirtualWanClientListPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNServerConfigurationsAssociatedWithVirtualWanClientListResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNServerConfigurationsAssociatedWithVirtualWanClientListPollerResponse) Resume added in v0.3.0 

func (l *VPNServerConfigurationsAssociatedWithVirtualWanClientListPollerResponse) Resume(ctx context.Context, client *VPNServerConfigurationsAssociatedWithVirtualWanClient, token string) error

Resume rehydrates a VPNServerConfigurationsAssociatedWithVirtualWanClientListPollerResponse from the provided client and resume token.

type VPNServerConfigurationsAssociatedWithVirtualWanClientListResponse added in v0.3.0 

type VPNServerConfigurationsAssociatedWithVirtualWanClientListResponse struct {
	VPNServerConfigurationsAssociatedWithVirtualWanClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNServerConfigurationsAssociatedWithVirtualWanClientListResponse contains the response from method VPNServerConfigurationsAssociatedWithVirtualWanClient.List.

type VPNServerConfigurationsAssociatedWithVirtualWanClientListResult added in v0.3.0 

type VPNServerConfigurationsAssociatedWithVirtualWanClientListResult struct {
	VPNServerConfigurationsResponse
}

VPNServerConfigurationsAssociatedWithVirtualWanClientListResult contains the result from method VPNServerConfigurationsAssociatedWithVirtualWanClient.List.

type VPNServerConfigurationsClient 

type VPNServerConfigurationsClient struct {
	// contains filtered or unexported fields
}

VPNServerConfigurationsClient contains the methods for the VPNServerConfigurations group. Don't use this type directly, use NewVPNServerConfigurationsClient() instead.

func NewVPNServerConfigurationsClient 

func NewVPNServerConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VPNServerConfigurationsClient

NewVPNServerConfigurationsClient creates a new instance of VPNServerConfigurationsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VPNServerConfigurationsClient) BeginCreateOrUpdate 

func (client *VPNServerConfigurationsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, vpnServerConfigurationName string, vpnServerConfigurationParameters VPNServerConfiguration, options *VPNServerConfigurationsClientBeginCreateOrUpdateOptions) (VPNServerConfigurationsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnServerConfiguration. vpnServerConfigurationName - The name of the VpnServerConfiguration being created or updated. vpnServerConfigurationParameters - Parameters supplied to create or update VpnServerConfiguration. options - VPNServerConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNServerConfigurationsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnServerConfigurationPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNServerConfigurationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<vpn-server-configuration-name>",
		armnetwork.VPNServerConfiguration{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.VPNServerConfigurationProperties{
				RadiusClientRootCertificates: []*armnetwork.VPNServerConfigRadiusClientRootCertificate{
					{
						Name:       to.StringPtr("<name>"),
						Thumbprint: to.StringPtr("<thumbprint>"),
					}},
				RadiusServerRootCertificates: []*armnetwork.VPNServerConfigRadiusServerRootCertificate{
					{
						Name:           to.StringPtr("<name>"),
						PublicCertData: to.StringPtr("<public-cert-data>"),
					}},
				RadiusServers: []*armnetwork.RadiusServer{
					{
						RadiusServerAddress: to.StringPtr("<radius-server-address>"),
						RadiusServerScore:   to.Int64Ptr(25),
						RadiusServerSecret:  to.StringPtr("<radius-server-secret>"),
					}},
				VPNClientIPSecPolicies: []*armnetwork.IPSecPolicy{
					{
						DhGroup:             armnetwork.DhGroup("DHGroup14").ToPtr(),
						IkeEncryption:       armnetwork.IkeEncryption("AES256").ToPtr(),
						IkeIntegrity:        armnetwork.IkeIntegrity("SHA384").ToPtr(),
						IPSecEncryption:     armnetwork.IPSecEncryption("AES256").ToPtr(),
						IPSecIntegrity:      armnetwork.IPSecIntegrity("SHA256").ToPtr(),
						PfsGroup:            armnetwork.PfsGroup("PFS14").ToPtr(),
						SaDataSizeKilobytes: to.Int32Ptr(429497),
						SaLifeTimeSeconds:   to.Int32Ptr(86472),
					}},
				VPNClientRevokedCertificates: []*armnetwork.VPNServerConfigVPNClientRevokedCertificate{
					{
						Name:       to.StringPtr("<name>"),
						Thumbprint: to.StringPtr("<thumbprint>"),
					}},
				VPNClientRootCertificates: []*armnetwork.VPNServerConfigVPNClientRootCertificate{
					{
						Name:           to.StringPtr("<name>"),
						PublicCertData: to.StringPtr("<public-cert-data>"),
					}},
				VPNProtocols: []*armnetwork.VPNGatewayTunnelingProtocol{
					armnetwork.VPNGatewayTunnelingProtocol("IkeV2").ToPtr()},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNServerConfigurationsClientCreateOrUpdateResult)
}

Output:

func (*VPNServerConfigurationsClient) BeginDelete 

func (client *VPNServerConfigurationsClient) BeginDelete(ctx context.Context, resourceGroupName string, vpnServerConfigurationName string, options *VPNServerConfigurationsClientBeginDeleteOptions) (VPNServerConfigurationsClientDeletePollerResponse, error)

BeginDelete - Deletes a VpnServerConfiguration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnServerConfiguration. vpnServerConfigurationName - The name of the VpnServerConfiguration being deleted. options - VPNServerConfigurationsClientBeginDeleteOptions contains the optional parameters for the VPNServerConfigurationsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnServerConfigurationDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNServerConfigurationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<vpn-server-configuration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VPNServerConfigurationsClient) Get 

func (client *VPNServerConfigurationsClient) Get(ctx context.Context, resourceGroupName string, vpnServerConfigurationName string, options *VPNServerConfigurationsClientGetOptions) (VPNServerConfigurationsClientGetResponse, error)

Get - Retrieves the details of a VpnServerConfiguration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnServerConfiguration. vpnServerConfigurationName - The name of the VpnServerConfiguration being retrieved. options - VPNServerConfigurationsClientGetOptions contains the optional parameters for the VPNServerConfigurationsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnServerConfigurationGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNServerConfigurationsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<vpn-server-configuration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNServerConfigurationsClientGetResult)
}

Output:

func (*VPNServerConfigurationsClient) List 

func (client *VPNServerConfigurationsClient) List(options *VPNServerConfigurationsClientListOptions) *VPNServerConfigurationsClientListPager

List - Lists all the VpnServerConfigurations in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - VPNServerConfigurationsClientListOptions contains the optional parameters for the VPNServerConfigurationsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnServerConfigurationList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNServerConfigurationsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VPNServerConfigurationsClient) ListByResourceGroup 

func (client *VPNServerConfigurationsClient) ListByResourceGroup(resourceGroupName string, options *VPNServerConfigurationsClientListByResourceGroupOptions) *VPNServerConfigurationsClientListByResourceGroupPager

ListByResourceGroup - Lists all the vpnServerConfigurations in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnServerConfiguration. options - VPNServerConfigurationsClientListByResourceGroupOptions contains the optional parameters for the VPNServerConfigurationsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnServerConfigurationListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNServerConfigurationsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VPNServerConfigurationsClient) UpdateTags 

func (client *VPNServerConfigurationsClient) UpdateTags(ctx context.Context, resourceGroupName string, vpnServerConfigurationName string, vpnServerConfigurationParameters TagsObject, options *VPNServerConfigurationsClientUpdateTagsOptions) (VPNServerConfigurationsClientUpdateTagsResponse, error)

UpdateTags - Updates VpnServerConfiguration tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnServerConfiguration. vpnServerConfigurationName - The name of the VpnServerConfiguration being updated. vpnServerConfigurationParameters - Parameters supplied to update VpnServerConfiguration tags. options - VPNServerConfigurationsClientUpdateTagsOptions contains the optional parameters for the VPNServerConfigurationsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnServerConfigurationUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNServerConfigurationsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<vpn-server-configuration-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
				"key2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNServerConfigurationsClientUpdateTagsResult)
}

Output:

type VPNServerConfigurationsClientBeginCreateOrUpdateOptions added in v0.3.0 

type VPNServerConfigurationsClientBeginCreateOrUpdateOptions struct {
}

VPNServerConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNServerConfigurationsClient.BeginCreateOrUpdate method.

type VPNServerConfigurationsClientBeginDeleteOptions added in v0.3.0 

type VPNServerConfigurationsClientBeginDeleteOptions struct {
}

VPNServerConfigurationsClientBeginDeleteOptions contains the optional parameters for the VPNServerConfigurationsClient.BeginDelete method.

type VPNServerConfigurationsClientCreateOrUpdatePoller added in v0.3.0 

type VPNServerConfigurationsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VPNServerConfigurationsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNServerConfigurationsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VPNServerConfigurationsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNServerConfigurationsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VPNServerConfigurationsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VPNServerConfigurationsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNServerConfigurationsClientCreateOrUpdateResponse will be returned.

func (*VPNServerConfigurationsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VPNServerConfigurationsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNServerConfigurationsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VPNServerConfigurationsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNServerConfigurationsClientCreateOrUpdatePollerResponse added in v0.3.0 

type VPNServerConfigurationsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNServerConfigurationsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNServerConfigurationsClientCreateOrUpdatePollerResponse contains the response from method VPNServerConfigurationsClient.CreateOrUpdate.

func (VPNServerConfigurationsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNServerConfigurationsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNServerConfigurationsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNServerConfigurationsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VPNServerConfigurationsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VPNServerConfigurationsClient, token string) error

Resume rehydrates a VPNServerConfigurationsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VPNServerConfigurationsClientCreateOrUpdateResponse added in v0.3.0 

type VPNServerConfigurationsClientCreateOrUpdateResponse struct {
	VPNServerConfigurationsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNServerConfigurationsClientCreateOrUpdateResponse contains the response from method VPNServerConfigurationsClient.CreateOrUpdate.

type VPNServerConfigurationsClientCreateOrUpdateResult added in v0.3.0 

type VPNServerConfigurationsClientCreateOrUpdateResult struct {
	VPNServerConfiguration
}

VPNServerConfigurationsClientCreateOrUpdateResult contains the result from method VPNServerConfigurationsClient.CreateOrUpdate.

type VPNServerConfigurationsClientDeletePoller added in v0.3.0 

type VPNServerConfigurationsClientDeletePoller struct {
	// contains filtered or unexported fields
}

VPNServerConfigurationsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNServerConfigurationsClientDeletePoller) Done added in v0.3.0 

func (p *VPNServerConfigurationsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNServerConfigurationsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VPNServerConfigurationsClientDeletePoller) FinalResponse(ctx context.Context) (VPNServerConfigurationsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNServerConfigurationsClientDeleteResponse will be returned.

func (*VPNServerConfigurationsClientDeletePoller) Poll added in v0.3.0 

func (p *VPNServerConfigurationsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNServerConfigurationsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VPNServerConfigurationsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNServerConfigurationsClientDeletePollerResponse added in v0.3.0 

type VPNServerConfigurationsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNServerConfigurationsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNServerConfigurationsClientDeletePollerResponse contains the response from method VPNServerConfigurationsClient.Delete.

func (VPNServerConfigurationsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNServerConfigurationsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNServerConfigurationsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNServerConfigurationsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VPNServerConfigurationsClientDeletePollerResponse) Resume(ctx context.Context, client *VPNServerConfigurationsClient, token string) error

Resume rehydrates a VPNServerConfigurationsClientDeletePollerResponse from the provided client and resume token.

type VPNServerConfigurationsClientDeleteResponse added in v0.3.0 

type VPNServerConfigurationsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNServerConfigurationsClientDeleteResponse contains the response from method VPNServerConfigurationsClient.Delete.

type VPNServerConfigurationsClientGetOptions added in v0.3.0 

type VPNServerConfigurationsClientGetOptions struct {
}

VPNServerConfigurationsClientGetOptions contains the optional parameters for the VPNServerConfigurationsClient.Get method.

type VPNServerConfigurationsClientGetResponse added in v0.3.0 

type VPNServerConfigurationsClientGetResponse struct {
	VPNServerConfigurationsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNServerConfigurationsClientGetResponse contains the response from method VPNServerConfigurationsClient.Get.

type VPNServerConfigurationsClientGetResult added in v0.3.0 

type VPNServerConfigurationsClientGetResult struct {
	VPNServerConfiguration
}

VPNServerConfigurationsClientGetResult contains the result from method VPNServerConfigurationsClient.Get.

type VPNServerConfigurationsClientListByResourceGroupOptions added in v0.3.0 

type VPNServerConfigurationsClientListByResourceGroupOptions struct {
}

VPNServerConfigurationsClientListByResourceGroupOptions contains the optional parameters for the VPNServerConfigurationsClient.ListByResourceGroup method.

type VPNServerConfigurationsClientListByResourceGroupPager added in v0.3.0 

type VPNServerConfigurationsClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

VPNServerConfigurationsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*VPNServerConfigurationsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *VPNServerConfigurationsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*VPNServerConfigurationsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *VPNServerConfigurationsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VPNServerConfigurationsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *VPNServerConfigurationsClientListByResourceGroupPager) PageResponse() VPNServerConfigurationsClientListByResourceGroupResponse

PageResponse returns the current VPNServerConfigurationsClientListByResourceGroupResponse page.

type VPNServerConfigurationsClientListByResourceGroupResponse added in v0.3.0 

type VPNServerConfigurationsClientListByResourceGroupResponse struct {
	VPNServerConfigurationsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNServerConfigurationsClientListByResourceGroupResponse contains the response from method VPNServerConfigurationsClient.ListByResourceGroup.

type VPNServerConfigurationsClientListByResourceGroupResult added in v0.3.0 

type VPNServerConfigurationsClientListByResourceGroupResult struct {
	ListVPNServerConfigurationsResult
}

VPNServerConfigurationsClientListByResourceGroupResult contains the result from method VPNServerConfigurationsClient.ListByResourceGroup.

type VPNServerConfigurationsClientListOptions added in v0.3.0 

type VPNServerConfigurationsClientListOptions struct {
}

VPNServerConfigurationsClientListOptions contains the optional parameters for the VPNServerConfigurationsClient.List method.

type VPNServerConfigurationsClientListPager added in v0.3.0 

type VPNServerConfigurationsClientListPager struct {
	// contains filtered or unexported fields
}

VPNServerConfigurationsClientListPager provides operations for iterating over paged responses.

func (*VPNServerConfigurationsClientListPager) Err added in v0.3.0 

func (p *VPNServerConfigurationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VPNServerConfigurationsClientListPager) NextPage added in v0.3.0 

func (p *VPNServerConfigurationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VPNServerConfigurationsClientListPager) PageResponse added in v0.3.0 

func (p *VPNServerConfigurationsClientListPager) PageResponse() VPNServerConfigurationsClientListResponse

PageResponse returns the current VPNServerConfigurationsClientListResponse page.

type VPNServerConfigurationsClientListResponse added in v0.3.0 

type VPNServerConfigurationsClientListResponse struct {
	VPNServerConfigurationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNServerConfigurationsClientListResponse contains the response from method VPNServerConfigurationsClient.List.

type VPNServerConfigurationsClientListResult added in v0.3.0 

type VPNServerConfigurationsClientListResult struct {
	ListVPNServerConfigurationsResult
}

VPNServerConfigurationsClientListResult contains the result from method VPNServerConfigurationsClient.List.

type VPNServerConfigurationsClientUpdateTagsOptions added in v0.3.0 

type VPNServerConfigurationsClientUpdateTagsOptions struct {
}

VPNServerConfigurationsClientUpdateTagsOptions contains the optional parameters for the VPNServerConfigurationsClient.UpdateTags method.

type VPNServerConfigurationsClientUpdateTagsResponse added in v0.3.0 

type VPNServerConfigurationsClientUpdateTagsResponse struct {
	VPNServerConfigurationsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNServerConfigurationsClientUpdateTagsResponse contains the response from method VPNServerConfigurationsClient.UpdateTags.

type VPNServerConfigurationsClientUpdateTagsResult added in v0.3.0 

type VPNServerConfigurationsClientUpdateTagsResult struct {
	VPNServerConfiguration
}

VPNServerConfigurationsClientUpdateTagsResult contains the result from method VPNServerConfigurationsClient.UpdateTags.

type VPNServerConfigurationsResponse 

type VPNServerConfigurationsResponse struct {
	// List of VpnServerConfigurations associated with VirtualWan.
	VPNServerConfigurationResourceIDs []*string `json:"vpnServerConfigurationResourceIds,omitempty"`
}

VPNServerConfigurationsResponse - VpnServerConfigurations list associated with VirtualWan Response.

func (VPNServerConfigurationsResponse) MarshalJSON 

func (v VPNServerConfigurationsResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNServerConfigurationsResponse.

type VPNSite 

type VPNSite struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the VPN site.
	Properties *VPNSiteProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VPNSite - VpnSite Resource.

func (VPNSite) MarshalJSON 

func (v VPNSite) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNSite.

type VPNSiteID 

type VPNSiteID struct {
	// READ-ONLY; The resource-uri of the vpn-site for which config is to be fetched.
	VPNSite *string `json:"vpnSite,omitempty" azure:"ro"`
}

VPNSiteID - VpnSite Resource. 

type VPNSiteLink struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the VPN site link.
	Properties *VPNSiteLinkProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VPNSiteLink - VpnSiteLink Resource.

type VPNSiteLinkConnection 

type VPNSiteLinkConnection struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the VPN site link connection.
	Properties *VPNSiteLinkConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VPNSiteLinkConnection - VpnSiteLinkConnection Resource.

type VPNSiteLinkConnectionProperties 

type VPNSiteLinkConnectionProperties struct {
	// Expected bandwidth in MBPS.
	ConnectionBandwidth *int32 `json:"connectionBandwidth,omitempty"`

	// List of egress NatRules.
	EgressNatRules []*SubResource `json:"egressNatRules,omitempty"`

	// EnableBgp flag.
	EnableBgp *bool `json:"enableBgp,omitempty"`

	// EnableBgp flag.
	EnableRateLimiting *bool `json:"enableRateLimiting,omitempty"`

	// The IPSec Policies to be considered by this connection.
	IPSecPolicies []*IPSecPolicy `json:"ipsecPolicies,omitempty"`

	// List of ingress NatRules.
	IngressNatRules []*SubResource `json:"ingressNatRules,omitempty"`

	// Routing weight for vpn connection.
	RoutingWeight *int32 `json:"routingWeight,omitempty"`

	// SharedKey for the vpn connection.
	SharedKey *string `json:"sharedKey,omitempty"`

	// Use local azure ip to initiate connection.
	UseLocalAzureIPAddress *bool `json:"useLocalAzureIpAddress,omitempty"`

	// Enable policy-based traffic selectors.
	UsePolicyBasedTrafficSelectors *bool `json:"usePolicyBasedTrafficSelectors,omitempty"`

	// Connection protocol used for this connection.
	VPNConnectionProtocolType *VirtualNetworkGatewayConnectionProtocol `json:"vpnConnectionProtocolType,omitempty"`

	// Vpn link connection mode.
	VPNLinkConnectionMode *VPNLinkConnectionMode `json:"vpnLinkConnectionMode,omitempty"`

	// Id of the connected vpn site link.
	VPNSiteLink *SubResource `json:"vpnSiteLink,omitempty"`

	// READ-ONLY; The connection status.
	ConnectionStatus *VPNConnectionStatus `json:"connectionStatus,omitempty" azure:"ro"`

	// READ-ONLY; Egress bytes transferred.
	EgressBytesTransferred *int64 `json:"egressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; Ingress bytes transferred.
	IngressBytesTransferred *int64 `json:"ingressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the VPN site link connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VPNSiteLinkConnectionProperties - Parameters for VpnConnection.

func (VPNSiteLinkConnectionProperties) MarshalJSON 

func (v VPNSiteLinkConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNSiteLinkConnectionProperties.

type VPNSiteLinkConnectionsClient 

type VPNSiteLinkConnectionsClient struct {
	// contains filtered or unexported fields
}

VPNSiteLinkConnectionsClient contains the methods for the VPNSiteLinkConnections group. Don't use this type directly, use NewVPNSiteLinkConnectionsClient() instead.

func NewVPNSiteLinkConnectionsClient 

func NewVPNSiteLinkConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VPNSiteLinkConnectionsClient

NewVPNSiteLinkConnectionsClient creates a new instance of VPNSiteLinkConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VPNSiteLinkConnectionsClient) Get 

func (client *VPNSiteLinkConnectionsClient) Get(ctx context.Context, resourceGroupName string, gatewayName string, connectionName string, linkConnectionName string, options *VPNSiteLinkConnectionsClientGetOptions) (VPNSiteLinkConnectionsClientGetResponse, error)

Get - Retrieves the details of a vpn site link connection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnGateway. gatewayName - The name of the gateway. connectionName - The name of the vpn connection. linkConnectionName - The name of the vpn connection. options - VPNSiteLinkConnectionsClientGetOptions contains the optional parameters for the VPNSiteLinkConnectionsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSiteLinkConnectionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNSiteLinkConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<gateway-name>",
		"<connection-name>",
		"<link-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNSiteLinkConnectionsClientGetResult)
}

Output:

type VPNSiteLinkConnectionsClientGetOptions added in v0.3.0 

type VPNSiteLinkConnectionsClientGetOptions struct {
}

VPNSiteLinkConnectionsClientGetOptions contains the optional parameters for the VPNSiteLinkConnectionsClient.Get method.

type VPNSiteLinkConnectionsClientGetResponse added in v0.3.0 

type VPNSiteLinkConnectionsClientGetResponse struct {
	VPNSiteLinkConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSiteLinkConnectionsClientGetResponse contains the response from method VPNSiteLinkConnectionsClient.Get.

type VPNSiteLinkConnectionsClientGetResult added in v0.3.0 

type VPNSiteLinkConnectionsClientGetResult struct {
	VPNSiteLinkConnection
}

VPNSiteLinkConnectionsClientGetResult contains the result from method VPNSiteLinkConnectionsClient.Get.

type VPNSiteLinkProperties 

type VPNSiteLinkProperties struct {
	// The set of bgp properties.
	BgpProperties *VPNLinkBgpSettings `json:"bgpProperties,omitempty"`

	// FQDN of vpn-site-link.
	Fqdn *string `json:"fqdn,omitempty"`

	// The ip-address for the vpn-site-link.
	IPAddress *string `json:"ipAddress,omitempty"`

	// The link provider properties.
	LinkProperties *VPNLinkProviderProperties `json:"linkProperties,omitempty"`

	// READ-ONLY; The provisioning state of the VPN site link resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VPNSiteLinkProperties - Parameters for VpnSite.

type VPNSiteLinksClient 

type VPNSiteLinksClient struct {
	// contains filtered or unexported fields
}

VPNSiteLinksClient contains the methods for the VPNSiteLinks group. Don't use this type directly, use NewVPNSiteLinksClient() instead.

func NewVPNSiteLinksClient 

func NewVPNSiteLinksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VPNSiteLinksClient

NewVPNSiteLinksClient creates a new instance of VPNSiteLinksClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VPNSiteLinksClient) Get 

func (client *VPNSiteLinksClient) Get(ctx context.Context, resourceGroupName string, vpnSiteName string, vpnSiteLinkName string, options *VPNSiteLinksClientGetOptions) (VPNSiteLinksClientGetResponse, error)

Get - Retrieves the details of a VPN site link. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnSite. vpnSiteName - The name of the VpnSite. vpnSiteLinkName - The name of the VpnSiteLink being retrieved. options - VPNSiteLinksClientGetOptions contains the optional parameters for the VPNSiteLinksClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSiteLinkGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNSiteLinksClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<vpn-site-name>",
		"<vpn-site-link-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNSiteLinksClientGetResult)
}

Output:

func (*VPNSiteLinksClient) ListByVPNSite 

func (client *VPNSiteLinksClient) ListByVPNSite(resourceGroupName string, vpnSiteName string, options *VPNSiteLinksClientListByVPNSiteOptions) *VPNSiteLinksClientListByVPNSitePager

ListByVPNSite - Lists all the vpnSiteLinks in a resource group for a vpn site. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnSite. vpnSiteName - The name of the VpnSite. options - VPNSiteLinksClientListByVPNSiteOptions contains the optional parameters for the VPNSiteLinksClient.ListByVPNSite method.

type VPNSiteLinksClientGetOptions added in v0.3.0 

type VPNSiteLinksClientGetOptions struct {
}

VPNSiteLinksClientGetOptions contains the optional parameters for the VPNSiteLinksClient.Get method.

type VPNSiteLinksClientGetResponse added in v0.3.0 

type VPNSiteLinksClientGetResponse struct {
	VPNSiteLinksClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSiteLinksClientGetResponse contains the response from method VPNSiteLinksClient.Get.

type VPNSiteLinksClientGetResult added in v0.3.0 

type VPNSiteLinksClientGetResult struct {
	VPNSiteLink
}

VPNSiteLinksClientGetResult contains the result from method VPNSiteLinksClient.Get.

type VPNSiteLinksClientListByVPNSiteOptions added in v0.3.0 

type VPNSiteLinksClientListByVPNSiteOptions struct {
}

VPNSiteLinksClientListByVPNSiteOptions contains the optional parameters for the VPNSiteLinksClient.ListByVPNSite method.

type VPNSiteLinksClientListByVPNSitePager added in v0.3.0 

type VPNSiteLinksClientListByVPNSitePager struct {
	// contains filtered or unexported fields
}

VPNSiteLinksClientListByVPNSitePager provides operations for iterating over paged responses.

func (*VPNSiteLinksClientListByVPNSitePager) Err added in v0.3.0 

func (p *VPNSiteLinksClientListByVPNSitePager) Err() error

Err returns the last error encountered while paging.

func (*VPNSiteLinksClientListByVPNSitePager) NextPage added in v0.3.0 

func (p *VPNSiteLinksClientListByVPNSitePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VPNSiteLinksClientListByVPNSitePager) PageResponse added in v0.3.0 

func (p *VPNSiteLinksClientListByVPNSitePager) PageResponse() VPNSiteLinksClientListByVPNSiteResponse

PageResponse returns the current VPNSiteLinksClientListByVPNSiteResponse page.

type VPNSiteLinksClientListByVPNSiteResponse added in v0.3.0 

type VPNSiteLinksClientListByVPNSiteResponse struct {
	VPNSiteLinksClientListByVPNSiteResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSiteLinksClientListByVPNSiteResponse contains the response from method VPNSiteLinksClient.ListByVPNSite.

type VPNSiteLinksClientListByVPNSiteResult added in v0.3.0 

type VPNSiteLinksClientListByVPNSiteResult struct {
	ListVPNSiteLinksResult
}

VPNSiteLinksClientListByVPNSiteResult contains the result from method VPNSiteLinksClient.ListByVPNSite.

type VPNSiteProperties 

type VPNSiteProperties struct {
	// The AddressSpace that contains an array of IP address ranges.
	AddressSpace *AddressSpace `json:"addressSpace,omitempty"`

	// The set of bgp properties.
	BgpProperties *BgpSettings `json:"bgpProperties,omitempty"`

	// The device properties.
	DeviceProperties *DeviceProperties `json:"deviceProperties,omitempty"`

	// The ip-address for the vpn-site.
	IPAddress *string `json:"ipAddress,omitempty"`

	// IsSecuritySite flag.
	IsSecuritySite *bool `json:"isSecuritySite,omitempty"`

	// Office365 Policy.
	O365Policy *O365PolicyProperties `json:"o365Policy,omitempty"`

	// The key for vpn-site that can be used for connections.
	SiteKey *string `json:"siteKey,omitempty"`

	// List of all vpn site links.
	VPNSiteLinks []*VPNSiteLink `json:"vpnSiteLinks,omitempty"`

	// The VirtualWAN to which the vpnSite belongs.
	VirtualWan *SubResource `json:"virtualWan,omitempty"`

	// READ-ONLY; The provisioning state of the VPN site resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VPNSiteProperties - Parameters for VpnSite.

func (VPNSiteProperties) MarshalJSON 

func (v VPNSiteProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNSiteProperties.

type VPNSitesClient 

type VPNSitesClient struct {
	// contains filtered or unexported fields
}

VPNSitesClient contains the methods for the VPNSites group. Don't use this type directly, use NewVPNSitesClient() instead.

func NewVPNSitesClient 

func NewVPNSitesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VPNSitesClient

NewVPNSitesClient creates a new instance of VPNSitesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VPNSitesClient) BeginCreateOrUpdate 

func (client *VPNSitesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, vpnSiteName string, vpnSiteParameters VPNSite, options *VPNSitesClientBeginCreateOrUpdateOptions) (VPNSitesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnSite. vpnSiteName - The name of the VpnSite being created or updated. vpnSiteParameters - Parameters supplied to create or update VpnSite. options - VPNSitesClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNSitesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSitePut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNSitesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<vpn-site-name>",
		armnetwork.VPNSite{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.VPNSiteProperties{
				AddressSpace: &armnetwork.AddressSpace{
					AddressPrefixes: []*string{
						to.StringPtr("10.0.0.0/16")},
				},
				IsSecuritySite: to.BoolPtr(false),
				O365Policy: &armnetwork.O365PolicyProperties{
					BreakOutCategories: &armnetwork.O365BreakOutCategoryPolicies{
						Default:  to.BoolPtr(false),
						Allow:    to.BoolPtr(true),
						Optimize: to.BoolPtr(true),
					},
				},
				VirtualWan: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
				VPNSiteLinks: []*armnetwork.VPNSiteLink{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.VPNSiteLinkProperties{
							BgpProperties: &armnetwork.VPNLinkBgpSettings{
								Asn:               to.Int64Ptr(1234),
								BgpPeeringAddress: to.StringPtr("<bgp-peering-address>"),
							},
							Fqdn:      to.StringPtr("<fqdn>"),
							IPAddress: to.StringPtr("<ipaddress>"),
							LinkProperties: &armnetwork.VPNLinkProviderProperties{
								LinkProviderName: to.StringPtr("<link-provider-name>"),
								LinkSpeedInMbps:  to.Int32Ptr(0),
							},
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNSitesClientCreateOrUpdateResult)
}

Output:

func (*VPNSitesClient) BeginDelete 

func (client *VPNSitesClient) BeginDelete(ctx context.Context, resourceGroupName string, vpnSiteName string, options *VPNSitesClientBeginDeleteOptions) (VPNSitesClientDeletePollerResponse, error)

BeginDelete - Deletes a VpnSite. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnSite. vpnSiteName - The name of the VpnSite being deleted. options - VPNSitesClientBeginDeleteOptions contains the optional parameters for the VPNSitesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSiteDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNSitesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<vpn-site-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VPNSitesClient) Get 

func (client *VPNSitesClient) Get(ctx context.Context, resourceGroupName string, vpnSiteName string, options *VPNSitesClientGetOptions) (VPNSitesClientGetResponse, error)

Get - Retrieves the details of a VPN site. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnSite. vpnSiteName - The name of the VpnSite being retrieved. options - VPNSitesClientGetOptions contains the optional parameters for the VPNSitesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSiteGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNSitesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<vpn-site-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNSitesClientGetResult)
}

Output:

func (*VPNSitesClient) List 

func (client *VPNSitesClient) List(options *VPNSitesClientListOptions) *VPNSitesClientListPager

List - Lists all the VpnSites in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - VPNSitesClientListOptions contains the optional parameters for the VPNSitesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSiteList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNSitesClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VPNSitesClient) ListByResourceGroup 

func (client *VPNSitesClient) ListByResourceGroup(resourceGroupName string, options *VPNSitesClientListByResourceGroupOptions) *VPNSitesClientListByResourceGroupPager

ListByResourceGroup - Lists all the vpnSites in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnSite. options - VPNSitesClientListByResourceGroupOptions contains the optional parameters for the VPNSitesClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSiteListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNSitesClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VPNSitesClient) UpdateTags 

func (client *VPNSitesClient) UpdateTags(ctx context.Context, resourceGroupName string, vpnSiteName string, vpnSiteParameters TagsObject, options *VPNSitesClientUpdateTagsOptions) (VPNSitesClientUpdateTagsResponse, error)

UpdateTags - Updates VpnSite tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VpnSite. vpnSiteName - The name of the VpnSite being updated. vpnSiteParameters - Parameters supplied to update VpnSite tags. options - VPNSitesClientUpdateTagsOptions contains the optional parameters for the VPNSitesClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSiteUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNSitesClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<vpn-site-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
				"key2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VPNSitesClientUpdateTagsResult)
}

Output:

type VPNSitesClientBeginCreateOrUpdateOptions added in v0.3.0 

type VPNSitesClientBeginCreateOrUpdateOptions struct {
}

VPNSitesClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNSitesClient.BeginCreateOrUpdate method.

type VPNSitesClientBeginDeleteOptions added in v0.3.0 

type VPNSitesClientBeginDeleteOptions struct {
}

VPNSitesClientBeginDeleteOptions contains the optional parameters for the VPNSitesClient.BeginDelete method.

type VPNSitesClientCreateOrUpdatePoller added in v0.3.0 

type VPNSitesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VPNSitesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNSitesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VPNSitesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNSitesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VPNSitesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VPNSitesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNSitesClientCreateOrUpdateResponse will be returned.

func (*VPNSitesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VPNSitesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNSitesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VPNSitesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNSitesClientCreateOrUpdatePollerResponse added in v0.3.0 

type VPNSitesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNSitesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSitesClientCreateOrUpdatePollerResponse contains the response from method VPNSitesClient.CreateOrUpdate.

func (VPNSitesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNSitesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNSitesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNSitesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VPNSitesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VPNSitesClient, token string) error

Resume rehydrates a VPNSitesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VPNSitesClientCreateOrUpdateResponse added in v0.3.0 

type VPNSitesClientCreateOrUpdateResponse struct {
	VPNSitesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSitesClientCreateOrUpdateResponse contains the response from method VPNSitesClient.CreateOrUpdate.

type VPNSitesClientCreateOrUpdateResult added in v0.3.0 

type VPNSitesClientCreateOrUpdateResult struct {
	VPNSite
}

VPNSitesClientCreateOrUpdateResult contains the result from method VPNSitesClient.CreateOrUpdate.

type VPNSitesClientDeletePoller added in v0.3.0 

type VPNSitesClientDeletePoller struct {
	// contains filtered or unexported fields
}

VPNSitesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VPNSitesClientDeletePoller) Done added in v0.3.0 

func (p *VPNSitesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNSitesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VPNSitesClientDeletePoller) FinalResponse(ctx context.Context) (VPNSitesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNSitesClientDeleteResponse will be returned.

func (*VPNSitesClientDeletePoller) Poll added in v0.3.0 

func (p *VPNSitesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNSitesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VPNSitesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNSitesClientDeletePollerResponse added in v0.3.0 

type VPNSitesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNSitesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSitesClientDeletePollerResponse contains the response from method VPNSitesClient.Delete.

func (VPNSitesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VPNSitesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNSitesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNSitesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VPNSitesClientDeletePollerResponse) Resume(ctx context.Context, client *VPNSitesClient, token string) error

Resume rehydrates a VPNSitesClientDeletePollerResponse from the provided client and resume token.

type VPNSitesClientDeleteResponse added in v0.3.0 

type VPNSitesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSitesClientDeleteResponse contains the response from method VPNSitesClient.Delete.

type VPNSitesClientGetOptions added in v0.3.0 

type VPNSitesClientGetOptions struct {
}

VPNSitesClientGetOptions contains the optional parameters for the VPNSitesClient.Get method.

type VPNSitesClientGetResponse added in v0.3.0 

type VPNSitesClientGetResponse struct {
	VPNSitesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSitesClientGetResponse contains the response from method VPNSitesClient.Get.

type VPNSitesClientGetResult added in v0.3.0 

type VPNSitesClientGetResult struct {
	VPNSite
}

VPNSitesClientGetResult contains the result from method VPNSitesClient.Get.

type VPNSitesClientListByResourceGroupOptions added in v0.3.0 

type VPNSitesClientListByResourceGroupOptions struct {
}

VPNSitesClientListByResourceGroupOptions contains the optional parameters for the VPNSitesClient.ListByResourceGroup method.

type VPNSitesClientListByResourceGroupPager added in v0.3.0 

type VPNSitesClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

VPNSitesClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*VPNSitesClientListByResourceGroupPager) Err added in v0.3.0 

func (p *VPNSitesClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*VPNSitesClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *VPNSitesClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VPNSitesClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *VPNSitesClientListByResourceGroupPager) PageResponse() VPNSitesClientListByResourceGroupResponse

PageResponse returns the current VPNSitesClientListByResourceGroupResponse page.

type VPNSitesClientListByResourceGroupResponse added in v0.3.0 

type VPNSitesClientListByResourceGroupResponse struct {
	VPNSitesClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSitesClientListByResourceGroupResponse contains the response from method VPNSitesClient.ListByResourceGroup.

type VPNSitesClientListByResourceGroupResult added in v0.3.0 

type VPNSitesClientListByResourceGroupResult struct {
	ListVPNSitesResult
}

VPNSitesClientListByResourceGroupResult contains the result from method VPNSitesClient.ListByResourceGroup.

type VPNSitesClientListOptions added in v0.3.0 

type VPNSitesClientListOptions struct {
}

VPNSitesClientListOptions contains the optional parameters for the VPNSitesClient.List method.

type VPNSitesClientListPager added in v0.3.0 

type VPNSitesClientListPager struct {
	// contains filtered or unexported fields
}

VPNSitesClientListPager provides operations for iterating over paged responses.

func (*VPNSitesClientListPager) Err added in v0.3.0 

func (p *VPNSitesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VPNSitesClientListPager) NextPage added in v0.3.0 

func (p *VPNSitesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VPNSitesClientListPager) PageResponse added in v0.3.0 

func (p *VPNSitesClientListPager) PageResponse() VPNSitesClientListResponse

PageResponse returns the current VPNSitesClientListResponse page.

type VPNSitesClientListResponse added in v0.3.0 

type VPNSitesClientListResponse struct {
	VPNSitesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSitesClientListResponse contains the response from method VPNSitesClient.List.

type VPNSitesClientListResult added in v0.3.0 

type VPNSitesClientListResult struct {
	ListVPNSitesResult
}

VPNSitesClientListResult contains the result from method VPNSitesClient.List.

type VPNSitesClientUpdateTagsOptions added in v0.3.0 

type VPNSitesClientUpdateTagsOptions struct {
}

VPNSitesClientUpdateTagsOptions contains the optional parameters for the VPNSitesClient.UpdateTags method.

type VPNSitesClientUpdateTagsResponse added in v0.3.0 

type VPNSitesClientUpdateTagsResponse struct {
	VPNSitesClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSitesClientUpdateTagsResponse contains the response from method VPNSitesClient.UpdateTags.

type VPNSitesClientUpdateTagsResult added in v0.3.0 

type VPNSitesClientUpdateTagsResult struct {
	VPNSite
}

VPNSitesClientUpdateTagsResult contains the result from method VPNSitesClient.UpdateTags.

type VPNSitesConfigurationClient 

type VPNSitesConfigurationClient struct {
	// contains filtered or unexported fields
}

VPNSitesConfigurationClient contains the methods for the VPNSitesConfiguration group. Don't use this type directly, use NewVPNSitesConfigurationClient() instead.

func NewVPNSitesConfigurationClient 

func NewVPNSitesConfigurationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VPNSitesConfigurationClient

NewVPNSitesConfigurationClient creates a new instance of VPNSitesConfigurationClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VPNSitesConfigurationClient) BeginDownload 

func (client *VPNSitesConfigurationClient) BeginDownload(ctx context.Context, resourceGroupName string, virtualWANName string, request GetVPNSitesConfigurationRequest, options *VPNSitesConfigurationClientBeginDownloadOptions) (VPNSitesConfigurationClientDownloadPollerResponse, error)

BeginDownload - Gives the sas-url to download the configurations for vpn-sites in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name. virtualWANName - The name of the VirtualWAN for which configuration of all vpn-sites is needed. request - Parameters supplied to download vpn-sites configuration. options - VPNSitesConfigurationClientBeginDownloadOptions contains the optional parameters for the VPNSitesConfigurationClient.BeginDownload method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VpnSitesConfigurationDownload.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVPNSitesConfigurationClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDownload(ctx,
		"<resource-group-name>",
		"<virtual-wanname>",
		armnetwork.GetVPNSitesConfigurationRequest{
			OutputBlobSasURL: to.StringPtr("<output-blob-sas-url>"),
			VPNSites: []*string{
				to.StringPtr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/abc")},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type VPNSitesConfigurationClientBeginDownloadOptions added in v0.3.0 

type VPNSitesConfigurationClientBeginDownloadOptions struct {
}

VPNSitesConfigurationClientBeginDownloadOptions contains the optional parameters for the VPNSitesConfigurationClient.BeginDownload method.

type VPNSitesConfigurationClientDownloadPoller added in v0.3.0 

type VPNSitesConfigurationClientDownloadPoller struct {
	// contains filtered or unexported fields
}

VPNSitesConfigurationClientDownloadPoller provides polling facilities until the operation reaches a terminal state.

func (*VPNSitesConfigurationClientDownloadPoller) Done added in v0.3.0 

func (p *VPNSitesConfigurationClientDownloadPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VPNSitesConfigurationClientDownloadPoller) FinalResponse added in v0.3.0 

func (p *VPNSitesConfigurationClientDownloadPoller) FinalResponse(ctx context.Context) (VPNSitesConfigurationClientDownloadResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VPNSitesConfigurationClientDownloadResponse will be returned.

func (*VPNSitesConfigurationClientDownloadPoller) Poll added in v0.3.0 

func (p *VPNSitesConfigurationClientDownloadPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VPNSitesConfigurationClientDownloadPoller) ResumeToken added in v0.3.0 

func (p *VPNSitesConfigurationClientDownloadPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VPNSitesConfigurationClientDownloadPollerResponse added in v0.3.0 

type VPNSitesConfigurationClientDownloadPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VPNSitesConfigurationClientDownloadPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSitesConfigurationClientDownloadPollerResponse contains the response from method VPNSitesConfigurationClient.Download.

func (VPNSitesConfigurationClientDownloadPollerResponse) PollUntilDone added in v0.3.0 

func (l VPNSitesConfigurationClientDownloadPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VPNSitesConfigurationClientDownloadResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VPNSitesConfigurationClientDownloadPollerResponse) Resume added in v0.3.0 

func (l *VPNSitesConfigurationClientDownloadPollerResponse) Resume(ctx context.Context, client *VPNSitesConfigurationClient, token string) error

Resume rehydrates a VPNSitesConfigurationClientDownloadPollerResponse from the provided client and resume token.

type VPNSitesConfigurationClientDownloadResponse added in v0.3.0 

type VPNSitesConfigurationClientDownloadResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VPNSitesConfigurationClientDownloadResponse contains the response from method VPNSitesConfigurationClient.Download.

type VPNType 

type VPNType string

VPNType - The type of this virtual network gateway. 

const (
	VPNTypePolicyBased VPNType = "PolicyBased"
	VPNTypeRouteBased  VPNType = "RouteBased"
)

func PossibleVPNTypeValues 

func PossibleVPNTypeValues() []VPNType

PossibleVPNTypeValues returns the possible values for the VPNType const type.

func (VPNType) ToPtr 

func (c VPNType) ToPtr() *VPNType

ToPtr returns a *VPNType pointing to the current value.

type VerbosityLevel 

type VerbosityLevel string

VerbosityLevel - Verbosity level. 

const (
	VerbosityLevelFull    VerbosityLevel = "Full"
	VerbosityLevelMinimum VerbosityLevel = "Minimum"
	VerbosityLevelNormal  VerbosityLevel = "Normal"
)

func PossibleVerbosityLevelValues 

func PossibleVerbosityLevelValues() []VerbosityLevel

PossibleVerbosityLevelValues returns the possible values for the VerbosityLevel const type.

func (VerbosityLevel) ToPtr 

func (c VerbosityLevel) ToPtr() *VerbosityLevel

ToPtr returns a *VerbosityLevel pointing to the current value.

type VerificationIPFlowParameters 

type VerificationIPFlowParameters struct {
	// REQUIRED; The direction of the packet represented as a 5-tuple.
	Direction *Direction `json:"direction,omitempty"`

	// REQUIRED; The local IP address. Acceptable values are valid IPv4 addresses.
	LocalIPAddress *string `json:"localIPAddress,omitempty"`

	// REQUIRED; The local port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port,
	// which depends on the direction.
	LocalPort *string `json:"localPort,omitempty"`

	// REQUIRED; Protocol to be verified on.
	Protocol *IPFlowProtocol `json:"protocol,omitempty"`

	// REQUIRED; The remote IP address. Acceptable values are valid IPv4 addresses.
	RemoteIPAddress *string `json:"remoteIPAddress,omitempty"`

	// REQUIRED; The remote port. Acceptable values are a single integer in the range (0-65535). Support for * for the source
	// port, which depends on the direction.
	RemotePort *string `json:"remotePort,omitempty"`

	// REQUIRED; The ID of the target resource to perform next-hop on.
	TargetResourceID *string `json:"targetResourceId,omitempty"`

	// The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of them, then this parameter must be specified.
	// Otherwise optional).
	TargetNicResourceID *string `json:"targetNicResourceId,omitempty"`
}

VerificationIPFlowParameters - Parameters that define the IP flow to be verified.

type VerificationIPFlowResult 

type VerificationIPFlowResult struct {
	// Indicates whether the traffic is allowed or denied.
	Access *Access `json:"access,omitempty"`

	// Name of the rule. If input is not matched against any security rule, it is not displayed.
	RuleName *string `json:"ruleName,omitempty"`
}

VerificationIPFlowResult - Results of IP flow verification on the target resource.

type VirtualAppliance added in v0.3.0 

type VirtualAppliance struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// The service principal that has read access to cloud-init and config blob.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the Network Virtual Appliance.
	Properties *VirtualAppliancePropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualAppliance - NetworkVirtualAppliance Resource.

func (VirtualAppliance) MarshalJSON added in v0.3.0 

func (v VirtualAppliance) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualAppliance.

type VirtualApplianceListResult added in v0.3.0 

type VirtualApplianceListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Network Virtual Appliances.
	Value []*VirtualAppliance `json:"value,omitempty"`
}

VirtualApplianceListResult - Response for ListNetworkVirtualAppliances API service call.

func (VirtualApplianceListResult) MarshalJSON added in v0.3.0 

func (v VirtualApplianceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceListResult.

type VirtualApplianceNicProperties 

type VirtualApplianceNicProperties struct {
	// READ-ONLY; NIC name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Private IP address.
	PrivateIPAddress *string `json:"privateIpAddress,omitempty" azure:"ro"`

	// READ-ONLY; Public IP address.
	PublicIPAddress *string `json:"publicIpAddress,omitempty" azure:"ro"`
}

VirtualApplianceNicProperties - Network Virtual Appliance NIC properties.

type VirtualAppliancePropertiesFormat added in v0.3.0 

type VirtualAppliancePropertiesFormat struct {
	// BootStrapConfigurationBlobs storage URLs.
	BootStrapConfigurationBlobs []*string `json:"bootStrapConfigurationBlobs,omitempty"`

	// CloudInitConfiguration string in plain text.
	CloudInitConfiguration *string `json:"cloudInitConfiguration,omitempty"`

	// CloudInitConfigurationBlob storage URLs.
	CloudInitConfigurationBlobs []*string `json:"cloudInitConfigurationBlobs,omitempty"`

	// Network Virtual Appliance SKU.
	NvaSKU *VirtualApplianceSKUProperties `json:"nvaSku,omitempty"`

	// Public key for SSH login.
	SSHPublicKey *string `json:"sshPublicKey,omitempty"`

	// VirtualAppliance ASN.
	VirtualApplianceAsn *int64 `json:"virtualApplianceAsn,omitempty"`

	// The Virtual Hub where Network Virtual Appliance is being deployed.
	VirtualHub *SubResource `json:"virtualHub,omitempty"`

	// READ-ONLY; Address Prefix.
	AddressPrefix *string `json:"addressPrefix,omitempty" azure:"ro"`

	// READ-ONLY; List of references to InboundSecurityRules.
	InboundSecurityRules []*SubResource `json:"inboundSecurityRules,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; List of Virtual Appliance Network Interfaces.
	VirtualApplianceNics []*VirtualApplianceNicProperties `json:"virtualApplianceNics,omitempty" azure:"ro"`

	// READ-ONLY; List of references to VirtualApplianceSite.
	VirtualApplianceSites []*SubResource `json:"virtualApplianceSites,omitempty" azure:"ro"`
}

VirtualAppliancePropertiesFormat - Network Virtual Appliance definition.

func (VirtualAppliancePropertiesFormat) MarshalJSON added in v0.3.0 

func (v VirtualAppliancePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualAppliancePropertiesFormat.

type VirtualApplianceSKU added in v0.3.0 

type VirtualApplianceSKU struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// NetworkVirtualApplianceSku properties.
	Properties *VirtualApplianceSKUPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualApplianceSKU - Definition of the NetworkVirtualApplianceSkus resource.

func (VirtualApplianceSKU) MarshalJSON added in v0.3.0 

func (v VirtualApplianceSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSKU.

type VirtualApplianceSKUInstances added in v0.3.0 

type VirtualApplianceSKUInstances struct {
	// READ-ONLY; Instance Count.
	InstanceCount *int32 `json:"instanceCount,omitempty" azure:"ro"`

	// READ-ONLY; Scale Unit.
	ScaleUnit *string `json:"scaleUnit,omitempty" azure:"ro"`
}

VirtualApplianceSKUInstances - List of available Sku and instances.

type VirtualApplianceSKUListResult added in v0.3.0 

type VirtualApplianceSKUListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Network Virtual Appliance Skus that are available.
	Value []*VirtualApplianceSKU `json:"value,omitempty"`
}

VirtualApplianceSKUListResult - Response for ListNetworkVirtualApplianceSkus API service call.

func (VirtualApplianceSKUListResult) MarshalJSON added in v0.3.0 

func (v VirtualApplianceSKUListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSKUListResult.

type VirtualApplianceSKUProperties 

type VirtualApplianceSKUProperties struct {
	// Virtual Appliance Scale Unit.
	BundledScaleUnit *string `json:"bundledScaleUnit,omitempty"`

	// Virtual Appliance Version.
	MarketPlaceVersion *string `json:"marketPlaceVersion,omitempty"`

	// Virtual Appliance Vendor.
	Vendor *string `json:"vendor,omitempty"`
}

VirtualApplianceSKUProperties - Network Virtual Appliance Sku Properties.

type VirtualApplianceSKUPropertiesFormat added in v0.3.0 

type VirtualApplianceSKUPropertiesFormat struct {
	// The list of scale units available.
	AvailableScaleUnits []*VirtualApplianceSKUInstances `json:"availableScaleUnits,omitempty"`

	// READ-ONLY; Available Network Virtual Appliance versions.
	AvailableVersions []*string `json:"availableVersions,omitempty" azure:"ro"`

	// READ-ONLY; Network Virtual Appliance Sku vendor.
	Vendor *string `json:"vendor,omitempty" azure:"ro"`
}

VirtualApplianceSKUPropertiesFormat - Properties specific to NetworkVirtualApplianceSkus.

func (VirtualApplianceSKUPropertiesFormat) MarshalJSON added in v0.3.0 

func (v VirtualApplianceSKUPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSKUPropertiesFormat.

type VirtualApplianceSKUsClient 

type VirtualApplianceSKUsClient struct {
	// contains filtered or unexported fields
}

VirtualApplianceSKUsClient contains the methods for the VirtualApplianceSKUs group. Don't use this type directly, use NewVirtualApplianceSKUsClient() instead.

func NewVirtualApplianceSKUsClient 

func NewVirtualApplianceSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualApplianceSKUsClient

NewVirtualApplianceSKUsClient creates a new instance of VirtualApplianceSKUsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualApplianceSKUsClient) Get 

func (client *VirtualApplianceSKUsClient) Get(ctx context.Context, skuName string, options *VirtualApplianceSKUsClientGetOptions) (VirtualApplianceSKUsClientGetResponse, error)

Get - Retrieves a single available sku for network virtual appliance. If the operation fails it returns an *azcore.ResponseError type. skuName - Name of the Sku. options - VirtualApplianceSKUsClientGetOptions contains the optional parameters for the VirtualApplianceSKUsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceSkuGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualApplianceSKUsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<sku-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualApplianceSKUsClientGetResult)
}

Output:

func (*VirtualApplianceSKUsClient) List 

func (client *VirtualApplianceSKUsClient) List(options *VirtualApplianceSKUsClientListOptions) *VirtualApplianceSKUsClientListPager

List - List all SKUs available for a virtual appliance. If the operation fails it returns an *azcore.ResponseError type. options - VirtualApplianceSKUsClientListOptions contains the optional parameters for the VirtualApplianceSKUsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceSkuList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualApplianceSKUsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VirtualApplianceSKUsClientGetOptions added in v0.3.0 

type VirtualApplianceSKUsClientGetOptions struct {
}

VirtualApplianceSKUsClientGetOptions contains the optional parameters for the VirtualApplianceSKUsClient.Get method.

type VirtualApplianceSKUsClientGetResponse added in v0.3.0 

type VirtualApplianceSKUsClientGetResponse struct {
	VirtualApplianceSKUsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualApplianceSKUsClientGetResponse contains the response from method VirtualApplianceSKUsClient.Get.

type VirtualApplianceSKUsClientGetResult added in v0.3.0 

type VirtualApplianceSKUsClientGetResult struct {
	VirtualApplianceSKU
}

VirtualApplianceSKUsClientGetResult contains the result from method VirtualApplianceSKUsClient.Get.

type VirtualApplianceSKUsClientListOptions added in v0.3.0 

type VirtualApplianceSKUsClientListOptions struct {
}

VirtualApplianceSKUsClientListOptions contains the optional parameters for the VirtualApplianceSKUsClient.List method.

type VirtualApplianceSKUsClientListPager added in v0.3.0 

type VirtualApplianceSKUsClientListPager struct {
	// contains filtered or unexported fields
}

VirtualApplianceSKUsClientListPager provides operations for iterating over paged responses.

func (*VirtualApplianceSKUsClientListPager) Err added in v0.3.0 

func (p *VirtualApplianceSKUsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualApplianceSKUsClientListPager) NextPage added in v0.3.0 

func (p *VirtualApplianceSKUsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualApplianceSKUsClientListPager) PageResponse added in v0.3.0 

func (p *VirtualApplianceSKUsClientListPager) PageResponse() VirtualApplianceSKUsClientListResponse

PageResponse returns the current VirtualApplianceSKUsClientListResponse page.

type VirtualApplianceSKUsClientListResponse added in v0.3.0 

type VirtualApplianceSKUsClientListResponse struct {
	VirtualApplianceSKUsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualApplianceSKUsClientListResponse contains the response from method VirtualApplianceSKUsClient.List.

type VirtualApplianceSKUsClientListResult added in v0.3.0 

type VirtualApplianceSKUsClientListResult struct {
	VirtualApplianceSKUListResult
}

VirtualApplianceSKUsClientListResult contains the result from method VirtualApplianceSKUsClient.List.

type VirtualApplianceSite 

type VirtualApplianceSite struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the virtual appliance site.
	Name *string `json:"name,omitempty"`

	// The properties of the Virtual Appliance Sites.
	Properties *VirtualApplianceSiteProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Site type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualApplianceSite - Virtual Appliance Site resource.

type VirtualApplianceSiteListResult added in v0.3.0 

type VirtualApplianceSiteListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Network Virtual Appliance sites.
	Value []*VirtualApplianceSite `json:"value,omitempty"`
}

VirtualApplianceSiteListResult - Response for ListNetworkVirtualApplianceSites API service call.

func (VirtualApplianceSiteListResult) MarshalJSON added in v0.3.0 

func (v VirtualApplianceSiteListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSiteListResult.

type VirtualApplianceSiteProperties 

type VirtualApplianceSiteProperties struct {
	// Address Prefix.
	AddressPrefix *string `json:"addressPrefix,omitempty"`

	// Office 365 Policy.
	O365Policy *Office365PolicyProperties `json:"o365Policy,omitempty"`

	// READ-ONLY; The provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VirtualApplianceSiteProperties - Properties of the rule group.

type VirtualApplianceSitesClient 

type VirtualApplianceSitesClient struct {
	// contains filtered or unexported fields
}

VirtualApplianceSitesClient contains the methods for the VirtualApplianceSites group. Don't use this type directly, use NewVirtualApplianceSitesClient() instead.

func NewVirtualApplianceSitesClient 

func NewVirtualApplianceSitesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualApplianceSitesClient

NewVirtualApplianceSitesClient creates a new instance of VirtualApplianceSitesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualApplianceSitesClient) BeginCreateOrUpdate 

func (client *VirtualApplianceSitesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, siteName string, parameters VirtualApplianceSite, options *VirtualApplianceSitesClientBeginCreateOrUpdateOptions) (VirtualApplianceSitesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified Network Virtual Appliance Site. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkVirtualApplianceName - The name of the Network Virtual Appliance. siteName - The name of the site. parameters - Parameters supplied to the create or update Network Virtual Appliance Site operation. options - VirtualApplianceSitesClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualApplianceSitesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceSitePut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualApplianceSitesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-virtual-appliance-name>",
		"<site-name>",
		armnetwork.VirtualApplianceSite{
			Properties: &armnetwork.VirtualApplianceSiteProperties{
				AddressPrefix: to.StringPtr("<address-prefix>"),
				O365Policy: &armnetwork.Office365PolicyProperties{
					BreakOutCategories: &armnetwork.BreakOutCategoryPolicies{
						Default:  to.BoolPtr(true),
						Allow:    to.BoolPtr(true),
						Optimize: to.BoolPtr(true),
					},
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualApplianceSitesClientCreateOrUpdateResult)
}

Output:

func (*VirtualApplianceSitesClient) BeginDelete 

func (client *VirtualApplianceSitesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, siteName string, options *VirtualApplianceSitesClientBeginDeleteOptions) (VirtualApplianceSitesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified site from a Virtual Appliance. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkVirtualApplianceName - The name of the Network Virtual Appliance. siteName - The name of the site. options - VirtualApplianceSitesClientBeginDeleteOptions contains the optional parameters for the VirtualApplianceSitesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceSiteDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualApplianceSitesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-virtual-appliance-name>",
		"<site-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualApplianceSitesClient) Get 

func (client *VirtualApplianceSitesClient) Get(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, siteName string, options *VirtualApplianceSitesClientGetOptions) (VirtualApplianceSitesClientGetResponse, error)

Get - Gets the specified Virtual Appliance Site. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkVirtualApplianceName - The name of the Network Virtual Appliance. siteName - The name of the site. options - VirtualApplianceSitesClientGetOptions contains the optional parameters for the VirtualApplianceSitesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceSiteGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualApplianceSitesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-virtual-appliance-name>",
		"<site-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualApplianceSitesClientGetResult)
}

Output:

func (*VirtualApplianceSitesClient) List 

func (client *VirtualApplianceSitesClient) List(resourceGroupName string, networkVirtualApplianceName string, options *VirtualApplianceSitesClientListOptions) *VirtualApplianceSitesClientListPager

List - Lists all Network Virtual Appliance Sites in a Network Virtual Appliance resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkVirtualApplianceName - The name of the Network Virtual Appliance. options - VirtualApplianceSitesClientListOptions contains the optional parameters for the VirtualApplianceSitesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceSiteList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualApplianceSitesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<network-virtual-appliance-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VirtualApplianceSitesClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualApplianceSitesClientBeginCreateOrUpdateOptions struct {
}

VirtualApplianceSitesClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualApplianceSitesClient.BeginCreateOrUpdate method.

type VirtualApplianceSitesClientBeginDeleteOptions added in v0.3.0 

type VirtualApplianceSitesClientBeginDeleteOptions struct {
}

VirtualApplianceSitesClientBeginDeleteOptions contains the optional parameters for the VirtualApplianceSitesClient.BeginDelete method.

type VirtualApplianceSitesClientCreateOrUpdatePoller added in v0.3.0 

type VirtualApplianceSitesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualApplianceSitesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualApplianceSitesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualApplianceSitesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualApplianceSitesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualApplianceSitesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualApplianceSitesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualApplianceSitesClientCreateOrUpdateResponse will be returned.

func (*VirtualApplianceSitesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualApplianceSitesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualApplianceSitesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualApplianceSitesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualApplianceSitesClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualApplianceSitesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualApplianceSitesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualApplianceSitesClientCreateOrUpdatePollerResponse contains the response from method VirtualApplianceSitesClient.CreateOrUpdate.

func (VirtualApplianceSitesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualApplianceSitesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualApplianceSitesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualApplianceSitesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualApplianceSitesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualApplianceSitesClient, token string) error

Resume rehydrates a VirtualApplianceSitesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualApplianceSitesClientCreateOrUpdateResponse added in v0.3.0 

type VirtualApplianceSitesClientCreateOrUpdateResponse struct {
	VirtualApplianceSitesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualApplianceSitesClientCreateOrUpdateResponse contains the response from method VirtualApplianceSitesClient.CreateOrUpdate.

type VirtualApplianceSitesClientCreateOrUpdateResult added in v0.3.0 

type VirtualApplianceSitesClientCreateOrUpdateResult struct {
	VirtualApplianceSite
}

VirtualApplianceSitesClientCreateOrUpdateResult contains the result from method VirtualApplianceSitesClient.CreateOrUpdate.

type VirtualApplianceSitesClientDeletePoller added in v0.3.0 

type VirtualApplianceSitesClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualApplianceSitesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualApplianceSitesClientDeletePoller) Done added in v0.3.0 

func (p *VirtualApplianceSitesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualApplianceSitesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualApplianceSitesClientDeletePoller) FinalResponse(ctx context.Context) (VirtualApplianceSitesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualApplianceSitesClientDeleteResponse will be returned.

func (*VirtualApplianceSitesClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualApplianceSitesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualApplianceSitesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualApplianceSitesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualApplianceSitesClientDeletePollerResponse added in v0.3.0 

type VirtualApplianceSitesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualApplianceSitesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualApplianceSitesClientDeletePollerResponse contains the response from method VirtualApplianceSitesClient.Delete.

func (VirtualApplianceSitesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualApplianceSitesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualApplianceSitesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualApplianceSitesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualApplianceSitesClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualApplianceSitesClient, token string) error

Resume rehydrates a VirtualApplianceSitesClientDeletePollerResponse from the provided client and resume token.

type VirtualApplianceSitesClientDeleteResponse added in v0.3.0 

type VirtualApplianceSitesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualApplianceSitesClientDeleteResponse contains the response from method VirtualApplianceSitesClient.Delete.

type VirtualApplianceSitesClientGetOptions added in v0.3.0 

type VirtualApplianceSitesClientGetOptions struct {
}

VirtualApplianceSitesClientGetOptions contains the optional parameters for the VirtualApplianceSitesClient.Get method.

type VirtualApplianceSitesClientGetResponse added in v0.3.0 

type VirtualApplianceSitesClientGetResponse struct {
	VirtualApplianceSitesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualApplianceSitesClientGetResponse contains the response from method VirtualApplianceSitesClient.Get.

type VirtualApplianceSitesClientGetResult added in v0.3.0 

type VirtualApplianceSitesClientGetResult struct {
	VirtualApplianceSite
}

VirtualApplianceSitesClientGetResult contains the result from method VirtualApplianceSitesClient.Get.

type VirtualApplianceSitesClientListOptions added in v0.3.0 

type VirtualApplianceSitesClientListOptions struct {
}

VirtualApplianceSitesClientListOptions contains the optional parameters for the VirtualApplianceSitesClient.List method.

type VirtualApplianceSitesClientListPager added in v0.3.0 

type VirtualApplianceSitesClientListPager struct {
	// contains filtered or unexported fields
}

VirtualApplianceSitesClientListPager provides operations for iterating over paged responses.

func (*VirtualApplianceSitesClientListPager) Err added in v0.3.0 

func (p *VirtualApplianceSitesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualApplianceSitesClientListPager) NextPage added in v0.3.0 

func (p *VirtualApplianceSitesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualApplianceSitesClientListPager) PageResponse added in v0.3.0 

func (p *VirtualApplianceSitesClientListPager) PageResponse() VirtualApplianceSitesClientListResponse

PageResponse returns the current VirtualApplianceSitesClientListResponse page.

type VirtualApplianceSitesClientListResponse added in v0.3.0 

type VirtualApplianceSitesClientListResponse struct {
	VirtualApplianceSitesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualApplianceSitesClientListResponse contains the response from method VirtualApplianceSitesClient.List.

type VirtualApplianceSitesClientListResult added in v0.3.0 

type VirtualApplianceSitesClientListResult struct {
	VirtualApplianceSiteListResult
}

VirtualApplianceSitesClientListResult contains the result from method VirtualApplianceSitesClient.List.

type VirtualAppliancesClient added in v0.3.0 

type VirtualAppliancesClient struct {
	// contains filtered or unexported fields
}

VirtualAppliancesClient contains the methods for the NetworkVirtualAppliances group. Don't use this type directly, use NewVirtualAppliancesClient() instead.

func NewVirtualAppliancesClient added in v0.3.0 

func NewVirtualAppliancesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualAppliancesClient

NewVirtualAppliancesClient creates a new instance of VirtualAppliancesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualAppliancesClient) BeginCreateOrUpdate added in v0.3.0 

func (client *VirtualAppliancesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, parameters VirtualAppliance, options *VirtualAppliancesClientBeginCreateOrUpdateOptions) (VirtualAppliancesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified Network Virtual Appliance. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkVirtualApplianceName - The name of Network Virtual Appliance. parameters - Parameters supplied to the create or update Network Virtual Appliance. options - VirtualAppliancesClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualAppliancesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualAppliancePut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualAppliancesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-virtual-appliance-name>",
		armnetwork.VirtualAppliance{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Identity: &armnetwork.ManagedServiceIdentity{
				Type: armnetwork.ResourceIdentityTypeUserAssigned.ToPtr(),
				UserAssignedIdentities: map[string]*armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
					"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {},
				},
			},
			Properties: &armnetwork.VirtualAppliancePropertiesFormat{
				BootStrapConfigurationBlobs: []*string{
					to.StringPtr("https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig")},
				CloudInitConfigurationBlobs: []*string{
					to.StringPtr("https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig")},
				NvaSKU: &armnetwork.VirtualApplianceSKUProperties{
					BundledScaleUnit:   to.StringPtr("<bundled-scale-unit>"),
					MarketPlaceVersion: to.StringPtr("<market-place-version>"),
					Vendor:             to.StringPtr("<vendor>"),
				},
				VirtualApplianceAsn: to.Int64Ptr(10000),
				VirtualHub: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualAppliancesClientCreateOrUpdateResult)
}

Output:

func (*VirtualAppliancesClient) BeginDelete added in v0.3.0 

func (client *VirtualAppliancesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, options *VirtualAppliancesClientBeginDeleteOptions) (VirtualAppliancesClientDeletePollerResponse, error)

BeginDelete - Deletes the specified Network Virtual Appliance. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkVirtualApplianceName - The name of Network Virtual Appliance. options - VirtualAppliancesClientBeginDeleteOptions contains the optional parameters for the VirtualAppliancesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualAppliancesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-virtual-appliance-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualAppliancesClient) Get added in v0.3.0 

func (client *VirtualAppliancesClient) Get(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, options *VirtualAppliancesClientGetOptions) (VirtualAppliancesClientGetResponse, error)

Get - Gets the specified Network Virtual Appliance. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkVirtualApplianceName - The name of Network Virtual Appliance. options - VirtualAppliancesClientGetOptions contains the optional parameters for the VirtualAppliancesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualAppliancesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-virtual-appliance-name>",
		&armnetwork.VirtualAppliancesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualAppliancesClientGetResult)
}

Output:

func (*VirtualAppliancesClient) List added in v0.3.0 

func (client *VirtualAppliancesClient) List(options *VirtualAppliancesClientListOptions) *VirtualAppliancesClientListPager

List - Gets all Network Virtual Appliances in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - VirtualAppliancesClientListOptions contains the optional parameters for the VirtualAppliancesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualAppliancesClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualAppliancesClient) ListByResourceGroup added in v0.3.0 

func (client *VirtualAppliancesClient) ListByResourceGroup(resourceGroupName string, options *VirtualAppliancesClientListByResourceGroupOptions) *VirtualAppliancesClientListByResourceGroupPager

ListByResourceGroup - Lists all Network Virtual Appliances in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - VirtualAppliancesClientListByResourceGroupOptions contains the optional parameters for the VirtualAppliancesClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualAppliancesClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualAppliancesClient) UpdateTags added in v0.3.0 

func (client *VirtualAppliancesClient) UpdateTags(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, parameters TagsObject, options *VirtualAppliancesClientUpdateTagsOptions) (VirtualAppliancesClientUpdateTagsResponse, error)

UpdateTags - Updates a Network Virtual Appliance. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of Network Virtual Appliance. networkVirtualApplianceName - The name of Network Virtual Appliance being updated. parameters - Parameters supplied to Update Network Virtual Appliance Tags. options - VirtualAppliancesClientUpdateTagsOptions contains the optional parameters for the VirtualAppliancesClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkVirtualApplianceUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualAppliancesClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<network-virtual-appliance-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
				"key2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualAppliancesClientUpdateTagsResult)
}

Output:

type VirtualAppliancesClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualAppliancesClientBeginCreateOrUpdateOptions struct {
}

VirtualAppliancesClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualAppliancesClient.BeginCreateOrUpdate method.

type VirtualAppliancesClientBeginDeleteOptions added in v0.3.0 

type VirtualAppliancesClientBeginDeleteOptions struct {
}

VirtualAppliancesClientBeginDeleteOptions contains the optional parameters for the VirtualAppliancesClient.BeginDelete method.

type VirtualAppliancesClientCreateOrUpdatePoller added in v0.3.0 

type VirtualAppliancesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualAppliancesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualAppliancesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualAppliancesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualAppliancesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualAppliancesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualAppliancesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualAppliancesClientCreateOrUpdateResponse will be returned.

func (*VirtualAppliancesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualAppliancesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualAppliancesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualAppliancesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualAppliancesClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualAppliancesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualAppliancesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualAppliancesClientCreateOrUpdatePollerResponse contains the response from method VirtualAppliancesClient.CreateOrUpdate.

func (VirtualAppliancesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualAppliancesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualAppliancesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualAppliancesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualAppliancesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualAppliancesClient, token string) error

Resume rehydrates a VirtualAppliancesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualAppliancesClientCreateOrUpdateResponse added in v0.3.0 

type VirtualAppliancesClientCreateOrUpdateResponse struct {
	VirtualAppliancesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualAppliancesClientCreateOrUpdateResponse contains the response from method VirtualAppliancesClient.CreateOrUpdate.

type VirtualAppliancesClientCreateOrUpdateResult added in v0.3.0 

type VirtualAppliancesClientCreateOrUpdateResult struct {
	VirtualAppliance
}

VirtualAppliancesClientCreateOrUpdateResult contains the result from method VirtualAppliancesClient.CreateOrUpdate.

type VirtualAppliancesClientDeletePoller added in v0.3.0 

type VirtualAppliancesClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualAppliancesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualAppliancesClientDeletePoller) Done added in v0.3.0 

func (p *VirtualAppliancesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualAppliancesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualAppliancesClientDeletePoller) FinalResponse(ctx context.Context) (VirtualAppliancesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualAppliancesClientDeleteResponse will be returned.

func (*VirtualAppliancesClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualAppliancesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualAppliancesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualAppliancesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualAppliancesClientDeletePollerResponse added in v0.3.0 

type VirtualAppliancesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualAppliancesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualAppliancesClientDeletePollerResponse contains the response from method VirtualAppliancesClient.Delete.

func (VirtualAppliancesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualAppliancesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualAppliancesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualAppliancesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualAppliancesClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualAppliancesClient, token string) error

Resume rehydrates a VirtualAppliancesClientDeletePollerResponse from the provided client and resume token.

type VirtualAppliancesClientDeleteResponse added in v0.3.0 

type VirtualAppliancesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualAppliancesClientDeleteResponse contains the response from method VirtualAppliancesClient.Delete.

type VirtualAppliancesClientGetOptions added in v0.3.0 

type VirtualAppliancesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

VirtualAppliancesClientGetOptions contains the optional parameters for the VirtualAppliancesClient.Get method.

type VirtualAppliancesClientGetResponse added in v0.3.0 

type VirtualAppliancesClientGetResponse struct {
	VirtualAppliancesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualAppliancesClientGetResponse contains the response from method VirtualAppliancesClient.Get.

type VirtualAppliancesClientGetResult added in v0.3.0 

type VirtualAppliancesClientGetResult struct {
	VirtualAppliance
}

VirtualAppliancesClientGetResult contains the result from method VirtualAppliancesClient.Get.

type VirtualAppliancesClientListByResourceGroupOptions added in v0.3.0 

type VirtualAppliancesClientListByResourceGroupOptions struct {
}

VirtualAppliancesClientListByResourceGroupOptions contains the optional parameters for the VirtualAppliancesClient.ListByResourceGroup method.

type VirtualAppliancesClientListByResourceGroupPager added in v0.3.0 

type VirtualAppliancesClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

VirtualAppliancesClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*VirtualAppliancesClientListByResourceGroupPager) Err added in v0.3.0 

func (p *VirtualAppliancesClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualAppliancesClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *VirtualAppliancesClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualAppliancesClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *VirtualAppliancesClientListByResourceGroupPager) PageResponse() VirtualAppliancesClientListByResourceGroupResponse

PageResponse returns the current VirtualAppliancesClientListByResourceGroupResponse page.

type VirtualAppliancesClientListByResourceGroupResponse added in v0.3.0 

type VirtualAppliancesClientListByResourceGroupResponse struct {
	VirtualAppliancesClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualAppliancesClientListByResourceGroupResponse contains the response from method VirtualAppliancesClient.ListByResourceGroup.

type VirtualAppliancesClientListByResourceGroupResult added in v0.3.0 

type VirtualAppliancesClientListByResourceGroupResult struct {
	VirtualApplianceListResult
}

VirtualAppliancesClientListByResourceGroupResult contains the result from method VirtualAppliancesClient.ListByResourceGroup.

type VirtualAppliancesClientListOptions added in v0.3.0 

type VirtualAppliancesClientListOptions struct {
}

VirtualAppliancesClientListOptions contains the optional parameters for the VirtualAppliancesClient.List method.

type VirtualAppliancesClientListPager added in v0.3.0 

type VirtualAppliancesClientListPager struct {
	// contains filtered or unexported fields
}

VirtualAppliancesClientListPager provides operations for iterating over paged responses.

func (*VirtualAppliancesClientListPager) Err added in v0.3.0 

func (p *VirtualAppliancesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualAppliancesClientListPager) NextPage added in v0.3.0 

func (p *VirtualAppliancesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualAppliancesClientListPager) PageResponse added in v0.3.0 

func (p *VirtualAppliancesClientListPager) PageResponse() VirtualAppliancesClientListResponse

PageResponse returns the current VirtualAppliancesClientListResponse page.

type VirtualAppliancesClientListResponse added in v0.3.0 

type VirtualAppliancesClientListResponse struct {
	VirtualAppliancesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualAppliancesClientListResponse contains the response from method VirtualAppliancesClient.List.

type VirtualAppliancesClientListResult added in v0.3.0 

type VirtualAppliancesClientListResult struct {
	VirtualApplianceListResult
}

VirtualAppliancesClientListResult contains the result from method VirtualAppliancesClient.List.

type VirtualAppliancesClientUpdateTagsOptions added in v0.3.0 

type VirtualAppliancesClientUpdateTagsOptions struct {
}

VirtualAppliancesClientUpdateTagsOptions contains the optional parameters for the VirtualAppliancesClient.UpdateTags method.

type VirtualAppliancesClientUpdateTagsResponse added in v0.3.0 

type VirtualAppliancesClientUpdateTagsResponse struct {
	VirtualAppliancesClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualAppliancesClientUpdateTagsResponse contains the response from method VirtualAppliancesClient.UpdateTags.

type VirtualAppliancesClientUpdateTagsResult added in v0.3.0 

type VirtualAppliancesClientUpdateTagsResult struct {
	VirtualAppliance
}

VirtualAppliancesClientUpdateTagsResult contains the result from method VirtualAppliancesClient.UpdateTags.

type VirtualHub 

type VirtualHub struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the virtual hub.
	Properties *VirtualHubProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
	Kind *string `json:"kind,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualHub Resource.

func (VirtualHub) MarshalJSON 

func (v VirtualHub) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualHub.

type VirtualHubBgpConnectionClient 

type VirtualHubBgpConnectionClient struct {
	// contains filtered or unexported fields
}

VirtualHubBgpConnectionClient contains the methods for the VirtualHubBgpConnection group. Don't use this type directly, use NewVirtualHubBgpConnectionClient() instead.

func NewVirtualHubBgpConnectionClient 

func NewVirtualHubBgpConnectionClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualHubBgpConnectionClient

NewVirtualHubBgpConnectionClient creates a new instance of VirtualHubBgpConnectionClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualHubBgpConnectionClient) BeginCreateOrUpdate 

func (client *VirtualHubBgpConnectionClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualHubName string, connectionName string, parameters BgpConnection, options *VirtualHubBgpConnectionClientBeginCreateOrUpdateOptions) (VirtualHubBgpConnectionClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. connectionName - The name of the connection. parameters - Parameters of Bgp connection. options - VirtualHubBgpConnectionClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubBgpConnectionClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubBgpConnectionPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubBgpConnectionClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<connection-name>",
		armnetwork.BgpConnection{
			Properties: &armnetwork.BgpConnectionProperties{
				HubVirtualNetworkConnection: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
				PeerAsn: to.Int64Ptr(20000),
				PeerIP:  to.StringPtr("<peer-ip>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubBgpConnectionClientCreateOrUpdateResult)
}

Output:

func (*VirtualHubBgpConnectionClient) BeginDelete 

func (client *VirtualHubBgpConnectionClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, connectionName string, options *VirtualHubBgpConnectionClientBeginDeleteOptions) (VirtualHubBgpConnectionClientDeletePollerResponse, error)

BeginDelete - Deletes a VirtualHubBgpConnection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHubBgpConnection. virtualHubName - The name of the VirtualHub. connectionName - The name of the connection. options - VirtualHubBgpConnectionClientBeginDeleteOptions contains the optional parameters for the VirtualHubBgpConnectionClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubBgpConnectionDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubBgpConnectionClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualHubBgpConnectionClient) Get 

func (client *VirtualHubBgpConnectionClient) Get(ctx context.Context, resourceGroupName string, virtualHubName string, connectionName string, options *VirtualHubBgpConnectionClientGetOptions) (VirtualHubBgpConnectionClientGetResponse, error)

Get - Retrieves the details of a Virtual Hub Bgp Connection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. connectionName - The name of the connection. options - VirtualHubBgpConnectionClientGetOptions contains the optional parameters for the VirtualHubBgpConnectionClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubBgpConnectionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubBgpConnectionClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubBgpConnectionClientGetResult)
}

Output:

type VirtualHubBgpConnectionClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualHubBgpConnectionClientBeginCreateOrUpdateOptions struct {
}

VirtualHubBgpConnectionClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubBgpConnectionClient.BeginCreateOrUpdate method.

type VirtualHubBgpConnectionClientBeginDeleteOptions added in v0.3.0 

type VirtualHubBgpConnectionClientBeginDeleteOptions struct {
}

VirtualHubBgpConnectionClientBeginDeleteOptions contains the optional parameters for the VirtualHubBgpConnectionClient.BeginDelete method.

type VirtualHubBgpConnectionClientCreateOrUpdatePoller added in v0.3.0 

type VirtualHubBgpConnectionClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualHubBgpConnectionClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubBgpConnectionClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualHubBgpConnectionClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubBgpConnectionClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualHubBgpConnectionClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualHubBgpConnectionClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubBgpConnectionClientCreateOrUpdateResponse will be returned.

func (*VirtualHubBgpConnectionClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualHubBgpConnectionClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubBgpConnectionClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualHubBgpConnectionClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubBgpConnectionClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualHubBgpConnectionClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubBgpConnectionClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubBgpConnectionClientCreateOrUpdatePollerResponse contains the response from method VirtualHubBgpConnectionClient.CreateOrUpdate.

func (VirtualHubBgpConnectionClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubBgpConnectionClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubBgpConnectionClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubBgpConnectionClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualHubBgpConnectionClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualHubBgpConnectionClient, token string) error

Resume rehydrates a VirtualHubBgpConnectionClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualHubBgpConnectionClientCreateOrUpdateResponse added in v0.3.0 

type VirtualHubBgpConnectionClientCreateOrUpdateResponse struct {
	VirtualHubBgpConnectionClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubBgpConnectionClientCreateOrUpdateResponse contains the response from method VirtualHubBgpConnectionClient.CreateOrUpdate.

type VirtualHubBgpConnectionClientCreateOrUpdateResult added in v0.3.0 

type VirtualHubBgpConnectionClientCreateOrUpdateResult struct {
	BgpConnection
}

VirtualHubBgpConnectionClientCreateOrUpdateResult contains the result from method VirtualHubBgpConnectionClient.CreateOrUpdate.

type VirtualHubBgpConnectionClientDeletePoller added in v0.3.0 

type VirtualHubBgpConnectionClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualHubBgpConnectionClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubBgpConnectionClientDeletePoller) Done added in v0.3.0 

func (p *VirtualHubBgpConnectionClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubBgpConnectionClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualHubBgpConnectionClientDeletePoller) FinalResponse(ctx context.Context) (VirtualHubBgpConnectionClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubBgpConnectionClientDeleteResponse will be returned.

func (*VirtualHubBgpConnectionClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualHubBgpConnectionClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubBgpConnectionClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualHubBgpConnectionClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubBgpConnectionClientDeletePollerResponse added in v0.3.0 

type VirtualHubBgpConnectionClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubBgpConnectionClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubBgpConnectionClientDeletePollerResponse contains the response from method VirtualHubBgpConnectionClient.Delete.

func (VirtualHubBgpConnectionClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubBgpConnectionClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubBgpConnectionClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubBgpConnectionClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualHubBgpConnectionClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualHubBgpConnectionClient, token string) error

Resume rehydrates a VirtualHubBgpConnectionClientDeletePollerResponse from the provided client and resume token.

type VirtualHubBgpConnectionClientDeleteResponse added in v0.3.0 

type VirtualHubBgpConnectionClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubBgpConnectionClientDeleteResponse contains the response from method VirtualHubBgpConnectionClient.Delete.

type VirtualHubBgpConnectionClientGetOptions added in v0.3.0 

type VirtualHubBgpConnectionClientGetOptions struct {
}

VirtualHubBgpConnectionClientGetOptions contains the optional parameters for the VirtualHubBgpConnectionClient.Get method.

type VirtualHubBgpConnectionClientGetResponse added in v0.3.0 

type VirtualHubBgpConnectionClientGetResponse struct {
	VirtualHubBgpConnectionClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubBgpConnectionClientGetResponse contains the response from method VirtualHubBgpConnectionClient.Get.

type VirtualHubBgpConnectionClientGetResult added in v0.3.0 

type VirtualHubBgpConnectionClientGetResult struct {
	BgpConnection
}

VirtualHubBgpConnectionClientGetResult contains the result from method VirtualHubBgpConnectionClient.Get.

type VirtualHubBgpConnectionsClient 

type VirtualHubBgpConnectionsClient struct {
	// contains filtered or unexported fields
}

VirtualHubBgpConnectionsClient contains the methods for the VirtualHubBgpConnections group. Don't use this type directly, use NewVirtualHubBgpConnectionsClient() instead.

func NewVirtualHubBgpConnectionsClient 

func NewVirtualHubBgpConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualHubBgpConnectionsClient

NewVirtualHubBgpConnectionsClient creates a new instance of VirtualHubBgpConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualHubBgpConnectionsClient) BeginListAdvertisedRoutes 

func (client *VirtualHubBgpConnectionsClient) BeginListAdvertisedRoutes(ctx context.Context, resourceGroupName string, hubName string, connectionName string, options *VirtualHubBgpConnectionsClientBeginListAdvertisedRoutesOptions) (VirtualHubBgpConnectionsClientListAdvertisedRoutesPollerResponse, error)

BeginListAdvertisedRoutes - Retrieves a list of routes the virtual hub bgp connection is advertising to the specified peer. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. hubName - The name of the virtual hub. connectionName - The name of the virtual hub bgp connection. options - VirtualHubBgpConnectionsClientBeginListAdvertisedRoutesOptions contains the optional parameters for the VirtualHubBgpConnectionsClient.BeginListAdvertisedRoutes method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterPeerListAdvertisedRoute.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubBgpConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListAdvertisedRoutes(ctx,
		"<resource-group-name>",
		"<hub-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubBgpConnectionsClientListAdvertisedRoutesResult)
}

Output:

func (*VirtualHubBgpConnectionsClient) BeginListLearnedRoutes 

func (client *VirtualHubBgpConnectionsClient) BeginListLearnedRoutes(ctx context.Context, resourceGroupName string, hubName string, connectionName string, options *VirtualHubBgpConnectionsClientBeginListLearnedRoutesOptions) (VirtualHubBgpConnectionsClientListLearnedRoutesPollerResponse, error)

BeginListLearnedRoutes - Retrieves a list of routes the virtual hub bgp connection has learned. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. hubName - The name of the virtual hub. connectionName - The name of the virtual hub bgp connection. options - VirtualHubBgpConnectionsClientBeginListLearnedRoutesOptions contains the optional parameters for the VirtualHubBgpConnectionsClient.BeginListLearnedRoutes method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterPeerListLearnedRoute.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubBgpConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListLearnedRoutes(ctx,
		"<resource-group-name>",
		"<hub-name>",
		"<connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubBgpConnectionsClientListLearnedRoutesResult)
}

Output:

func (*VirtualHubBgpConnectionsClient) List 

func (client *VirtualHubBgpConnectionsClient) List(resourceGroupName string, virtualHubName string, options *VirtualHubBgpConnectionsClientListOptions) *VirtualHubBgpConnectionsClientListPager

List - Retrieves the details of all VirtualHubBgpConnections. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. options - VirtualHubBgpConnectionsClientListOptions contains the optional parameters for the VirtualHubBgpConnectionsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubBgpConnectionList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubBgpConnectionsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<virtual-hub-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VirtualHubBgpConnectionsClientBeginListAdvertisedRoutesOptions added in v0.3.0 

type VirtualHubBgpConnectionsClientBeginListAdvertisedRoutesOptions struct {
}

VirtualHubBgpConnectionsClientBeginListAdvertisedRoutesOptions contains the optional parameters for the VirtualHubBgpConnectionsClient.BeginListAdvertisedRoutes method.

type VirtualHubBgpConnectionsClientBeginListLearnedRoutesOptions added in v0.3.0 

type VirtualHubBgpConnectionsClientBeginListLearnedRoutesOptions struct {
}

VirtualHubBgpConnectionsClientBeginListLearnedRoutesOptions contains the optional parameters for the VirtualHubBgpConnectionsClient.BeginListLearnedRoutes method.

type VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller added in v0.3.0 

type VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller struct {
	// contains filtered or unexported fields
}

VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller) Done added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller) FinalResponse added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller) FinalResponse(ctx context.Context) (VirtualHubBgpConnectionsClientListAdvertisedRoutesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubBgpConnectionsClientListAdvertisedRoutesResponse will be returned.

func (*VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller) Poll added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller) ResumeToken added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubBgpConnectionsClientListAdvertisedRoutesPollerResponse added in v0.3.0 

type VirtualHubBgpConnectionsClientListAdvertisedRoutesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubBgpConnectionsClientListAdvertisedRoutesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubBgpConnectionsClientListAdvertisedRoutesPollerResponse contains the response from method VirtualHubBgpConnectionsClient.ListAdvertisedRoutes.

func (VirtualHubBgpConnectionsClientListAdvertisedRoutesPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubBgpConnectionsClientListAdvertisedRoutesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubBgpConnectionsClientListAdvertisedRoutesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubBgpConnectionsClientListAdvertisedRoutesPollerResponse) Resume added in v0.3.0 

func (l *VirtualHubBgpConnectionsClientListAdvertisedRoutesPollerResponse) Resume(ctx context.Context, client *VirtualHubBgpConnectionsClient, token string) error

Resume rehydrates a VirtualHubBgpConnectionsClientListAdvertisedRoutesPollerResponse from the provided client and resume token.

type VirtualHubBgpConnectionsClientListAdvertisedRoutesResponse added in v0.3.0 

type VirtualHubBgpConnectionsClientListAdvertisedRoutesResponse struct {
	VirtualHubBgpConnectionsClientListAdvertisedRoutesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubBgpConnectionsClientListAdvertisedRoutesResponse contains the response from method VirtualHubBgpConnectionsClient.ListAdvertisedRoutes.

type VirtualHubBgpConnectionsClientListAdvertisedRoutesResult added in v0.3.0 

type VirtualHubBgpConnectionsClientListAdvertisedRoutesResult struct {
	PeerRouteList
}

VirtualHubBgpConnectionsClientListAdvertisedRoutesResult contains the result from method VirtualHubBgpConnectionsClient.ListAdvertisedRoutes.

type VirtualHubBgpConnectionsClientListLearnedRoutesPoller added in v0.3.0 

type VirtualHubBgpConnectionsClientListLearnedRoutesPoller struct {
	// contains filtered or unexported fields
}

VirtualHubBgpConnectionsClientListLearnedRoutesPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubBgpConnectionsClientListLearnedRoutesPoller) Done added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListLearnedRoutesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubBgpConnectionsClientListLearnedRoutesPoller) FinalResponse added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListLearnedRoutesPoller) FinalResponse(ctx context.Context) (VirtualHubBgpConnectionsClientListLearnedRoutesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubBgpConnectionsClientListLearnedRoutesResponse will be returned.

func (*VirtualHubBgpConnectionsClientListLearnedRoutesPoller) Poll added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListLearnedRoutesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubBgpConnectionsClientListLearnedRoutesPoller) ResumeToken added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListLearnedRoutesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubBgpConnectionsClientListLearnedRoutesPollerResponse added in v0.3.0 

type VirtualHubBgpConnectionsClientListLearnedRoutesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubBgpConnectionsClientListLearnedRoutesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubBgpConnectionsClientListLearnedRoutesPollerResponse contains the response from method VirtualHubBgpConnectionsClient.ListLearnedRoutes.

func (VirtualHubBgpConnectionsClientListLearnedRoutesPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubBgpConnectionsClientListLearnedRoutesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubBgpConnectionsClientListLearnedRoutesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubBgpConnectionsClientListLearnedRoutesPollerResponse) Resume added in v0.3.0 

func (l *VirtualHubBgpConnectionsClientListLearnedRoutesPollerResponse) Resume(ctx context.Context, client *VirtualHubBgpConnectionsClient, token string) error

Resume rehydrates a VirtualHubBgpConnectionsClientListLearnedRoutesPollerResponse from the provided client and resume token.

type VirtualHubBgpConnectionsClientListLearnedRoutesResponse added in v0.3.0 

type VirtualHubBgpConnectionsClientListLearnedRoutesResponse struct {
	VirtualHubBgpConnectionsClientListLearnedRoutesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubBgpConnectionsClientListLearnedRoutesResponse contains the response from method VirtualHubBgpConnectionsClient.ListLearnedRoutes.

type VirtualHubBgpConnectionsClientListLearnedRoutesResult added in v0.3.0 

type VirtualHubBgpConnectionsClientListLearnedRoutesResult struct {
	PeerRouteList
}

VirtualHubBgpConnectionsClientListLearnedRoutesResult contains the result from method VirtualHubBgpConnectionsClient.ListLearnedRoutes.

type VirtualHubBgpConnectionsClientListOptions added in v0.3.0 

type VirtualHubBgpConnectionsClientListOptions struct {
}

VirtualHubBgpConnectionsClientListOptions contains the optional parameters for the VirtualHubBgpConnectionsClient.List method.

type VirtualHubBgpConnectionsClientListPager added in v0.3.0 

type VirtualHubBgpConnectionsClientListPager struct {
	// contains filtered or unexported fields
}

VirtualHubBgpConnectionsClientListPager provides operations for iterating over paged responses.

func (*VirtualHubBgpConnectionsClientListPager) Err added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualHubBgpConnectionsClientListPager) NextPage added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualHubBgpConnectionsClientListPager) PageResponse added in v0.3.0 

func (p *VirtualHubBgpConnectionsClientListPager) PageResponse() VirtualHubBgpConnectionsClientListResponse

PageResponse returns the current VirtualHubBgpConnectionsClientListResponse page.

type VirtualHubBgpConnectionsClientListResponse added in v0.3.0 

type VirtualHubBgpConnectionsClientListResponse struct {
	VirtualHubBgpConnectionsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubBgpConnectionsClientListResponse contains the response from method VirtualHubBgpConnectionsClient.List.

type VirtualHubBgpConnectionsClientListResult added in v0.3.0 

type VirtualHubBgpConnectionsClientListResult struct {
	ListVirtualHubBgpConnectionResults
}

VirtualHubBgpConnectionsClientListResult contains the result from method VirtualHubBgpConnectionsClient.List.

type VirtualHubEffectiveRoute 

type VirtualHubEffectiveRoute struct {
	// The list of address prefixes.
	AddressPrefixes []*string `json:"addressPrefixes,omitempty"`

	// The ASPath of this route.
	AsPath *string `json:"asPath,omitempty"`

	// The type of the next hop.
	NextHopType *string `json:"nextHopType,omitempty"`

	// The list of next hops.
	NextHops []*string `json:"nextHops,omitempty"`

	// The origin of this route.
	RouteOrigin *string `json:"routeOrigin,omitempty"`
}

VirtualHubEffectiveRoute - The effective route configured on the virtual hub or specified resource.

func (VirtualHubEffectiveRoute) MarshalJSON 

func (v VirtualHubEffectiveRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualHubEffectiveRoute.

type VirtualHubEffectiveRouteList 

type VirtualHubEffectiveRouteList struct {
	// The list of effective routes configured on the virtual hub or the specified resource.
	Value []*VirtualHubEffectiveRoute `json:"value,omitempty"`
}

VirtualHubEffectiveRouteList - EffectiveRoutes List.

func (VirtualHubEffectiveRouteList) MarshalJSON 

func (v VirtualHubEffectiveRouteList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualHubEffectiveRouteList.

type VirtualHubID 

type VirtualHubID struct {
	// The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and
	// the ExpressRoute gateway resource reside in the same subscription.
	ID *string `json:"id,omitempty"`
}

VirtualHubID - Virtual Hub identifier.

type VirtualHubIPConfigurationClient 

type VirtualHubIPConfigurationClient struct {
	// contains filtered or unexported fields
}

VirtualHubIPConfigurationClient contains the methods for the VirtualHubIPConfiguration group. Don't use this type directly, use NewVirtualHubIPConfigurationClient() instead.

func NewVirtualHubIPConfigurationClient 

func NewVirtualHubIPConfigurationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualHubIPConfigurationClient

NewVirtualHubIPConfigurationClient creates a new instance of VirtualHubIPConfigurationClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualHubIPConfigurationClient) BeginCreateOrUpdate 

func (client *VirtualHubIPConfigurationClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualHubName string, ipConfigName string, parameters HubIPConfiguration, options *VirtualHubIPConfigurationClientBeginCreateOrUpdateOptions) (VirtualHubIPConfigurationClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. ipConfigName - The name of the ipconfig. parameters - Hub Ip Configuration parameters. options - VirtualHubIPConfigurationClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubIPConfigurationClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubIpConfigurationPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubIPConfigurationClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<ip-config-name>",
		armnetwork.HubIPConfiguration{
			Properties: &armnetwork.HubIPConfigurationPropertiesFormat{
				Subnet: &armnetwork.Subnet{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubIPConfigurationClientCreateOrUpdateResult)
}

Output:

func (*VirtualHubIPConfigurationClient) BeginDelete 

func (client *VirtualHubIPConfigurationClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, ipConfigName string, options *VirtualHubIPConfigurationClientBeginDeleteOptions) (VirtualHubIPConfigurationClientDeletePollerResponse, error)

BeginDelete - Deletes a VirtualHubIpConfiguration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHubBgpConnection. virtualHubName - The name of the VirtualHub. ipConfigName - The name of the ipconfig. options - VirtualHubIPConfigurationClientBeginDeleteOptions contains the optional parameters for the VirtualHubIPConfigurationClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubIpConfigurationDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubIPConfigurationClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<ip-config-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualHubIPConfigurationClient) Get 

func (client *VirtualHubIPConfigurationClient) Get(ctx context.Context, resourceGroupName string, virtualHubName string, ipConfigName string, options *VirtualHubIPConfigurationClientGetOptions) (VirtualHubIPConfigurationClientGetResponse, error)

Get - Retrieves the details of a Virtual Hub Ip configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. ipConfigName - The name of the ipconfig. options - VirtualHubIPConfigurationClientGetOptions contains the optional parameters for the VirtualHubIPConfigurationClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubIpConfigurationGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubIPConfigurationClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<ip-config-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubIPConfigurationClientGetResult)
}

Output:

func (*VirtualHubIPConfigurationClient) List 

func (client *VirtualHubIPConfigurationClient) List(resourceGroupName string, virtualHubName string, options *VirtualHubIPConfigurationClientListOptions) *VirtualHubIPConfigurationClientListPager

List - Retrieves the details of all VirtualHubIpConfigurations. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. options - VirtualHubIPConfigurationClientListOptions contains the optional parameters for the VirtualHubIPConfigurationClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubIpConfigurationList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubIPConfigurationClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<virtual-hub-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VirtualHubIPConfigurationClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualHubIPConfigurationClientBeginCreateOrUpdateOptions struct {
}

VirtualHubIPConfigurationClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubIPConfigurationClient.BeginCreateOrUpdate method.

type VirtualHubIPConfigurationClientBeginDeleteOptions added in v0.3.0 

type VirtualHubIPConfigurationClientBeginDeleteOptions struct {
}

VirtualHubIPConfigurationClientBeginDeleteOptions contains the optional parameters for the VirtualHubIPConfigurationClient.BeginDelete method.

type VirtualHubIPConfigurationClientCreateOrUpdatePoller added in v0.3.0 

type VirtualHubIPConfigurationClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualHubIPConfigurationClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubIPConfigurationClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualHubIPConfigurationClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubIPConfigurationClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualHubIPConfigurationClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualHubIPConfigurationClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubIPConfigurationClientCreateOrUpdateResponse will be returned.

func (*VirtualHubIPConfigurationClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualHubIPConfigurationClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubIPConfigurationClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualHubIPConfigurationClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubIPConfigurationClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualHubIPConfigurationClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubIPConfigurationClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubIPConfigurationClientCreateOrUpdatePollerResponse contains the response from method VirtualHubIPConfigurationClient.CreateOrUpdate.

func (VirtualHubIPConfigurationClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubIPConfigurationClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubIPConfigurationClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubIPConfigurationClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualHubIPConfigurationClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualHubIPConfigurationClient, token string) error

Resume rehydrates a VirtualHubIPConfigurationClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualHubIPConfigurationClientCreateOrUpdateResponse added in v0.3.0 

type VirtualHubIPConfigurationClientCreateOrUpdateResponse struct {
	VirtualHubIPConfigurationClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubIPConfigurationClientCreateOrUpdateResponse contains the response from method VirtualHubIPConfigurationClient.CreateOrUpdate.

type VirtualHubIPConfigurationClientCreateOrUpdateResult added in v0.3.0 

type VirtualHubIPConfigurationClientCreateOrUpdateResult struct {
	HubIPConfiguration
}

VirtualHubIPConfigurationClientCreateOrUpdateResult contains the result from method VirtualHubIPConfigurationClient.CreateOrUpdate.

type VirtualHubIPConfigurationClientDeletePoller added in v0.3.0 

type VirtualHubIPConfigurationClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualHubIPConfigurationClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubIPConfigurationClientDeletePoller) Done added in v0.3.0 

func (p *VirtualHubIPConfigurationClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubIPConfigurationClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualHubIPConfigurationClientDeletePoller) FinalResponse(ctx context.Context) (VirtualHubIPConfigurationClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubIPConfigurationClientDeleteResponse will be returned.

func (*VirtualHubIPConfigurationClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualHubIPConfigurationClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubIPConfigurationClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualHubIPConfigurationClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubIPConfigurationClientDeletePollerResponse added in v0.3.0 

type VirtualHubIPConfigurationClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubIPConfigurationClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubIPConfigurationClientDeletePollerResponse contains the response from method VirtualHubIPConfigurationClient.Delete.

func (VirtualHubIPConfigurationClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubIPConfigurationClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubIPConfigurationClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubIPConfigurationClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualHubIPConfigurationClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualHubIPConfigurationClient, token string) error

Resume rehydrates a VirtualHubIPConfigurationClientDeletePollerResponse from the provided client and resume token.

type VirtualHubIPConfigurationClientDeleteResponse added in v0.3.0 

type VirtualHubIPConfigurationClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubIPConfigurationClientDeleteResponse contains the response from method VirtualHubIPConfigurationClient.Delete.

type VirtualHubIPConfigurationClientGetOptions added in v0.3.0 

type VirtualHubIPConfigurationClientGetOptions struct {
}

VirtualHubIPConfigurationClientGetOptions contains the optional parameters for the VirtualHubIPConfigurationClient.Get method.

type VirtualHubIPConfigurationClientGetResponse added in v0.3.0 

type VirtualHubIPConfigurationClientGetResponse struct {
	VirtualHubIPConfigurationClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubIPConfigurationClientGetResponse contains the response from method VirtualHubIPConfigurationClient.Get.

type VirtualHubIPConfigurationClientGetResult added in v0.3.0 

type VirtualHubIPConfigurationClientGetResult struct {
	HubIPConfiguration
}

VirtualHubIPConfigurationClientGetResult contains the result from method VirtualHubIPConfigurationClient.Get.

type VirtualHubIPConfigurationClientListOptions added in v0.3.0 

type VirtualHubIPConfigurationClientListOptions struct {
}

VirtualHubIPConfigurationClientListOptions contains the optional parameters for the VirtualHubIPConfigurationClient.List method.

type VirtualHubIPConfigurationClientListPager added in v0.3.0 

type VirtualHubIPConfigurationClientListPager struct {
	// contains filtered or unexported fields
}

VirtualHubIPConfigurationClientListPager provides operations for iterating over paged responses.

func (*VirtualHubIPConfigurationClientListPager) Err added in v0.3.0 

func (p *VirtualHubIPConfigurationClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualHubIPConfigurationClientListPager) NextPage added in v0.3.0 

func (p *VirtualHubIPConfigurationClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualHubIPConfigurationClientListPager) PageResponse added in v0.3.0 

func (p *VirtualHubIPConfigurationClientListPager) PageResponse() VirtualHubIPConfigurationClientListResponse

PageResponse returns the current VirtualHubIPConfigurationClientListResponse page.

type VirtualHubIPConfigurationClientListResponse added in v0.3.0 

type VirtualHubIPConfigurationClientListResponse struct {
	VirtualHubIPConfigurationClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubIPConfigurationClientListResponse contains the response from method VirtualHubIPConfigurationClient.List.

type VirtualHubIPConfigurationClientListResult added in v0.3.0 

type VirtualHubIPConfigurationClientListResult struct {
	ListVirtualHubIPConfigurationResults
}

VirtualHubIPConfigurationClientListResult contains the result from method VirtualHubIPConfigurationClient.List.

type VirtualHubProperties 

type VirtualHubProperties struct {
	// Address-prefix for this VirtualHub.
	AddressPrefix *string `json:"addressPrefix,omitempty"`

	// Flag to control transit for VirtualRouter hub.
	AllowBranchToBranchTraffic *bool `json:"allowBranchToBranchTraffic,omitempty"`

	// The azureFirewall associated with this VirtualHub.
	AzureFirewall *SubResource `json:"azureFirewall,omitempty"`

	// The expressRouteGateway associated with this VirtualHub.
	ExpressRouteGateway *SubResource `json:"expressRouteGateway,omitempty"`

	// The P2SVpnGateway associated with this VirtualHub.
	P2SVPNGateway *SubResource `json:"p2SVpnGateway,omitempty"`

	// The preferred gateway to route on-prem traffic
	PreferredRoutingGateway *PreferredRoutingGateway `json:"preferredRoutingGateway,omitempty"`

	// The routeTable associated with this virtual hub.
	RouteTable *VirtualHubRouteTable `json:"routeTable,omitempty"`

	// The sku of this VirtualHub.
	SKU *string `json:"sku,omitempty"`

	// The securityPartnerProvider associated with this VirtualHub.
	SecurityPartnerProvider *SubResource `json:"securityPartnerProvider,omitempty"`

	// The Security Provider name.
	SecurityProviderName *string `json:"securityProviderName,omitempty"`

	// The VpnGateway associated with this VirtualHub.
	VPNGateway *SubResource `json:"vpnGateway,omitempty"`

	// List of all virtual hub route table v2s associated with this VirtualHub.
	VirtualHubRouteTableV2S []*VirtualHubRouteTableV2 `json:"virtualHubRouteTableV2s,omitempty"`

	// VirtualRouter ASN.
	VirtualRouterAsn *int64 `json:"virtualRouterAsn,omitempty"`

	// VirtualRouter IPs.
	VirtualRouterIPs []*string `json:"virtualRouterIps,omitempty"`

	// The VirtualWAN to which the VirtualHub belongs.
	VirtualWan *SubResource `json:"virtualWan,omitempty"`

	// READ-ONLY; List of references to Bgp Connections.
	BgpConnections []*SubResource `json:"bgpConnections,omitempty" azure:"ro"`

	// READ-ONLY; List of references to IpConfigurations.
	IPConfigurations []*SubResource `json:"ipConfigurations,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the virtual hub resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The routing state.
	RoutingState *RoutingState `json:"routingState,omitempty" azure:"ro"`
}

VirtualHubProperties - Parameters for VirtualHub.

func (VirtualHubProperties) MarshalJSON 

func (v VirtualHubProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualHubProperties.

type VirtualHubRoute 

type VirtualHubRoute struct {
	// List of all addressPrefixes.
	AddressPrefixes []*string `json:"addressPrefixes,omitempty"`

	// NextHop ip address.
	NextHopIPAddress *string `json:"nextHopIpAddress,omitempty"`
}

VirtualHubRoute - VirtualHub route.

func (VirtualHubRoute) MarshalJSON 

func (v VirtualHubRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualHubRoute.

type VirtualHubRouteTable 

type VirtualHubRouteTable struct {
	// List of all routes.
	Routes []*VirtualHubRoute `json:"routes,omitempty"`
}

VirtualHubRouteTable - VirtualHub route table.

func (VirtualHubRouteTable) MarshalJSON 

func (v VirtualHubRouteTable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualHubRouteTable.

type VirtualHubRouteTableV2 

type VirtualHubRouteTableV2 struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the virtual hub route table v2.
	Properties *VirtualHubRouteTableV2Properties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

VirtualHubRouteTableV2 Resource.

type VirtualHubRouteTableV2Properties 

type VirtualHubRouteTableV2Properties struct {
	// List of all connections attached to this route table v2.
	AttachedConnections []*string `json:"attachedConnections,omitempty"`

	// List of all routes.
	Routes []*VirtualHubRouteV2 `json:"routes,omitempty"`

	// READ-ONLY; The provisioning state of the virtual hub route table v2 resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VirtualHubRouteTableV2Properties - Parameters for VirtualHubRouteTableV2.

func (VirtualHubRouteTableV2Properties) MarshalJSON 

func (v VirtualHubRouteTableV2Properties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualHubRouteTableV2Properties.

type VirtualHubRouteTableV2SClient 

type VirtualHubRouteTableV2SClient struct {
	// contains filtered or unexported fields
}

VirtualHubRouteTableV2SClient contains the methods for the VirtualHubRouteTableV2S group. Don't use this type directly, use NewVirtualHubRouteTableV2SClient() instead.

func NewVirtualHubRouteTableV2SClient 

func NewVirtualHubRouteTableV2SClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualHubRouteTableV2SClient

NewVirtualHubRouteTableV2SClient creates a new instance of VirtualHubRouteTableV2SClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualHubRouteTableV2SClient) BeginCreateOrUpdate 

func (client *VirtualHubRouteTableV2SClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualHubName string, routeTableName string, virtualHubRouteTableV2Parameters VirtualHubRouteTableV2, options *VirtualHubRouteTableV2SClientBeginCreateOrUpdateOptions) (VirtualHubRouteTableV2SClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a VirtualHubRouteTableV2 resource if it doesn't exist else updates the existing VirtualHubRouteTableV2. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. routeTableName - The name of the VirtualHubRouteTableV2. virtualHubRouteTableV2Parameters - Parameters supplied to create or update VirtualHubRouteTableV2. options - VirtualHubRouteTableV2SClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubRouteTableV2Put.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubRouteTableV2SClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<route-table-name>",
		armnetwork.VirtualHubRouteTableV2{
			Properties: &armnetwork.VirtualHubRouteTableV2Properties{
				AttachedConnections: []*string{
					to.StringPtr("All_Vnets")},
				Routes: []*armnetwork.VirtualHubRouteV2{
					{
						DestinationType: to.StringPtr("<destination-type>"),
						Destinations: []*string{
							to.StringPtr("20.10.0.0/16"),
							to.StringPtr("20.20.0.0/16")},
						NextHopType: to.StringPtr("<next-hop-type>"),
						NextHops: []*string{
							to.StringPtr("10.0.0.68")},
					},
					{
						DestinationType: to.StringPtr("<destination-type>"),
						Destinations: []*string{
							to.StringPtr("0.0.0.0/0")},
						NextHopType: to.StringPtr("<next-hop-type>"),
						NextHops: []*string{
							to.StringPtr("10.0.0.68")},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubRouteTableV2SClientCreateOrUpdateResult)
}

Output:

func (*VirtualHubRouteTableV2SClient) BeginDelete 

func (client *VirtualHubRouteTableV2SClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, routeTableName string, options *VirtualHubRouteTableV2SClientBeginDeleteOptions) (VirtualHubRouteTableV2SClientDeletePollerResponse, error)

BeginDelete - Deletes a VirtualHubRouteTableV2. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHubRouteTableV2. virtualHubName - The name of the VirtualHub. routeTableName - The name of the VirtualHubRouteTableV2. options - VirtualHubRouteTableV2SClientBeginDeleteOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubRouteTableV2Delete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubRouteTableV2SClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<route-table-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualHubRouteTableV2SClient) Get 

func (client *VirtualHubRouteTableV2SClient) Get(ctx context.Context, resourceGroupName string, virtualHubName string, routeTableName string, options *VirtualHubRouteTableV2SClientGetOptions) (VirtualHubRouteTableV2SClientGetResponse, error)

Get - Retrieves the details of a VirtualHubRouteTableV2. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHubRouteTableV2. virtualHubName - The name of the VirtualHub. routeTableName - The name of the VirtualHubRouteTableV2. options - VirtualHubRouteTableV2SClientGetOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubRouteTableV2Get.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubRouteTableV2SClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		"<route-table-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubRouteTableV2SClientGetResult)
}

Output:

func (*VirtualHubRouteTableV2SClient) List 

func (client *VirtualHubRouteTableV2SClient) List(resourceGroupName string, virtualHubName string, options *VirtualHubRouteTableV2SClientListOptions) *VirtualHubRouteTableV2SClientListPager

List - Retrieves the details of all VirtualHubRouteTableV2s. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. options - VirtualHubRouteTableV2SClientListOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubRouteTableV2List.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubRouteTableV2SClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<virtual-hub-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VirtualHubRouteTableV2SClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualHubRouteTableV2SClientBeginCreateOrUpdateOptions struct {
}

VirtualHubRouteTableV2SClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.BeginCreateOrUpdate method.

type VirtualHubRouteTableV2SClientBeginDeleteOptions added in v0.3.0 

type VirtualHubRouteTableV2SClientBeginDeleteOptions struct {
}

VirtualHubRouteTableV2SClientBeginDeleteOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.BeginDelete method.

type VirtualHubRouteTableV2SClientCreateOrUpdatePoller added in v0.3.0 

type VirtualHubRouteTableV2SClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualHubRouteTableV2SClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubRouteTableV2SClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubRouteTableV2SClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualHubRouteTableV2SClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubRouteTableV2SClientCreateOrUpdateResponse will be returned.

func (*VirtualHubRouteTableV2SClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubRouteTableV2SClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubRouteTableV2SClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualHubRouteTableV2SClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubRouteTableV2SClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubRouteTableV2SClientCreateOrUpdatePollerResponse contains the response from method VirtualHubRouteTableV2SClient.CreateOrUpdate.

func (VirtualHubRouteTableV2SClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubRouteTableV2SClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubRouteTableV2SClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubRouteTableV2SClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualHubRouteTableV2SClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualHubRouteTableV2SClient, token string) error

Resume rehydrates a VirtualHubRouteTableV2SClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualHubRouteTableV2SClientCreateOrUpdateResponse added in v0.3.0 

type VirtualHubRouteTableV2SClientCreateOrUpdateResponse struct {
	VirtualHubRouteTableV2SClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubRouteTableV2SClientCreateOrUpdateResponse contains the response from method VirtualHubRouteTableV2SClient.CreateOrUpdate.

type VirtualHubRouteTableV2SClientCreateOrUpdateResult added in v0.3.0 

type VirtualHubRouteTableV2SClientCreateOrUpdateResult struct {
	VirtualHubRouteTableV2
}

VirtualHubRouteTableV2SClientCreateOrUpdateResult contains the result from method VirtualHubRouteTableV2SClient.CreateOrUpdate.

type VirtualHubRouteTableV2SClientDeletePoller added in v0.3.0 

type VirtualHubRouteTableV2SClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualHubRouteTableV2SClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubRouteTableV2SClientDeletePoller) Done added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubRouteTableV2SClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientDeletePoller) FinalResponse(ctx context.Context) (VirtualHubRouteTableV2SClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubRouteTableV2SClientDeleteResponse will be returned.

func (*VirtualHubRouteTableV2SClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubRouteTableV2SClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubRouteTableV2SClientDeletePollerResponse added in v0.3.0 

type VirtualHubRouteTableV2SClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubRouteTableV2SClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubRouteTableV2SClientDeletePollerResponse contains the response from method VirtualHubRouteTableV2SClient.Delete.

func (VirtualHubRouteTableV2SClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubRouteTableV2SClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubRouteTableV2SClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubRouteTableV2SClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualHubRouteTableV2SClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualHubRouteTableV2SClient, token string) error

Resume rehydrates a VirtualHubRouteTableV2SClientDeletePollerResponse from the provided client and resume token.

type VirtualHubRouteTableV2SClientDeleteResponse added in v0.3.0 

type VirtualHubRouteTableV2SClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubRouteTableV2SClientDeleteResponse contains the response from method VirtualHubRouteTableV2SClient.Delete.

type VirtualHubRouteTableV2SClientGetOptions added in v0.3.0 

type VirtualHubRouteTableV2SClientGetOptions struct {
}

VirtualHubRouteTableV2SClientGetOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.Get method.

type VirtualHubRouteTableV2SClientGetResponse added in v0.3.0 

type VirtualHubRouteTableV2SClientGetResponse struct {
	VirtualHubRouteTableV2SClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubRouteTableV2SClientGetResponse contains the response from method VirtualHubRouteTableV2SClient.Get.

type VirtualHubRouteTableV2SClientGetResult added in v0.3.0 

type VirtualHubRouteTableV2SClientGetResult struct {
	VirtualHubRouteTableV2
}

VirtualHubRouteTableV2SClientGetResult contains the result from method VirtualHubRouteTableV2SClient.Get.

type VirtualHubRouteTableV2SClientListOptions added in v0.3.0 

type VirtualHubRouteTableV2SClientListOptions struct {
}

VirtualHubRouteTableV2SClientListOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.List method.

type VirtualHubRouteTableV2SClientListPager added in v0.3.0 

type VirtualHubRouteTableV2SClientListPager struct {
	// contains filtered or unexported fields
}

VirtualHubRouteTableV2SClientListPager provides operations for iterating over paged responses.

func (*VirtualHubRouteTableV2SClientListPager) Err added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualHubRouteTableV2SClientListPager) NextPage added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualHubRouteTableV2SClientListPager) PageResponse added in v0.3.0 

func (p *VirtualHubRouteTableV2SClientListPager) PageResponse() VirtualHubRouteTableV2SClientListResponse

PageResponse returns the current VirtualHubRouteTableV2SClientListResponse page.

type VirtualHubRouteTableV2SClientListResponse added in v0.3.0 

type VirtualHubRouteTableV2SClientListResponse struct {
	VirtualHubRouteTableV2SClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubRouteTableV2SClientListResponse contains the response from method VirtualHubRouteTableV2SClient.List.

type VirtualHubRouteTableV2SClientListResult added in v0.3.0 

type VirtualHubRouteTableV2SClientListResult struct {
	ListVirtualHubRouteTableV2SResult
}

VirtualHubRouteTableV2SClientListResult contains the result from method VirtualHubRouteTableV2SClient.List.

type VirtualHubRouteV2 

type VirtualHubRouteV2 struct {
	// The type of destinations.
	DestinationType *string `json:"destinationType,omitempty"`

	// List of all destinations.
	Destinations []*string `json:"destinations,omitempty"`

	// The type of next hops.
	NextHopType *string `json:"nextHopType,omitempty"`

	// NextHops ip address.
	NextHops []*string `json:"nextHops,omitempty"`
}

VirtualHubRouteV2 - VirtualHubRouteTableV2 route.

func (VirtualHubRouteV2) MarshalJSON 

func (v VirtualHubRouteV2) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualHubRouteV2.

type VirtualHubsClient 

type VirtualHubsClient struct {
	// contains filtered or unexported fields
}

VirtualHubsClient contains the methods for the VirtualHubs group. Don't use this type directly, use NewVirtualHubsClient() instead.

func NewVirtualHubsClient 

func NewVirtualHubsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualHubsClient

NewVirtualHubsClient creates a new instance of VirtualHubsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualHubsClient) BeginCreateOrUpdate 

func (client *VirtualHubsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualHubName string, virtualHubParameters VirtualHub, options *VirtualHubsClientBeginCreateOrUpdateOptions) (VirtualHubsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. virtualHubParameters - Parameters supplied to create or update VirtualHub. options - VirtualHubsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		armnetwork.VirtualHub{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.VirtualHubProperties{
				AddressPrefix: to.StringPtr("<address-prefix>"),
				SKU:           to.StringPtr("<sku>"),
				VirtualWan: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubsClientCreateOrUpdateResult)
}

Output:

func (*VirtualHubsClient) BeginDelete 

func (client *VirtualHubsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, options *VirtualHubsClientBeginDeleteOptions) (VirtualHubsClientDeletePollerResponse, error)

BeginDelete - Deletes a VirtualHub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. options - VirtualHubsClientBeginDeleteOptions contains the optional parameters for the VirtualHubsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualHubsClient) BeginGetEffectiveVirtualHubRoutes 

func (client *VirtualHubsClient) BeginGetEffectiveVirtualHubRoutes(ctx context.Context, resourceGroupName string, virtualHubName string, options *VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions) (VirtualHubsClientGetEffectiveVirtualHubRoutesPollerResponse, error)

BeginGetEffectiveVirtualHubRoutes - Gets the effective routes configured for the Virtual Hub resource or the specified resource . If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. options - VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions contains the optional parameters for the VirtualHubsClient.BeginGetEffectiveVirtualHubRoutes method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/EffectiveRoutesListForConnection.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetEffectiveVirtualHubRoutes(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		&armnetwork.VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions{EffectiveRoutesParameters: &armnetwork.EffectiveRoutesParameters{
			ResourceID:             to.StringPtr("<resource-id>"),
			VirtualWanResourceType: to.StringPtr("<virtual-wan-resource-type>"),
		},
		})
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualHubsClient) Get 

func (client *VirtualHubsClient) Get(ctx context.Context, resourceGroupName string, virtualHubName string, options *VirtualHubsClientGetOptions) (VirtualHubsClientGetResponse, error)

Get - Retrieves the details of a VirtualHub. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. options - VirtualHubsClientGetOptions contains the optional parameters for the VirtualHubsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubsClientGetResult)
}

Output:

func (*VirtualHubsClient) List 

func (client *VirtualHubsClient) List(options *VirtualHubsClientListOptions) *VirtualHubsClientListPager

List - Lists all the VirtualHubs in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - VirtualHubsClientListOptions contains the optional parameters for the VirtualHubsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubsClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualHubsClient) ListByResourceGroup 

func (client *VirtualHubsClient) ListByResourceGroup(resourceGroupName string, options *VirtualHubsClientListByResourceGroupOptions) *VirtualHubsClientListByResourceGroupPager

ListByResourceGroup - Lists all the VirtualHubs in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. options - VirtualHubsClientListByResourceGroupOptions contains the optional parameters for the VirtualHubsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualHubsClient) UpdateTags 

func (client *VirtualHubsClient) UpdateTags(ctx context.Context, resourceGroupName string, virtualHubName string, virtualHubParameters TagsObject, options *VirtualHubsClientUpdateTagsOptions) (VirtualHubsClientUpdateTagsResponse, error)

UpdateTags - Updates VirtualHub tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. virtualHubParameters - Parameters supplied to update VirtualHub tags. options - VirtualHubsClientUpdateTagsOptions contains the optional parameters for the VirtualHubsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualHubUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualHubsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<virtual-hub-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
				"key2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualHubsClientUpdateTagsResult)
}

Output:

type VirtualHubsClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualHubsClientBeginCreateOrUpdateOptions struct {
}

VirtualHubsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubsClient.BeginCreateOrUpdate method.

type VirtualHubsClientBeginDeleteOptions added in v0.3.0 

type VirtualHubsClientBeginDeleteOptions struct {
}

VirtualHubsClientBeginDeleteOptions contains the optional parameters for the VirtualHubsClient.BeginDelete method.

type VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions added in v0.3.0 

type VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions struct {
	// Parameters supplied to get the effective routes for a specific resource.
	EffectiveRoutesParameters *EffectiveRoutesParameters
}

VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions contains the optional parameters for the VirtualHubsClient.BeginGetEffectiveVirtualHubRoutes method.

type VirtualHubsClientCreateOrUpdatePoller added in v0.3.0 

type VirtualHubsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualHubsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualHubsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualHubsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualHubsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubsClientCreateOrUpdateResponse will be returned.

func (*VirtualHubsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualHubsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualHubsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubsClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualHubsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubsClientCreateOrUpdatePollerResponse contains the response from method VirtualHubsClient.CreateOrUpdate.

func (VirtualHubsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualHubsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualHubsClient, token string) error

Resume rehydrates a VirtualHubsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualHubsClientCreateOrUpdateResponse added in v0.3.0 

type VirtualHubsClientCreateOrUpdateResponse struct {
	VirtualHubsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubsClientCreateOrUpdateResponse contains the response from method VirtualHubsClient.CreateOrUpdate.

type VirtualHubsClientCreateOrUpdateResult added in v0.3.0 

type VirtualHubsClientCreateOrUpdateResult struct {
	VirtualHub
}

VirtualHubsClientCreateOrUpdateResult contains the result from method VirtualHubsClient.CreateOrUpdate.

type VirtualHubsClientDeletePoller added in v0.3.0 

type VirtualHubsClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualHubsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubsClientDeletePoller) Done added in v0.3.0 

func (p *VirtualHubsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualHubsClientDeletePoller) FinalResponse(ctx context.Context) (VirtualHubsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubsClientDeleteResponse will be returned.

func (*VirtualHubsClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualHubsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualHubsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubsClientDeletePollerResponse added in v0.3.0 

type VirtualHubsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubsClientDeletePollerResponse contains the response from method VirtualHubsClient.Delete.

func (VirtualHubsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualHubsClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualHubsClient, token string) error

Resume rehydrates a VirtualHubsClientDeletePollerResponse from the provided client and resume token.

type VirtualHubsClientDeleteResponse added in v0.3.0 

type VirtualHubsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubsClientDeleteResponse contains the response from method VirtualHubsClient.Delete.

type VirtualHubsClientGetEffectiveVirtualHubRoutesPoller added in v0.3.0 

type VirtualHubsClientGetEffectiveVirtualHubRoutesPoller struct {
	// contains filtered or unexported fields
}

VirtualHubsClientGetEffectiveVirtualHubRoutesPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualHubsClientGetEffectiveVirtualHubRoutesPoller) Done added in v0.3.0 

func (p *VirtualHubsClientGetEffectiveVirtualHubRoutesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualHubsClientGetEffectiveVirtualHubRoutesPoller) FinalResponse added in v0.3.0 

func (p *VirtualHubsClientGetEffectiveVirtualHubRoutesPoller) FinalResponse(ctx context.Context) (VirtualHubsClientGetEffectiveVirtualHubRoutesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualHubsClientGetEffectiveVirtualHubRoutesResponse will be returned.

func (*VirtualHubsClientGetEffectiveVirtualHubRoutesPoller) Poll added in v0.3.0 

func (p *VirtualHubsClientGetEffectiveVirtualHubRoutesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualHubsClientGetEffectiveVirtualHubRoutesPoller) ResumeToken added in v0.3.0 

func (p *VirtualHubsClientGetEffectiveVirtualHubRoutesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualHubsClientGetEffectiveVirtualHubRoutesPollerResponse added in v0.3.0 

type VirtualHubsClientGetEffectiveVirtualHubRoutesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualHubsClientGetEffectiveVirtualHubRoutesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubsClientGetEffectiveVirtualHubRoutesPollerResponse contains the response from method VirtualHubsClient.GetEffectiveVirtualHubRoutes.

func (VirtualHubsClientGetEffectiveVirtualHubRoutesPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualHubsClientGetEffectiveVirtualHubRoutesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualHubsClientGetEffectiveVirtualHubRoutesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualHubsClientGetEffectiveVirtualHubRoutesPollerResponse) Resume added in v0.3.0 

func (l *VirtualHubsClientGetEffectiveVirtualHubRoutesPollerResponse) Resume(ctx context.Context, client *VirtualHubsClient, token string) error

Resume rehydrates a VirtualHubsClientGetEffectiveVirtualHubRoutesPollerResponse from the provided client and resume token.

type VirtualHubsClientGetEffectiveVirtualHubRoutesResponse added in v0.3.0 

type VirtualHubsClientGetEffectiveVirtualHubRoutesResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubsClientGetEffectiveVirtualHubRoutesResponse contains the response from method VirtualHubsClient.GetEffectiveVirtualHubRoutes.

type VirtualHubsClientGetOptions added in v0.3.0 

type VirtualHubsClientGetOptions struct {
}

VirtualHubsClientGetOptions contains the optional parameters for the VirtualHubsClient.Get method.

type VirtualHubsClientGetResponse added in v0.3.0 

type VirtualHubsClientGetResponse struct {
	VirtualHubsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubsClientGetResponse contains the response from method VirtualHubsClient.Get.

type VirtualHubsClientGetResult added in v0.3.0 

type VirtualHubsClientGetResult struct {
	VirtualHub
}

VirtualHubsClientGetResult contains the result from method VirtualHubsClient.Get.

type VirtualHubsClientListByResourceGroupOptions added in v0.3.0 

type VirtualHubsClientListByResourceGroupOptions struct {
}

VirtualHubsClientListByResourceGroupOptions contains the optional parameters for the VirtualHubsClient.ListByResourceGroup method.

type VirtualHubsClientListByResourceGroupPager added in v0.3.0 

type VirtualHubsClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

VirtualHubsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*VirtualHubsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *VirtualHubsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualHubsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *VirtualHubsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualHubsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *VirtualHubsClientListByResourceGroupPager) PageResponse() VirtualHubsClientListByResourceGroupResponse

PageResponse returns the current VirtualHubsClientListByResourceGroupResponse page.

type VirtualHubsClientListByResourceGroupResponse added in v0.3.0 

type VirtualHubsClientListByResourceGroupResponse struct {
	VirtualHubsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubsClientListByResourceGroupResponse contains the response from method VirtualHubsClient.ListByResourceGroup.

type VirtualHubsClientListByResourceGroupResult added in v0.3.0 

type VirtualHubsClientListByResourceGroupResult struct {
	ListVirtualHubsResult
}

VirtualHubsClientListByResourceGroupResult contains the result from method VirtualHubsClient.ListByResourceGroup.

type VirtualHubsClientListOptions added in v0.3.0 

type VirtualHubsClientListOptions struct {
}

VirtualHubsClientListOptions contains the optional parameters for the VirtualHubsClient.List method.

type VirtualHubsClientListPager added in v0.3.0 

type VirtualHubsClientListPager struct {
	// contains filtered or unexported fields
}

VirtualHubsClientListPager provides operations for iterating over paged responses.

func (*VirtualHubsClientListPager) Err added in v0.3.0 

func (p *VirtualHubsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualHubsClientListPager) NextPage added in v0.3.0 

func (p *VirtualHubsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualHubsClientListPager) PageResponse added in v0.3.0 

func (p *VirtualHubsClientListPager) PageResponse() VirtualHubsClientListResponse

PageResponse returns the current VirtualHubsClientListResponse page.

type VirtualHubsClientListResponse added in v0.3.0 

type VirtualHubsClientListResponse struct {
	VirtualHubsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubsClientListResponse contains the response from method VirtualHubsClient.List.

type VirtualHubsClientListResult added in v0.3.0 

type VirtualHubsClientListResult struct {
	ListVirtualHubsResult
}

VirtualHubsClientListResult contains the result from method VirtualHubsClient.List.

type VirtualHubsClientUpdateTagsOptions added in v0.3.0 

type VirtualHubsClientUpdateTagsOptions struct {
}

VirtualHubsClientUpdateTagsOptions contains the optional parameters for the VirtualHubsClient.UpdateTags method.

type VirtualHubsClientUpdateTagsResponse added in v0.3.0 

type VirtualHubsClientUpdateTagsResponse struct {
	VirtualHubsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualHubsClientUpdateTagsResponse contains the response from method VirtualHubsClient.UpdateTags.

type VirtualHubsClientUpdateTagsResult added in v0.3.0 

type VirtualHubsClientUpdateTagsResult struct {
	VirtualHub
}

VirtualHubsClientUpdateTagsResult contains the result from method VirtualHubsClient.UpdateTags.

type VirtualNetwork 

type VirtualNetwork struct {
	// The extended location of the virtual network.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the virtual network.
	Properties *VirtualNetworkPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualNetwork - Virtual Network resource.

func (VirtualNetwork) MarshalJSON 

func (v VirtualNetwork) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetwork.

type VirtualNetworkBgpCommunities 

type VirtualNetworkBgpCommunities struct {
	// REQUIRED; The BGP community associated with the virtual network.
	VirtualNetworkCommunity *string `json:"virtualNetworkCommunity,omitempty"`

	// READ-ONLY; The BGP community associated with the region of the virtual network.
	RegionalCommunity *string `json:"regionalCommunity,omitempty" azure:"ro"`
}

VirtualNetworkBgpCommunities - Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.

type VirtualNetworkConnectionGatewayReference 

type VirtualNetworkConnectionGatewayReference struct {
	// REQUIRED; The ID of VirtualNetworkGateway or LocalNetworkGateway resource.
	ID *string `json:"id,omitempty"`
}

VirtualNetworkConnectionGatewayReference - A reference to VirtualNetworkGateway or LocalNetworkGateway resource.

type VirtualNetworkEncryption added in v0.2.0 

type VirtualNetworkEncryption struct {
	// REQUIRED; Indicates if encryption is enabled on the virtual network.
	Enabled *bool `json:"enabled,omitempty"`

	// If the encrypted VNet allows VM that does not support encryption
	Enforcement *VirtualNetworkEncryptionEnforcement `json:"enforcement,omitempty"`
}

VirtualNetworkEncryption - Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet.

type VirtualNetworkEncryptionEnforcement added in v0.2.0 

type VirtualNetworkEncryptionEnforcement string

VirtualNetworkEncryptionEnforcement - If the encrypted VNet allows VM that does not support encryption 

const (
	VirtualNetworkEncryptionEnforcementAllowUnencrypted VirtualNetworkEncryptionEnforcement = "AllowUnencrypted"
	VirtualNetworkEncryptionEnforcementDropUnencrypted  VirtualNetworkEncryptionEnforcement = "DropUnencrypted"
)

func PossibleVirtualNetworkEncryptionEnforcementValues added in v0.2.0 

func PossibleVirtualNetworkEncryptionEnforcementValues() []VirtualNetworkEncryptionEnforcement

PossibleVirtualNetworkEncryptionEnforcementValues returns the possible values for the VirtualNetworkEncryptionEnforcement const type.

func (VirtualNetworkEncryptionEnforcement) ToPtr added in v0.2.0 

func (c VirtualNetworkEncryptionEnforcement) ToPtr() *VirtualNetworkEncryptionEnforcement

ToPtr returns a *VirtualNetworkEncryptionEnforcement pointing to the current value.

type VirtualNetworkGateway 

type VirtualNetworkGateway struct {
	// REQUIRED; Properties of the virtual network gateway.
	Properties *VirtualNetworkGatewayPropertiesFormat `json:"properties,omitempty"`

	// The extended location of type local virtual network gateway.
	ExtendedLocation *ExtendedLocation `json:"extendedLocation,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualNetworkGateway - A common class for general resource information.

func (VirtualNetworkGateway) MarshalJSON 

func (v VirtualNetworkGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGateway.

type VirtualNetworkGatewayConnection 

type VirtualNetworkGatewayConnection struct {
	// REQUIRED; Properties of the virtual network gateway connection.
	Properties *VirtualNetworkGatewayConnectionPropertiesFormat `json:"properties,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualNetworkGatewayConnection - A common class for general resource information.

func (VirtualNetworkGatewayConnection) MarshalJSON 

func (v VirtualNetworkGatewayConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayConnection.

type VirtualNetworkGatewayConnectionListEntity 

type VirtualNetworkGatewayConnectionListEntity struct {
	// REQUIRED; Properties of the virtual network gateway connection.
	Properties *VirtualNetworkGatewayConnectionListEntityPropertiesFormat `json:"properties,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualNetworkGatewayConnectionListEntity - A common class for general resource information.

func (VirtualNetworkGatewayConnectionListEntity) MarshalJSON 

func (v VirtualNetworkGatewayConnectionListEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayConnectionListEntity.

type VirtualNetworkGatewayConnectionListEntityPropertiesFormat 

type VirtualNetworkGatewayConnectionListEntityPropertiesFormat struct {
	// REQUIRED; Gateway connection type.
	ConnectionType *VirtualNetworkGatewayConnectionType `json:"connectionType,omitempty"`

	// REQUIRED; The reference to virtual network gateway resource.
	VirtualNetworkGateway1 *VirtualNetworkConnectionGatewayReference `json:"virtualNetworkGateway1,omitempty"`

	// The authorizationKey.
	AuthorizationKey *string `json:"authorizationKey,omitempty"`

	// The connection mode for this connection.
	ConnectionMode *VirtualNetworkGatewayConnectionMode `json:"connectionMode,omitempty"`

	// Connection protocol used for this connection.
	ConnectionProtocol *VirtualNetworkGatewayConnectionProtocol `json:"connectionProtocol,omitempty"`

	// EnableBgp flag.
	EnableBgp *bool `json:"enableBgp,omitempty"`

	// Bypass ExpressRoute Gateway for data forwarding.
	ExpressRouteGatewayBypass *bool `json:"expressRouteGatewayBypass,omitempty"`

	// The IPSec Policies to be considered by this connection.
	IPSecPolicies []*IPSecPolicy `json:"ipsecPolicies,omitempty"`

	// The reference to local network gateway resource.
	LocalNetworkGateway2 *VirtualNetworkConnectionGatewayReference `json:"localNetworkGateway2,omitempty"`

	// The reference to peerings resource.
	Peer *SubResource `json:"peer,omitempty"`

	// The routing weight.
	RoutingWeight *int32 `json:"routingWeight,omitempty"`

	// The IPSec shared key.
	SharedKey *string `json:"sharedKey,omitempty"`

	// The Traffic Selector Policies to be considered by this connection.
	TrafficSelectorPolicies []*TrafficSelectorPolicy `json:"trafficSelectorPolicies,omitempty"`

	// Enable policy-based traffic selectors.
	UsePolicyBasedTrafficSelectors *bool `json:"usePolicyBasedTrafficSelectors,omitempty"`

	// The reference to virtual network gateway resource.
	VirtualNetworkGateway2 *VirtualNetworkConnectionGatewayReference `json:"virtualNetworkGateway2,omitempty"`

	// READ-ONLY; Virtual Network Gateway connection status.
	ConnectionStatus *VirtualNetworkGatewayConnectionStatus `json:"connectionStatus,omitempty" azure:"ro"`

	// READ-ONLY; The egress bytes transferred in this connection.
	EgressBytesTransferred *int64 `json:"egressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The ingress bytes transferred in this connection.
	IngressBytesTransferred *int64 `json:"ingressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the virtual network gateway connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the virtual network gateway connection resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`

	// READ-ONLY; Collection of all tunnels' connection health status.
	TunnelConnectionStatus []*TunnelConnectionHealth `json:"tunnelConnectionStatus,omitempty" azure:"ro"`
}

VirtualNetworkGatewayConnectionListEntityPropertiesFormat - VirtualNetworkGatewayConnection properties.

func (VirtualNetworkGatewayConnectionListEntityPropertiesFormat) MarshalJSON 

func (v VirtualNetworkGatewayConnectionListEntityPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayConnectionListEntityPropertiesFormat.

type VirtualNetworkGatewayConnectionListResult 

type VirtualNetworkGatewayConnectionListResult struct {
	// A list of VirtualNetworkGatewayConnection resources that exists in a resource group.
	Value []*VirtualNetworkGatewayConnection `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

VirtualNetworkGatewayConnectionListResult - Response for the ListVirtualNetworkGatewayConnections API service call.

func (VirtualNetworkGatewayConnectionListResult) MarshalJSON 

func (v VirtualNetworkGatewayConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayConnectionListResult.

type VirtualNetworkGatewayConnectionMode 

type VirtualNetworkGatewayConnectionMode string

VirtualNetworkGatewayConnectionMode - Gateway connection type. 

const (
	VirtualNetworkGatewayConnectionModeDefault       VirtualNetworkGatewayConnectionMode = "Default"
	VirtualNetworkGatewayConnectionModeInitiatorOnly VirtualNetworkGatewayConnectionMode = "InitiatorOnly"
	VirtualNetworkGatewayConnectionModeResponderOnly VirtualNetworkGatewayConnectionMode = "ResponderOnly"
)

func PossibleVirtualNetworkGatewayConnectionModeValues 

func PossibleVirtualNetworkGatewayConnectionModeValues() []VirtualNetworkGatewayConnectionMode

PossibleVirtualNetworkGatewayConnectionModeValues returns the possible values for the VirtualNetworkGatewayConnectionMode const type.

func (VirtualNetworkGatewayConnectionMode) ToPtr 

func (c VirtualNetworkGatewayConnectionMode) ToPtr() *VirtualNetworkGatewayConnectionMode

ToPtr returns a *VirtualNetworkGatewayConnectionMode pointing to the current value.

type VirtualNetworkGatewayConnectionPropertiesFormat 

type VirtualNetworkGatewayConnectionPropertiesFormat struct {
	// REQUIRED; Gateway connection type.
	ConnectionType *VirtualNetworkGatewayConnectionType `json:"connectionType,omitempty"`

	// REQUIRED; The reference to virtual network gateway resource.
	VirtualNetworkGateway1 *VirtualNetworkGateway `json:"virtualNetworkGateway1,omitempty"`

	// The authorizationKey.
	AuthorizationKey *string `json:"authorizationKey,omitempty"`

	// The connection mode for this connection.
	ConnectionMode *VirtualNetworkGatewayConnectionMode `json:"connectionMode,omitempty"`

	// Connection protocol used for this connection.
	ConnectionProtocol *VirtualNetworkGatewayConnectionProtocol `json:"connectionProtocol,omitempty"`

	// The dead peer detection timeout of this connection in seconds.
	DpdTimeoutSeconds *int32 `json:"dpdTimeoutSeconds,omitempty"`

	// List of egress NatRules.
	EgressNatRules []*SubResource `json:"egressNatRules,omitempty"`

	// EnableBgp flag.
	EnableBgp *bool `json:"enableBgp,omitempty"`

	// Bypass ExpressRoute Gateway for data forwarding.
	ExpressRouteGatewayBypass *bool `json:"expressRouteGatewayBypass,omitempty"`

	// The IPSec Policies to be considered by this connection.
	IPSecPolicies []*IPSecPolicy `json:"ipsecPolicies,omitempty"`

	// List of ingress NatRules.
	IngressNatRules []*SubResource `json:"ingressNatRules,omitempty"`

	// The reference to local network gateway resource.
	LocalNetworkGateway2 *LocalNetworkGateway `json:"localNetworkGateway2,omitempty"`

	// The reference to peerings resource.
	Peer *SubResource `json:"peer,omitempty"`

	// The routing weight.
	RoutingWeight *int32 `json:"routingWeight,omitempty"`

	// The IPSec shared key.
	SharedKey *string `json:"sharedKey,omitempty"`

	// The Traffic Selector Policies to be considered by this connection.
	TrafficSelectorPolicies []*TrafficSelectorPolicy `json:"trafficSelectorPolicies,omitempty"`

	// Use private local Azure IP for the connection.
	UseLocalAzureIPAddress *bool `json:"useLocalAzureIpAddress,omitempty"`

	// Enable policy-based traffic selectors.
	UsePolicyBasedTrafficSelectors *bool `json:"usePolicyBasedTrafficSelectors,omitempty"`

	// The reference to virtual network gateway resource.
	VirtualNetworkGateway2 *VirtualNetworkGateway `json:"virtualNetworkGateway2,omitempty"`

	// READ-ONLY; Virtual Network Gateway connection status.
	ConnectionStatus *VirtualNetworkGatewayConnectionStatus `json:"connectionStatus,omitempty" azure:"ro"`

	// READ-ONLY; The egress bytes transferred in this connection.
	EgressBytesTransferred *int64 `json:"egressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The ingress bytes transferred in this connection.
	IngressBytesTransferred *int64 `json:"ingressBytesTransferred,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the virtual network gateway connection resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the virtual network gateway connection resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`

	// READ-ONLY; Collection of all tunnels' connection health status.
	TunnelConnectionStatus []*TunnelConnectionHealth `json:"tunnelConnectionStatus,omitempty" azure:"ro"`
}

VirtualNetworkGatewayConnectionPropertiesFormat - VirtualNetworkGatewayConnection properties.

func (VirtualNetworkGatewayConnectionPropertiesFormat) MarshalJSON 

func (v VirtualNetworkGatewayConnectionPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayConnectionPropertiesFormat.

type VirtualNetworkGatewayConnectionProtocol 

type VirtualNetworkGatewayConnectionProtocol string

VirtualNetworkGatewayConnectionProtocol - Gateway connection protocol. 

const (
	VirtualNetworkGatewayConnectionProtocolIKEv1 VirtualNetworkGatewayConnectionProtocol = "IKEv1"
	VirtualNetworkGatewayConnectionProtocolIKEv2 VirtualNetworkGatewayConnectionProtocol = "IKEv2"
)

func PossibleVirtualNetworkGatewayConnectionProtocolValues 

func PossibleVirtualNetworkGatewayConnectionProtocolValues() []VirtualNetworkGatewayConnectionProtocol

PossibleVirtualNetworkGatewayConnectionProtocolValues returns the possible values for the VirtualNetworkGatewayConnectionProtocol const type.

func (VirtualNetworkGatewayConnectionProtocol) ToPtr 

func (c VirtualNetworkGatewayConnectionProtocol) ToPtr() *VirtualNetworkGatewayConnectionProtocol

ToPtr returns a *VirtualNetworkGatewayConnectionProtocol pointing to the current value.

type VirtualNetworkGatewayConnectionStatus 

type VirtualNetworkGatewayConnectionStatus string

VirtualNetworkGatewayConnectionStatus - Virtual Network Gateway connection status. 

const (
	VirtualNetworkGatewayConnectionStatusConnected    VirtualNetworkGatewayConnectionStatus = "Connected"
	VirtualNetworkGatewayConnectionStatusConnecting   VirtualNetworkGatewayConnectionStatus = "Connecting"
	VirtualNetworkGatewayConnectionStatusNotConnected VirtualNetworkGatewayConnectionStatus = "NotConnected"
	VirtualNetworkGatewayConnectionStatusUnknown      VirtualNetworkGatewayConnectionStatus = "Unknown"
)

func PossibleVirtualNetworkGatewayConnectionStatusValues 

func PossibleVirtualNetworkGatewayConnectionStatusValues() []VirtualNetworkGatewayConnectionStatus

PossibleVirtualNetworkGatewayConnectionStatusValues returns the possible values for the VirtualNetworkGatewayConnectionStatus const type.

func (VirtualNetworkGatewayConnectionStatus) ToPtr 

func (c VirtualNetworkGatewayConnectionStatus) ToPtr() *VirtualNetworkGatewayConnectionStatus

ToPtr returns a *VirtualNetworkGatewayConnectionStatus pointing to the current value.

type VirtualNetworkGatewayConnectionType 

type VirtualNetworkGatewayConnectionType string

VirtualNetworkGatewayConnectionType - Gateway connection type. 

const (
	VirtualNetworkGatewayConnectionTypeExpressRoute VirtualNetworkGatewayConnectionType = "ExpressRoute"
	VirtualNetworkGatewayConnectionTypeIPsec        VirtualNetworkGatewayConnectionType = "IPsec"
	VirtualNetworkGatewayConnectionTypeVPNClient    VirtualNetworkGatewayConnectionType = "VPNClient"
	VirtualNetworkGatewayConnectionTypeVnet2Vnet    VirtualNetworkGatewayConnectionType = "Vnet2Vnet"
)

func PossibleVirtualNetworkGatewayConnectionTypeValues 

func PossibleVirtualNetworkGatewayConnectionTypeValues() []VirtualNetworkGatewayConnectionType

PossibleVirtualNetworkGatewayConnectionTypeValues returns the possible values for the VirtualNetworkGatewayConnectionType const type.

func (VirtualNetworkGatewayConnectionType) ToPtr 

func (c VirtualNetworkGatewayConnectionType) ToPtr() *VirtualNetworkGatewayConnectionType

ToPtr returns a *VirtualNetworkGatewayConnectionType pointing to the current value.

type VirtualNetworkGatewayConnectionsClient 

type VirtualNetworkGatewayConnectionsClient struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClient contains the methods for the VirtualNetworkGatewayConnections group. Don't use this type directly, use NewVirtualNetworkGatewayConnectionsClient() instead.

func NewVirtualNetworkGatewayConnectionsClient 

func NewVirtualNetworkGatewayConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualNetworkGatewayConnectionsClient

NewVirtualNetworkGatewayConnectionsClient creates a new instance of VirtualNetworkGatewayConnectionsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualNetworkGatewayConnectionsClient) BeginCreateOrUpdate 

func (client *VirtualNetworkGatewayConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, parameters VirtualNetworkGatewayConnection, options *VirtualNetworkGatewayConnectionsClientBeginCreateOrUpdateOptions) (VirtualNetworkGatewayConnectionsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a virtual network gateway connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The name of the virtual network gateway connection. parameters - Parameters supplied to the create or update virtual network gateway connection operation. options - VirtualNetworkGatewayConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		armnetwork.VirtualNetworkGatewayConnection{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.VirtualNetworkGatewayConnectionPropertiesFormat{
				ConnectionMode:     armnetwork.VirtualNetworkGatewayConnectionMode("Default").ToPtr(),
				ConnectionProtocol: armnetwork.VirtualNetworkGatewayConnectionProtocol("IKEv2").ToPtr(),
				ConnectionType:     armnetwork.VirtualNetworkGatewayConnectionType("IPsec").ToPtr(),
				DpdTimeoutSeconds:  to.Int32Ptr(30),
				EgressNatRules: []*armnetwork.SubResource{
					{
						ID: to.StringPtr("<id>"),
					}},
				EnableBgp: to.BoolPtr(false),
				IngressNatRules: []*armnetwork.SubResource{
					{
						ID: to.StringPtr("<id>"),
					}},
				IPSecPolicies: []*armnetwork.IPSecPolicy{},
				LocalNetworkGateway2: &armnetwork.LocalNetworkGateway{
					ID:       to.StringPtr("<id>"),
					Location: to.StringPtr("<location>"),
					Tags:     map[string]*string{},
					Properties: &armnetwork.LocalNetworkGatewayPropertiesFormat{
						GatewayIPAddress: to.StringPtr("<gateway-ipaddress>"),
						LocalNetworkAddressSpace: &armnetwork.AddressSpace{
							AddressPrefixes: []*string{
								to.StringPtr("10.1.0.0/16")},
						},
					},
				},
				RoutingWeight:                  to.Int32Ptr(0),
				SharedKey:                      to.StringPtr("<shared-key>"),
				TrafficSelectorPolicies:        []*armnetwork.TrafficSelectorPolicy{},
				UsePolicyBasedTrafficSelectors: to.BoolPtr(false),
				VirtualNetworkGateway1: &armnetwork.VirtualNetworkGateway{
					ID:       to.StringPtr("<id>"),
					Location: to.StringPtr("<location>"),
					Tags:     map[string]*string{},
					Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
						Active: to.BoolPtr(false),
						BgpSettings: &armnetwork.BgpSettings{
							Asn:               to.Int64Ptr(65514),
							BgpPeeringAddress: to.StringPtr("<bgp-peering-address>"),
							PeerWeight:        to.Int32Ptr(0),
						},
						EnableBgp:   to.BoolPtr(false),
						GatewayType: armnetwork.VirtualNetworkGatewayType("Vpn").ToPtr(),
						IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
							{
								ID:   to.StringPtr("<id>"),
								Name: to.StringPtr("<name>"),
								Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
									PrivateIPAllocationMethod: armnetwork.IPAllocationMethod("Dynamic").ToPtr(),
									PublicIPAddress: &armnetwork.SubResource{
										ID: to.StringPtr("<id>"),
									},
									Subnet: &armnetwork.SubResource{
										ID: to.StringPtr("<id>"),
									},
								},
							}},
						SKU: &armnetwork.VirtualNetworkGatewaySKU{
							Name: armnetwork.VirtualNetworkGatewaySKUName("VpnGw1").ToPtr(),
							Tier: armnetwork.VirtualNetworkGatewaySKUTier("VpnGw1").ToPtr(),
						},
						VPNType: armnetwork.VPNType("RouteBased").ToPtr(),
					},
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayConnectionsClientCreateOrUpdateResult)
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginDelete 

func (client *VirtualNetworkGatewayConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, options *VirtualNetworkGatewayConnectionsClientBeginDeleteOptions) (VirtualNetworkGatewayConnectionsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified virtual network Gateway connection. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The name of the virtual network gateway connection. options - VirtualNetworkGatewayConnectionsClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginGetIkeSas 

func (client *VirtualNetworkGatewayConnectionsClient) BeginGetIkeSas(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, options *VirtualNetworkGatewayConnectionsClientBeginGetIkeSasOptions) (VirtualNetworkGatewayConnectionsClientGetIkeSasPollerResponse, error)

BeginGetIkeSas - Lists IKE Security Associations for the virtual network gateway connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The name of the virtual network gateway Connection. options - VirtualNetworkGatewayConnectionsClientBeginGetIkeSasOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginGetIkeSas method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetIkeSas(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayConnectionsClientGetIkeSasResult)
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginResetConnection 

func (client *VirtualNetworkGatewayConnectionsClient) BeginResetConnection(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, options *VirtualNetworkGatewayConnectionsClientBeginResetConnectionOptions) (VirtualNetworkGatewayConnectionsClientResetConnectionPollerResponse, error)

BeginResetConnection - Resets the virtual network gateway connection specified. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The name of the virtual network gateway Connection. options - VirtualNetworkGatewayConnectionsClientBeginResetConnectionOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginResetConnection method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionReset.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginResetConnection(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginResetSharedKey 

func (client *VirtualNetworkGatewayConnectionsClient) BeginResetSharedKey(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, parameters ConnectionResetSharedKey, options *VirtualNetworkGatewayConnectionsClientBeginResetSharedKeyOptions) (VirtualNetworkGatewayConnectionsClientResetSharedKeyPollerResponse, error)

BeginResetSharedKey - The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The virtual network gateway connection reset shared key Name. parameters - Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider. options - VirtualNetworkGatewayConnectionsClientBeginResetSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginResetSharedKey method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginResetSharedKey(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		armnetwork.ConnectionResetSharedKey{
			KeyLength: to.Int32Ptr(128),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayConnectionsClientResetSharedKeyResult)
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginSetSharedKey 

func (client *VirtualNetworkGatewayConnectionsClient) BeginSetSharedKey(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, parameters ConnectionSharedKey, options *VirtualNetworkGatewayConnectionsClientBeginSetSharedKeyOptions) (VirtualNetworkGatewayConnectionsClientSetSharedKeyPollerResponse, error)

BeginSetSharedKey - The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The virtual network gateway connection name. parameters - Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider. options - VirtualNetworkGatewayConnectionsClientBeginSetSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginSetSharedKey method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginSetSharedKey(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		armnetwork.ConnectionSharedKey{
			Value: to.StringPtr("<value>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayConnectionsClientSetSharedKeyResult)
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginStartPacketCapture 

func (client *VirtualNetworkGatewayConnectionsClient) BeginStartPacketCapture(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, options *VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions) (VirtualNetworkGatewayConnectionsClientStartPacketCapturePollerResponse, error)

BeginStartPacketCapture - Starts packet capture on virtual network gateway connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The name of the virtual network gateway connection. options - VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginStartPacketCapture method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStartPacketCapture(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		&armnetwork.VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions{Parameters: &armnetwork.VPNPacketCaptureStartParameters{
			FilterData: to.StringPtr("<filter-data>"),
		},
		})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayConnectionsClientStartPacketCaptureResult)
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginStopPacketCapture 

func (client *VirtualNetworkGatewayConnectionsClient) BeginStopPacketCapture(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, parameters VPNPacketCaptureStopParameters, options *VirtualNetworkGatewayConnectionsClientBeginStopPacketCaptureOptions) (VirtualNetworkGatewayConnectionsClientStopPacketCapturePollerResponse, error)

BeginStopPacketCapture - Stops packet capture on virtual network gateway connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The name of the virtual network gateway Connection. parameters - Virtual network gateway packet capture parameters supplied to stop packet capture on gateway connection. options - VirtualNetworkGatewayConnectionsClientBeginStopPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginStopPacketCapture method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStopPacketCapture(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		armnetwork.VPNPacketCaptureStopParameters{
			SasURL: to.StringPtr("<sas-url>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayConnectionsClientStopPacketCaptureResult)
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginUpdateTags 

func (client *VirtualNetworkGatewayConnectionsClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, parameters TagsObject, options *VirtualNetworkGatewayConnectionsClientBeginUpdateTagsOptions) (VirtualNetworkGatewayConnectionsClientUpdateTagsPollerResponse, error)

BeginUpdateTags - Updates a virtual network gateway connection tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The name of the virtual network gateway connection. parameters - Parameters supplied to update virtual network gateway connection tags. options - VirtualNetworkGatewayConnectionsClientBeginUpdateTagsOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginUpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdateTags(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayConnectionsClientUpdateTagsResult)
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) Get 

func (client *VirtualNetworkGatewayConnectionsClient) Get(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, options *VirtualNetworkGatewayConnectionsClientGetOptions) (VirtualNetworkGatewayConnectionsClientGetResponse, error)

Get - Gets the specified virtual network gateway connection by resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The name of the virtual network gateway connection. options - VirtualNetworkGatewayConnectionsClientGetOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayConnectionsClientGetResult)
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) GetSharedKey 

func (client *VirtualNetworkGatewayConnectionsClient) GetSharedKey(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, options *VirtualNetworkGatewayConnectionsClientGetSharedKeyOptions) (VirtualNetworkGatewayConnectionsClientGetSharedKeyResponse, error)

GetSharedKey - The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The virtual network gateway connection shared key name. options - VirtualNetworkGatewayConnectionsClientGetSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.GetSharedKey method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.GetSharedKey(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayConnectionsClientGetSharedKeyResult)
}

Output:

func (*VirtualNetworkGatewayConnectionsClient) List 

func (client *VirtualNetworkGatewayConnectionsClient) List(resourceGroupName string, options *VirtualNetworkGatewayConnectionsClientListOptions) *VirtualNetworkGatewayConnectionsClientListPager

List - The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - VirtualNetworkGatewayConnectionsClientListOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayConnectionsList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayConnectionsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VirtualNetworkGatewayConnectionsClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientBeginCreateOrUpdateOptions struct {
}

VirtualNetworkGatewayConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginCreateOrUpdate method.

type VirtualNetworkGatewayConnectionsClientBeginDeleteOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientBeginDeleteOptions struct {
}

VirtualNetworkGatewayConnectionsClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginDelete method.

type VirtualNetworkGatewayConnectionsClientBeginGetIkeSasOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientBeginGetIkeSasOptions struct {
}

VirtualNetworkGatewayConnectionsClientBeginGetIkeSasOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginGetIkeSas method.

type VirtualNetworkGatewayConnectionsClientBeginResetConnectionOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientBeginResetConnectionOptions struct {
}

VirtualNetworkGatewayConnectionsClientBeginResetConnectionOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginResetConnection method.

type VirtualNetworkGatewayConnectionsClientBeginResetSharedKeyOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientBeginResetSharedKeyOptions struct {
}

VirtualNetworkGatewayConnectionsClientBeginResetSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginResetSharedKey method.

type VirtualNetworkGatewayConnectionsClientBeginSetSharedKeyOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientBeginSetSharedKeyOptions struct {
}

VirtualNetworkGatewayConnectionsClientBeginSetSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginSetSharedKey method.

type VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions struct {
	// Virtual network gateway packet capture parameters supplied to start packet capture on gateway connection.
	Parameters *VPNPacketCaptureStartParameters
}

VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginStartPacketCapture method.

type VirtualNetworkGatewayConnectionsClientBeginStopPacketCaptureOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientBeginStopPacketCaptureOptions struct {
}

VirtualNetworkGatewayConnectionsClientBeginStopPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginStopPacketCapture method.

type VirtualNetworkGatewayConnectionsClientBeginUpdateTagsOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientBeginUpdateTagsOptions struct {
}

VirtualNetworkGatewayConnectionsClientBeginUpdateTagsOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginUpdateTags method.

type VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayConnectionsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayConnectionsClientCreateOrUpdateResponse will be returned.

func (*VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayConnectionsClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayConnectionsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientCreateOrUpdatePollerResponse contains the response from method VirtualNetworkGatewayConnectionsClient.CreateOrUpdate.

func (VirtualNetworkGatewayConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayConnectionsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayConnectionsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayConnectionsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayConnectionsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayConnectionsClient, token string) error

Resume rehydrates a VirtualNetworkGatewayConnectionsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualNetworkGatewayConnectionsClientCreateOrUpdateResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientCreateOrUpdateResponse struct {
	VirtualNetworkGatewayConnectionsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientCreateOrUpdateResponse contains the response from method VirtualNetworkGatewayConnectionsClient.CreateOrUpdate.

type VirtualNetworkGatewayConnectionsClientCreateOrUpdateResult added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientCreateOrUpdateResult struct {
	VirtualNetworkGatewayConnection
}

VirtualNetworkGatewayConnectionsClientCreateOrUpdateResult contains the result from method VirtualNetworkGatewayConnectionsClient.CreateOrUpdate.

type VirtualNetworkGatewayConnectionsClientDeletePoller added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayConnectionsClientDeletePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayConnectionsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayConnectionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayConnectionsClientDeleteResponse will be returned.

func (*VirtualNetworkGatewayConnectionsClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayConnectionsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayConnectionsClientDeletePollerResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayConnectionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientDeletePollerResponse contains the response from method VirtualNetworkGatewayConnectionsClient.Delete.

func (VirtualNetworkGatewayConnectionsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayConnectionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayConnectionsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayConnectionsClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayConnectionsClient, token string) error

Resume rehydrates a VirtualNetworkGatewayConnectionsClientDeletePollerResponse from the provided client and resume token.

type VirtualNetworkGatewayConnectionsClientDeleteResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientDeleteResponse contains the response from method VirtualNetworkGatewayConnectionsClient.Delete.

type VirtualNetworkGatewayConnectionsClientGetIkeSasPoller added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientGetIkeSasPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClientGetIkeSasPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayConnectionsClientGetIkeSasPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientGetIkeSasPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayConnectionsClientGetIkeSasPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientGetIkeSasPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayConnectionsClientGetIkeSasResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayConnectionsClientGetIkeSasResponse will be returned.

func (*VirtualNetworkGatewayConnectionsClientGetIkeSasPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientGetIkeSasPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayConnectionsClientGetIkeSasPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientGetIkeSasPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayConnectionsClientGetIkeSasPollerResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientGetIkeSasPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayConnectionsClientGetIkeSasPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientGetIkeSasPollerResponse contains the response from method VirtualNetworkGatewayConnectionsClient.GetIkeSas.

func (VirtualNetworkGatewayConnectionsClientGetIkeSasPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayConnectionsClientGetIkeSasPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayConnectionsClientGetIkeSasResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayConnectionsClientGetIkeSasPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayConnectionsClientGetIkeSasPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayConnectionsClient, token string) error

Resume rehydrates a VirtualNetworkGatewayConnectionsClientGetIkeSasPollerResponse from the provided client and resume token.

type VirtualNetworkGatewayConnectionsClientGetIkeSasResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientGetIkeSasResponse struct {
	VirtualNetworkGatewayConnectionsClientGetIkeSasResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientGetIkeSasResponse contains the response from method VirtualNetworkGatewayConnectionsClient.GetIkeSas.

type VirtualNetworkGatewayConnectionsClientGetIkeSasResult added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientGetIkeSasResult struct {
	Value *string
}

VirtualNetworkGatewayConnectionsClientGetIkeSasResult contains the result from method VirtualNetworkGatewayConnectionsClient.GetIkeSas.

type VirtualNetworkGatewayConnectionsClientGetOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientGetOptions struct {
}

VirtualNetworkGatewayConnectionsClientGetOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.Get method.

type VirtualNetworkGatewayConnectionsClientGetResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientGetResponse struct {
	VirtualNetworkGatewayConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientGetResponse contains the response from method VirtualNetworkGatewayConnectionsClient.Get.

type VirtualNetworkGatewayConnectionsClientGetResult added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientGetResult struct {
	VirtualNetworkGatewayConnection
}

VirtualNetworkGatewayConnectionsClientGetResult contains the result from method VirtualNetworkGatewayConnectionsClient.Get.

type VirtualNetworkGatewayConnectionsClientGetSharedKeyOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientGetSharedKeyOptions struct {
}

VirtualNetworkGatewayConnectionsClientGetSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.GetSharedKey method.

type VirtualNetworkGatewayConnectionsClientGetSharedKeyResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientGetSharedKeyResponse struct {
	VirtualNetworkGatewayConnectionsClientGetSharedKeyResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientGetSharedKeyResponse contains the response from method VirtualNetworkGatewayConnectionsClient.GetSharedKey.

type VirtualNetworkGatewayConnectionsClientGetSharedKeyResult added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientGetSharedKeyResult struct {
	ConnectionSharedKey
}

VirtualNetworkGatewayConnectionsClientGetSharedKeyResult contains the result from method VirtualNetworkGatewayConnectionsClient.GetSharedKey.

type VirtualNetworkGatewayConnectionsClientListOptions added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientListOptions struct {
}

VirtualNetworkGatewayConnectionsClientListOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.List method.

type VirtualNetworkGatewayConnectionsClientListPager added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientListPager struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClientListPager provides operations for iterating over paged responses.

func (*VirtualNetworkGatewayConnectionsClientListPager) Err added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualNetworkGatewayConnectionsClientListPager) NextPage added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworkGatewayConnectionsClientListPager) PageResponse added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientListPager) PageResponse() VirtualNetworkGatewayConnectionsClientListResponse

PageResponse returns the current VirtualNetworkGatewayConnectionsClientListResponse page.

type VirtualNetworkGatewayConnectionsClientListResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientListResponse struct {
	VirtualNetworkGatewayConnectionsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientListResponse contains the response from method VirtualNetworkGatewayConnectionsClient.List.

type VirtualNetworkGatewayConnectionsClientListResult added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientListResult struct {
	VirtualNetworkGatewayConnectionListResult
}

VirtualNetworkGatewayConnectionsClientListResult contains the result from method VirtualNetworkGatewayConnectionsClient.List.

type VirtualNetworkGatewayConnectionsClientResetConnectionPoller added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientResetConnectionPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClientResetConnectionPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayConnectionsClientResetConnectionPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientResetConnectionPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayConnectionsClientResetConnectionPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientResetConnectionPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayConnectionsClientResetConnectionResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayConnectionsClientResetConnectionResponse will be returned.

func (*VirtualNetworkGatewayConnectionsClientResetConnectionPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientResetConnectionPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayConnectionsClientResetConnectionPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientResetConnectionPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayConnectionsClientResetConnectionPollerResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientResetConnectionPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayConnectionsClientResetConnectionPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientResetConnectionPollerResponse contains the response from method VirtualNetworkGatewayConnectionsClient.ResetConnection.

func (VirtualNetworkGatewayConnectionsClientResetConnectionPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayConnectionsClientResetConnectionPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayConnectionsClientResetConnectionResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayConnectionsClientResetConnectionPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayConnectionsClientResetConnectionPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayConnectionsClient, token string) error

Resume rehydrates a VirtualNetworkGatewayConnectionsClientResetConnectionPollerResponse from the provided client and resume token.

type VirtualNetworkGatewayConnectionsClientResetConnectionResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientResetConnectionResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientResetConnectionResponse contains the response from method VirtualNetworkGatewayConnectionsClient.ResetConnection.

type VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse will be returned.

func (*VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayConnectionsClientResetSharedKeyPollerResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientResetSharedKeyPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayConnectionsClientResetSharedKeyPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientResetSharedKeyPollerResponse contains the response from method VirtualNetworkGatewayConnectionsClient.ResetSharedKey.

func (VirtualNetworkGatewayConnectionsClientResetSharedKeyPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayConnectionsClientResetSharedKeyPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayConnectionsClientResetSharedKeyPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayConnectionsClientResetSharedKeyPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayConnectionsClient, token string) error

Resume rehydrates a VirtualNetworkGatewayConnectionsClientResetSharedKeyPollerResponse from the provided client and resume token.

type VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse struct {
	VirtualNetworkGatewayConnectionsClientResetSharedKeyResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse contains the response from method VirtualNetworkGatewayConnectionsClient.ResetSharedKey.

type VirtualNetworkGatewayConnectionsClientResetSharedKeyResult added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientResetSharedKeyResult struct {
	ConnectionResetSharedKey
}

VirtualNetworkGatewayConnectionsClientResetSharedKeyResult contains the result from method VirtualNetworkGatewayConnectionsClient.ResetSharedKey.

type VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse will be returned.

func (*VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayConnectionsClientSetSharedKeyPollerResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientSetSharedKeyPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayConnectionsClientSetSharedKeyPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientSetSharedKeyPollerResponse contains the response from method VirtualNetworkGatewayConnectionsClient.SetSharedKey.

func (VirtualNetworkGatewayConnectionsClientSetSharedKeyPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayConnectionsClientSetSharedKeyPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayConnectionsClientSetSharedKeyPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayConnectionsClientSetSharedKeyPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayConnectionsClient, token string) error

Resume rehydrates a VirtualNetworkGatewayConnectionsClientSetSharedKeyPollerResponse from the provided client and resume token.

type VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse struct {
	VirtualNetworkGatewayConnectionsClientSetSharedKeyResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse contains the response from method VirtualNetworkGatewayConnectionsClient.SetSharedKey.

type VirtualNetworkGatewayConnectionsClientSetSharedKeyResult added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientSetSharedKeyResult struct {
	ConnectionSharedKey
}

VirtualNetworkGatewayConnectionsClientSetSharedKeyResult contains the result from method VirtualNetworkGatewayConnectionsClient.SetSharedKey.

type VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse will be returned.

func (*VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayConnectionsClientStartPacketCapturePollerResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientStartPacketCapturePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayConnectionsClientStartPacketCapturePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientStartPacketCapturePollerResponse contains the response from method VirtualNetworkGatewayConnectionsClient.StartPacketCapture.

func (VirtualNetworkGatewayConnectionsClientStartPacketCapturePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayConnectionsClientStartPacketCapturePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayConnectionsClientStartPacketCapturePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayConnectionsClientStartPacketCapturePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayConnectionsClient, token string) error

Resume rehydrates a VirtualNetworkGatewayConnectionsClientStartPacketCapturePollerResponse from the provided client and resume token.

type VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse struct {
	VirtualNetworkGatewayConnectionsClientStartPacketCaptureResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse contains the response from method VirtualNetworkGatewayConnectionsClient.StartPacketCapture.

type VirtualNetworkGatewayConnectionsClientStartPacketCaptureResult added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientStartPacketCaptureResult struct {
	Value *string
}

VirtualNetworkGatewayConnectionsClientStartPacketCaptureResult contains the result from method VirtualNetworkGatewayConnectionsClient.StartPacketCapture.

type VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse will be returned.

func (*VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayConnectionsClientStopPacketCapturePollerResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientStopPacketCapturePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayConnectionsClientStopPacketCapturePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientStopPacketCapturePollerResponse contains the response from method VirtualNetworkGatewayConnectionsClient.StopPacketCapture.

func (VirtualNetworkGatewayConnectionsClientStopPacketCapturePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayConnectionsClientStopPacketCapturePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayConnectionsClientStopPacketCapturePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayConnectionsClientStopPacketCapturePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayConnectionsClient, token string) error

Resume rehydrates a VirtualNetworkGatewayConnectionsClientStopPacketCapturePollerResponse from the provided client and resume token.

type VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse struct {
	VirtualNetworkGatewayConnectionsClientStopPacketCaptureResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse contains the response from method VirtualNetworkGatewayConnectionsClient.StopPacketCapture.

type VirtualNetworkGatewayConnectionsClientStopPacketCaptureResult added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientStopPacketCaptureResult struct {
	Value *string
}

VirtualNetworkGatewayConnectionsClientStopPacketCaptureResult contains the result from method VirtualNetworkGatewayConnectionsClient.StopPacketCapture.

type VirtualNetworkGatewayConnectionsClientUpdateTagsPoller added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientUpdateTagsPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayConnectionsClientUpdateTagsPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayConnectionsClientUpdateTagsPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientUpdateTagsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayConnectionsClientUpdateTagsPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientUpdateTagsPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayConnectionsClientUpdateTagsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayConnectionsClientUpdateTagsResponse will be returned.

func (*VirtualNetworkGatewayConnectionsClientUpdateTagsPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientUpdateTagsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayConnectionsClientUpdateTagsPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayConnectionsClientUpdateTagsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayConnectionsClientUpdateTagsPollerResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientUpdateTagsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayConnectionsClientUpdateTagsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientUpdateTagsPollerResponse contains the response from method VirtualNetworkGatewayConnectionsClient.UpdateTags.

func (VirtualNetworkGatewayConnectionsClientUpdateTagsPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayConnectionsClientUpdateTagsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayConnectionsClientUpdateTagsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayConnectionsClientUpdateTagsPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayConnectionsClientUpdateTagsPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayConnectionsClient, token string) error

Resume rehydrates a VirtualNetworkGatewayConnectionsClientUpdateTagsPollerResponse from the provided client and resume token.

type VirtualNetworkGatewayConnectionsClientUpdateTagsResponse added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientUpdateTagsResponse struct {
	VirtualNetworkGatewayConnectionsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayConnectionsClientUpdateTagsResponse contains the response from method VirtualNetworkGatewayConnectionsClient.UpdateTags.

type VirtualNetworkGatewayConnectionsClientUpdateTagsResult added in v0.3.0 

type VirtualNetworkGatewayConnectionsClientUpdateTagsResult struct {
	VirtualNetworkGatewayConnection
}

VirtualNetworkGatewayConnectionsClientUpdateTagsResult contains the result from method VirtualNetworkGatewayConnectionsClient.UpdateTags.

type VirtualNetworkGatewayIPConfiguration 

type VirtualNetworkGatewayIPConfiguration struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the virtual network gateway ip configuration.
	Properties *VirtualNetworkGatewayIPConfigurationPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

VirtualNetworkGatewayIPConfiguration - IP configuration for virtual network gateway.

type VirtualNetworkGatewayIPConfigurationPropertiesFormat 

type VirtualNetworkGatewayIPConfigurationPropertiesFormat struct {
	// The private IP address allocation method.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// The reference to the public IP resource.
	PublicIPAddress *SubResource `json:"publicIPAddress,omitempty"`

	// The reference to the subnet resource.
	Subnet *SubResource `json:"subnet,omitempty"`

	// READ-ONLY; Private IP Address for this gateway.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the virtual network gateway IP configuration resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VirtualNetworkGatewayIPConfigurationPropertiesFormat - Properties of VirtualNetworkGatewayIPConfiguration.

type VirtualNetworkGatewayListConnectionsResult 

type VirtualNetworkGatewayListConnectionsResult struct {
	// A list of VirtualNetworkGatewayConnection resources that exists in a resource group.
	Value []*VirtualNetworkGatewayConnectionListEntity `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

VirtualNetworkGatewayListConnectionsResult - Response for the VirtualNetworkGatewayListConnections API service call.

func (VirtualNetworkGatewayListConnectionsResult) MarshalJSON 

func (v VirtualNetworkGatewayListConnectionsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayListConnectionsResult.

type VirtualNetworkGatewayListResult 

type VirtualNetworkGatewayListResult struct {
	// A list of VirtualNetworkGateway resources that exists in a resource group.
	Value []*VirtualNetworkGateway `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

VirtualNetworkGatewayListResult - Response for the ListVirtualNetworkGateways API service call.

func (VirtualNetworkGatewayListResult) MarshalJSON 

func (v VirtualNetworkGatewayListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayListResult.

type VirtualNetworkGatewayNatRule 

type VirtualNetworkGatewayNatRule struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the Virtual Network Gateway NAT rule.
	Properties *VirtualNetworkGatewayNatRuleProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualNetworkGatewayNatRule Resource.

type VirtualNetworkGatewayNatRuleProperties 

type VirtualNetworkGatewayNatRuleProperties struct {
	// The private IP address external mapping for NAT.
	ExternalMappings []*VPNNatRuleMapping `json:"externalMappings,omitempty"`

	// The IP Configuration ID this NAT rule applies to.
	IPConfigurationID *string `json:"ipConfigurationId,omitempty"`

	// The private IP address internal mapping for NAT.
	InternalMappings []*VPNNatRuleMapping `json:"internalMappings,omitempty"`

	// The Source NAT direction of a VPN NAT.
	Mode *VPNNatRuleMode `json:"mode,omitempty"`

	// The type of NAT rule for VPN NAT.
	Type *VPNNatRuleType `json:"type,omitempty"`

	// READ-ONLY; The provisioning state of the NAT Rule resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VirtualNetworkGatewayNatRuleProperties - Parameters for VirtualNetworkGatewayNatRule.

func (VirtualNetworkGatewayNatRuleProperties) MarshalJSON 

func (v VirtualNetworkGatewayNatRuleProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayNatRuleProperties.

type VirtualNetworkGatewayNatRulesClient 

type VirtualNetworkGatewayNatRulesClient struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayNatRulesClient contains the methods for the VirtualNetworkGatewayNatRules group. Don't use this type directly, use NewVirtualNetworkGatewayNatRulesClient() instead.

func NewVirtualNetworkGatewayNatRulesClient 

func NewVirtualNetworkGatewayNatRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualNetworkGatewayNatRulesClient

NewVirtualNetworkGatewayNatRulesClient creates a new instance of VirtualNetworkGatewayNatRulesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualNetworkGatewayNatRulesClient) BeginCreateOrUpdate 

func (client *VirtualNetworkGatewayNatRulesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, natRuleName string, natRuleParameters VirtualNetworkGatewayNatRule, options *VirtualNetworkGatewayNatRulesClientBeginCreateOrUpdateOptions) (VirtualNetworkGatewayNatRulesClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the Virtual Network Gateway. virtualNetworkGatewayName - The name of the gateway. natRuleName - The name of the nat rule. natRuleParameters - Parameters supplied to create or Update a Nat Rule. options - VirtualNetworkGatewayNatRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayNatRulePut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayNatRulesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		"<nat-rule-name>",
		armnetwork.VirtualNetworkGatewayNatRule{
			Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
				Type: armnetwork.VPNNatRuleType("Static").ToPtr(),
				ExternalMappings: []*armnetwork.VPNNatRuleMapping{
					{
						AddressSpace: to.StringPtr("<address-space>"),
						PortRange:    to.StringPtr("<port-range>"),
					}},
				InternalMappings: []*armnetwork.VPNNatRuleMapping{
					{
						AddressSpace: to.StringPtr("<address-space>"),
						PortRange:    to.StringPtr("<port-range>"),
					}},
				IPConfigurationID: to.StringPtr("<ipconfiguration-id>"),
				Mode:              armnetwork.VPNNatRuleMode("EgressSnat").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayNatRulesClientCreateOrUpdateResult)
}

Output:

func (*VirtualNetworkGatewayNatRulesClient) BeginDelete 

func (client *VirtualNetworkGatewayNatRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, natRuleName string, options *VirtualNetworkGatewayNatRulesClientBeginDeleteOptions) (VirtualNetworkGatewayNatRulesClientDeletePollerResponse, error)

BeginDelete - Deletes a nat rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the Virtual Network Gateway. virtualNetworkGatewayName - The name of the gateway. natRuleName - The name of the nat rule. options - VirtualNetworkGatewayNatRulesClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayNatRuleDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayNatRulesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		"<nat-rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualNetworkGatewayNatRulesClient) Get 

func (client *VirtualNetworkGatewayNatRulesClient) Get(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, natRuleName string, options *VirtualNetworkGatewayNatRulesClientGetOptions) (VirtualNetworkGatewayNatRulesClientGetResponse, error)

Get - Retrieves the details of a nat rule. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the Virtual Network Gateway. virtualNetworkGatewayName - The name of the gateway. natRuleName - The name of the nat rule. options - VirtualNetworkGatewayNatRulesClientGetOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayNatRuleGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayNatRulesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		"<nat-rule-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewayNatRulesClientGetResult)
}

Output:

func (*VirtualNetworkGatewayNatRulesClient) ListByVirtualNetworkGateway 

func (client *VirtualNetworkGatewayNatRulesClient) ListByVirtualNetworkGateway(resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayOptions) *VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayPager

ListByVirtualNetworkGateway - Retrieves all nat rules for a particular virtual network gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the virtual network gateway. virtualNetworkGatewayName - The name of the gateway. options - VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.ListByVirtualNetworkGateway method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayNatRuleList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewayNatRulesClient("<subscription-id>", cred, nil)
	pager := client.ListByVirtualNetworkGateway("<resource-group-name>",
		"<virtual-network-gateway-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VirtualNetworkGatewayNatRulesClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientBeginCreateOrUpdateOptions struct {
}

VirtualNetworkGatewayNatRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.BeginCreateOrUpdate method.

type VirtualNetworkGatewayNatRulesClientBeginDeleteOptions added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientBeginDeleteOptions struct {
}

VirtualNetworkGatewayNatRulesClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.BeginDelete method.

type VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayNatRulesClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayNatRulesClientCreateOrUpdateResponse will be returned.

func (*VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayNatRulesClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayNatRulesClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayNatRulesClientCreateOrUpdatePollerResponse contains the response from method VirtualNetworkGatewayNatRulesClient.CreateOrUpdate.

func (VirtualNetworkGatewayNatRulesClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayNatRulesClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayNatRulesClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayNatRulesClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayNatRulesClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayNatRulesClient, token string) error

Resume rehydrates a VirtualNetworkGatewayNatRulesClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualNetworkGatewayNatRulesClientCreateOrUpdateResponse added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientCreateOrUpdateResponse struct {
	VirtualNetworkGatewayNatRulesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayNatRulesClientCreateOrUpdateResponse contains the response from method VirtualNetworkGatewayNatRulesClient.CreateOrUpdate.

type VirtualNetworkGatewayNatRulesClientCreateOrUpdateResult added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientCreateOrUpdateResult struct {
	VirtualNetworkGatewayNatRule
}

VirtualNetworkGatewayNatRulesClientCreateOrUpdateResult contains the result from method VirtualNetworkGatewayNatRulesClient.CreateOrUpdate.

type VirtualNetworkGatewayNatRulesClientDeletePoller added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayNatRulesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewayNatRulesClientDeletePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewayNatRulesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientDeletePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewayNatRulesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewayNatRulesClientDeleteResponse will be returned.

func (*VirtualNetworkGatewayNatRulesClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewayNatRulesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewayNatRulesClientDeletePollerResponse added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewayNatRulesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayNatRulesClientDeletePollerResponse contains the response from method VirtualNetworkGatewayNatRulesClient.Delete.

func (VirtualNetworkGatewayNatRulesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewayNatRulesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewayNatRulesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewayNatRulesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewayNatRulesClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewayNatRulesClient, token string) error

Resume rehydrates a VirtualNetworkGatewayNatRulesClientDeletePollerResponse from the provided client and resume token.

type VirtualNetworkGatewayNatRulesClientDeleteResponse added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayNatRulesClientDeleteResponse contains the response from method VirtualNetworkGatewayNatRulesClient.Delete.

type VirtualNetworkGatewayNatRulesClientGetOptions added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientGetOptions struct {
}

VirtualNetworkGatewayNatRulesClientGetOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.Get method.

type VirtualNetworkGatewayNatRulesClientGetResponse added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientGetResponse struct {
	VirtualNetworkGatewayNatRulesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayNatRulesClientGetResponse contains the response from method VirtualNetworkGatewayNatRulesClient.Get.

type VirtualNetworkGatewayNatRulesClientGetResult added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientGetResult struct {
	VirtualNetworkGatewayNatRule
}

VirtualNetworkGatewayNatRulesClientGetResult contains the result from method VirtualNetworkGatewayNatRulesClient.Get.

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayOptions added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayOptions struct {
}

VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.ListByVirtualNetworkGateway method.

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayPager added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayPager struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayPager provides operations for iterating over paged responses.

func (*VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayPager) Err added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayPager) NextPage added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayPager) PageResponse added in v0.3.0 

func (p *VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayPager) PageResponse() VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResponse

PageResponse returns the current VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResponse page.

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResponse added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResponse struct {
	VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResponse contains the response from method VirtualNetworkGatewayNatRulesClient.ListByVirtualNetworkGateway.

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResult added in v0.3.0 

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResult struct {
	ListVirtualNetworkGatewayNatRulesResult
}

VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResult contains the result from method VirtualNetworkGatewayNatRulesClient.ListByVirtualNetworkGateway.

type VirtualNetworkGatewayPropertiesFormat 

type VirtualNetworkGatewayPropertiesFormat struct {
	// ActiveActive flag.
	Active *bool `json:"activeActive,omitempty"`

	// Virtual network gateway's BGP speaker settings.
	BgpSettings *BgpSettings `json:"bgpSettings,omitempty"`

	// The reference to the address space resource which represents the custom routes address space specified by the customer
	// for virtual network gateway and VpnClient.
	CustomRoutes *AddressSpace `json:"customRoutes,omitempty"`

	// disableIPSecReplayProtection flag.
	DisableIPSecReplayProtection *bool `json:"disableIPSecReplayProtection,omitempty"`

	// Whether BGP is enabled for this virtual network gateway or not.
	EnableBgp *bool `json:"enableBgp,omitempty"`

	// EnableBgpRouteTranslationForNat flag.
	EnableBgpRouteTranslationForNat *bool `json:"enableBgpRouteTranslationForNat,omitempty"`

	// Whether dns forwarding is enabled or not.
	EnableDNSForwarding *bool `json:"enableDnsForwarding,omitempty"`

	// Whether private IP needs to be enabled on this gateway for connections or not.
	EnablePrivateIPAddress *bool `json:"enablePrivateIpAddress,omitempty"`

	// The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null
	// value in case of removing existing default site setting.
	GatewayDefaultSite *SubResource `json:"gatewayDefaultSite,omitempty"`

	// The type of this virtual network gateway.
	GatewayType *VirtualNetworkGatewayType `json:"gatewayType,omitempty"`

	// IP configurations for virtual network gateway.
	IPConfigurations []*VirtualNetworkGatewayIPConfiguration `json:"ipConfigurations,omitempty"`

	// NatRules for virtual network gateway.
	NatRules []*VirtualNetworkGatewayNatRule `json:"natRules,omitempty"`

	// The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
	SKU *VirtualNetworkGatewaySKU `json:"sku,omitempty"`

	// Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
	VNetExtendedLocationResourceID *string `json:"vNetExtendedLocationResourceId,omitempty"`

	// The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
	VPNClientConfiguration *VPNClientConfiguration `json:"vpnClientConfiguration,omitempty"`

	// The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
	VPNGatewayGeneration *VPNGatewayGeneration `json:"vpnGatewayGeneration,omitempty"`

	// The type of this virtual network gateway.
	VPNType *VPNType `json:"vpnType,omitempty"`

	// READ-ONLY; The IP address allocated by the gateway to which dns requests can be sent.
	InboundDNSForwardingEndpoint *string `json:"inboundDnsForwardingEndpoint,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the virtual network gateway resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the virtual network gateway resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

VirtualNetworkGatewayPropertiesFormat - VirtualNetworkGateway properties.

func (VirtualNetworkGatewayPropertiesFormat) MarshalJSON 

func (v VirtualNetworkGatewayPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayPropertiesFormat.

type VirtualNetworkGatewaySKU 

type VirtualNetworkGatewaySKU struct {
	// Gateway SKU name.
	Name *VirtualNetworkGatewaySKUName `json:"name,omitempty"`

	// Gateway SKU tier.
	Tier *VirtualNetworkGatewaySKUTier `json:"tier,omitempty"`

	// READ-ONLY; The capacity.
	Capacity *int32 `json:"capacity,omitempty" azure:"ro"`
}

VirtualNetworkGatewaySKU - VirtualNetworkGatewaySku details.

type VirtualNetworkGatewaySKUName 

type VirtualNetworkGatewaySKUName string

VirtualNetworkGatewaySKUName - Gateway SKU name. 

const (
	VirtualNetworkGatewaySKUNameBasic            VirtualNetworkGatewaySKUName = "Basic"
	VirtualNetworkGatewaySKUNameErGw1AZ          VirtualNetworkGatewaySKUName = "ErGw1AZ"
	VirtualNetworkGatewaySKUNameErGw2AZ          VirtualNetworkGatewaySKUName = "ErGw2AZ"
	VirtualNetworkGatewaySKUNameErGw3AZ          VirtualNetworkGatewaySKUName = "ErGw3AZ"
	VirtualNetworkGatewaySKUNameHighPerformance  VirtualNetworkGatewaySKUName = "HighPerformance"
	VirtualNetworkGatewaySKUNameStandard         VirtualNetworkGatewaySKUName = "Standard"
	VirtualNetworkGatewaySKUNameUltraPerformance VirtualNetworkGatewaySKUName = "UltraPerformance"
	VirtualNetworkGatewaySKUNameVPNGw1           VirtualNetworkGatewaySKUName = "VpnGw1"
	VirtualNetworkGatewaySKUNameVPNGw1AZ         VirtualNetworkGatewaySKUName = "VpnGw1AZ"
	VirtualNetworkGatewaySKUNameVPNGw2           VirtualNetworkGatewaySKUName = "VpnGw2"
	VirtualNetworkGatewaySKUNameVPNGw2AZ         VirtualNetworkGatewaySKUName = "VpnGw2AZ"
	VirtualNetworkGatewaySKUNameVPNGw3           VirtualNetworkGatewaySKUName = "VpnGw3"
	VirtualNetworkGatewaySKUNameVPNGw3AZ         VirtualNetworkGatewaySKUName = "VpnGw3AZ"
	VirtualNetworkGatewaySKUNameVPNGw4           VirtualNetworkGatewaySKUName = "VpnGw4"
	VirtualNetworkGatewaySKUNameVPNGw4AZ         VirtualNetworkGatewaySKUName = "VpnGw4AZ"
	VirtualNetworkGatewaySKUNameVPNGw5           VirtualNetworkGatewaySKUName = "VpnGw5"
	VirtualNetworkGatewaySKUNameVPNGw5AZ         VirtualNetworkGatewaySKUName = "VpnGw5AZ"
)

func PossibleVirtualNetworkGatewaySKUNameValues 

func PossibleVirtualNetworkGatewaySKUNameValues() []VirtualNetworkGatewaySKUName

PossibleVirtualNetworkGatewaySKUNameValues returns the possible values for the VirtualNetworkGatewaySKUName const type.

func (VirtualNetworkGatewaySKUName) ToPtr 

func (c VirtualNetworkGatewaySKUName) ToPtr() *VirtualNetworkGatewaySKUName

ToPtr returns a *VirtualNetworkGatewaySKUName pointing to the current value.

type VirtualNetworkGatewaySKUTier 

type VirtualNetworkGatewaySKUTier string

VirtualNetworkGatewaySKUTier - Gateway SKU tier. 

const (
	VirtualNetworkGatewaySKUTierBasic            VirtualNetworkGatewaySKUTier = "Basic"
	VirtualNetworkGatewaySKUTierErGw1AZ          VirtualNetworkGatewaySKUTier = "ErGw1AZ"
	VirtualNetworkGatewaySKUTierErGw2AZ          VirtualNetworkGatewaySKUTier = "ErGw2AZ"
	VirtualNetworkGatewaySKUTierErGw3AZ          VirtualNetworkGatewaySKUTier = "ErGw3AZ"
	VirtualNetworkGatewaySKUTierHighPerformance  VirtualNetworkGatewaySKUTier = "HighPerformance"
	VirtualNetworkGatewaySKUTierStandard         VirtualNetworkGatewaySKUTier = "Standard"
	VirtualNetworkGatewaySKUTierUltraPerformance VirtualNetworkGatewaySKUTier = "UltraPerformance"
	VirtualNetworkGatewaySKUTierVPNGw1           VirtualNetworkGatewaySKUTier = "VpnGw1"
	VirtualNetworkGatewaySKUTierVPNGw1AZ         VirtualNetworkGatewaySKUTier = "VpnGw1AZ"
	VirtualNetworkGatewaySKUTierVPNGw2           VirtualNetworkGatewaySKUTier = "VpnGw2"
	VirtualNetworkGatewaySKUTierVPNGw2AZ         VirtualNetworkGatewaySKUTier = "VpnGw2AZ"
	VirtualNetworkGatewaySKUTierVPNGw3           VirtualNetworkGatewaySKUTier = "VpnGw3"
	VirtualNetworkGatewaySKUTierVPNGw3AZ         VirtualNetworkGatewaySKUTier = "VpnGw3AZ"
	VirtualNetworkGatewaySKUTierVPNGw4           VirtualNetworkGatewaySKUTier = "VpnGw4"
	VirtualNetworkGatewaySKUTierVPNGw4AZ         VirtualNetworkGatewaySKUTier = "VpnGw4AZ"
	VirtualNetworkGatewaySKUTierVPNGw5           VirtualNetworkGatewaySKUTier = "VpnGw5"
	VirtualNetworkGatewaySKUTierVPNGw5AZ         VirtualNetworkGatewaySKUTier = "VpnGw5AZ"
)

func PossibleVirtualNetworkGatewaySKUTierValues 

func PossibleVirtualNetworkGatewaySKUTierValues() []VirtualNetworkGatewaySKUTier

PossibleVirtualNetworkGatewaySKUTierValues returns the possible values for the VirtualNetworkGatewaySKUTier const type.

func (VirtualNetworkGatewaySKUTier) ToPtr 

func (c VirtualNetworkGatewaySKUTier) ToPtr() *VirtualNetworkGatewaySKUTier

ToPtr returns a *VirtualNetworkGatewaySKUTier pointing to the current value.

type VirtualNetworkGatewayType 

type VirtualNetworkGatewayType string

VirtualNetworkGatewayType - The type of this virtual network gateway. 

const (
	VirtualNetworkGatewayTypeExpressRoute VirtualNetworkGatewayType = "ExpressRoute"
	VirtualNetworkGatewayTypeLocalGateway VirtualNetworkGatewayType = "LocalGateway"
	VirtualNetworkGatewayTypeVPN          VirtualNetworkGatewayType = "Vpn"
)

func PossibleVirtualNetworkGatewayTypeValues 

func PossibleVirtualNetworkGatewayTypeValues() []VirtualNetworkGatewayType

PossibleVirtualNetworkGatewayTypeValues returns the possible values for the VirtualNetworkGatewayType const type.

func (VirtualNetworkGatewayType) ToPtr 

func (c VirtualNetworkGatewayType) ToPtr() *VirtualNetworkGatewayType

ToPtr returns a *VirtualNetworkGatewayType pointing to the current value.

type VirtualNetworkGatewaysClient 

type VirtualNetworkGatewaysClient struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClient contains the methods for the VirtualNetworkGateways group. Don't use this type directly, use NewVirtualNetworkGatewaysClient() instead.

func NewVirtualNetworkGatewaysClient 

func NewVirtualNetworkGatewaysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualNetworkGatewaysClient

NewVirtualNetworkGatewaysClient creates a new instance of VirtualNetworkGatewaysClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualNetworkGatewaysClient) BeginCreateOrUpdate 

func (client *VirtualNetworkGatewaysClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, parameters VirtualNetworkGateway, options *VirtualNetworkGatewaysClientBeginCreateOrUpdateOptions) (VirtualNetworkGatewaysClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. parameters - Parameters supplied to create or update virtual network gateway operation. options - VirtualNetworkGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayUpdate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		armnetwork.VirtualNetworkGateway{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
				Active: to.BoolPtr(false),
				BgpSettings: &armnetwork.BgpSettings{
					Asn:               to.Int64Ptr(65515),
					BgpPeeringAddress: to.StringPtr("<bgp-peering-address>"),
					PeerWeight:        to.Int32Ptr(0),
				},
				CustomRoutes: &armnetwork.AddressSpace{
					AddressPrefixes: []*string{
						to.StringPtr("101.168.0.6/32")},
				},
				DisableIPSecReplayProtection:    to.BoolPtr(false),
				EnableBgp:                       to.BoolPtr(false),
				EnableBgpRouteTranslationForNat: to.BoolPtr(false),
				EnableDNSForwarding:             to.BoolPtr(true),
				GatewayType:                     armnetwork.VirtualNetworkGatewayType("Vpn").ToPtr(),
				IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
					{
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
							PrivateIPAllocationMethod: armnetwork.IPAllocationMethod("Dynamic").ToPtr(),
							PublicIPAddress: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
							Subnet: &armnetwork.SubResource{
								ID: to.StringPtr("<id>"),
							},
						},
					}},
				NatRules: []*armnetwork.VirtualNetworkGatewayNatRule{
					{
						ID:   to.StringPtr("<id>"),
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
							Type: armnetwork.VPNNatRuleType("Static").ToPtr(),
							ExternalMappings: []*armnetwork.VPNNatRuleMapping{
								{
									AddressSpace: to.StringPtr("<address-space>"),
								}},
							InternalMappings: []*armnetwork.VPNNatRuleMapping{
								{
									AddressSpace: to.StringPtr("<address-space>"),
								}},
							IPConfigurationID: to.StringPtr("<ipconfiguration-id>"),
							Mode:              armnetwork.VPNNatRuleMode("EgressSnat").ToPtr(),
						},
					},
					{
						ID:   to.StringPtr("<id>"),
						Name: to.StringPtr("<name>"),
						Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
							Type: armnetwork.VPNNatRuleType("Static").ToPtr(),
							ExternalMappings: []*armnetwork.VPNNatRuleMapping{
								{
									AddressSpace: to.StringPtr("<address-space>"),
								}},
							InternalMappings: []*armnetwork.VPNNatRuleMapping{
								{
									AddressSpace: to.StringPtr("<address-space>"),
								}},
							IPConfigurationID: to.StringPtr("<ipconfiguration-id>"),
							Mode:              armnetwork.VPNNatRuleMode("IngressSnat").ToPtr(),
						},
					}},
				SKU: &armnetwork.VirtualNetworkGatewaySKU{
					Name: armnetwork.VirtualNetworkGatewaySKUName("VpnGw1").ToPtr(),
					Tier: armnetwork.VirtualNetworkGatewaySKUTier("VpnGw1").ToPtr(),
				},
				VPNClientConfiguration: &armnetwork.VPNClientConfiguration{
					RadiusServers: []*armnetwork.RadiusServer{
						{
							RadiusServerAddress: to.StringPtr("<radius-server-address>"),
							RadiusServerScore:   to.Int64Ptr(20),
							RadiusServerSecret:  to.StringPtr("<radius-server-secret>"),
						}},
					VPNClientProtocols: []*armnetwork.VPNClientProtocol{
						armnetwork.VPNClientProtocol("OpenVPN").ToPtr()},
					VPNClientRevokedCertificates: []*armnetwork.VPNClientRevokedCertificate{},
					VPNClientRootCertificates:    []*armnetwork.VPNClientRootCertificate{},
				},
				VPNType: armnetwork.VPNType("RouteBased").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientCreateOrUpdateResult)
}

Output:

func (*VirtualNetworkGatewaysClient) BeginDelete 

func (client *VirtualNetworkGatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientBeginDeleteOptions) (VirtualNetworkGatewaysClientDeletePollerResponse, error)

BeginDelete - Deletes the specified virtual network gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualNetworkGatewaysClient) BeginDisconnectVirtualNetworkGatewayVPNConnections 

func (client *VirtualNetworkGatewaysClient) BeginDisconnectVirtualNetworkGatewayVPNConnections(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, request P2SVPNConnectionRequest, options *VirtualNetworkGatewaysClientBeginDisconnectVirtualNetworkGatewayVPNConnectionsOptions) (VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPollerResponse, error)

BeginDisconnectVirtualNetworkGatewayVPNConnections - Disconnect vpn connections of virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. request - The parameters are supplied to disconnect vpn connections. options - VirtualNetworkGatewaysClientBeginDisconnectVirtualNetworkGatewayVPNConnectionsOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginDisconnectVirtualNetworkGatewayVPNConnections method.

func (*VirtualNetworkGatewaysClient) BeginGenerateVPNProfile 

func (client *VirtualNetworkGatewaysClient) BeginGenerateVPNProfile(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, parameters VPNClientParameters, options *VirtualNetworkGatewaysClientBeginGenerateVPNProfileOptions) (VirtualNetworkGatewaysClientGenerateVPNProfilePollerResponse, error)

BeginGenerateVPNProfile - Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. parameters - Parameters supplied to the generate virtual network gateway VPN client package operation. options - VirtualNetworkGatewaysClientBeginGenerateVPNProfileOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGenerateVPNProfile method.

func (*VirtualNetworkGatewaysClient) BeginGeneratevpnclientpackage 

func (client *VirtualNetworkGatewaysClient) BeginGeneratevpnclientpackage(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, parameters VPNClientParameters, options *VirtualNetworkGatewaysClientBeginGeneratevpnclientpackageOptions) (VirtualNetworkGatewaysClientGeneratevpnclientpackagePollerResponse, error)

BeginGeneratevpnclientpackage - Generates VPN client package for P2S client of the virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. parameters - Parameters supplied to the generate virtual network gateway VPN client package operation. options - VirtualNetworkGatewaysClientBeginGeneratevpnclientpackageOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGeneratevpnclientpackage method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGeneratevpnclientpackage(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		armnetwork.VPNClientParameters{},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientGeneratevpnclientpackageResult)
}

Output:

func (*VirtualNetworkGatewaysClient) BeginGetAdvertisedRoutes 

func (client *VirtualNetworkGatewaysClient) BeginGetAdvertisedRoutes(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, peer string, options *VirtualNetworkGatewaysClientBeginGetAdvertisedRoutesOptions) (VirtualNetworkGatewaysClientGetAdvertisedRoutesPollerResponse, error)

BeginGetAdvertisedRoutes - This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. peer - The IP address of the peer. options - VirtualNetworkGatewaysClientBeginGetAdvertisedRoutesOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetAdvertisedRoutes method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetAdvertisedRoutes(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		"<peer>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientGetAdvertisedRoutesResult)
}

Output:

func (*VirtualNetworkGatewaysClient) BeginGetBgpPeerStatus 

func (client *VirtualNetworkGatewaysClient) BeginGetBgpPeerStatus(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions) (VirtualNetworkGatewaysClientGetBgpPeerStatusPollerResponse, error)

BeginGetBgpPeerStatus - The GetBgpPeerStatus operation retrieves the status of all BGP peers. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetBgpPeerStatus method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetBgpPeerStatus(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		&armnetwork.VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions{Peer: nil})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientGetBgpPeerStatusResult)
}

Output:

func (*VirtualNetworkGatewaysClient) BeginGetLearnedRoutes 

func (client *VirtualNetworkGatewaysClient) BeginGetLearnedRoutes(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientBeginGetLearnedRoutesOptions) (VirtualNetworkGatewaysClientGetLearnedRoutesPollerResponse, error)

BeginGetLearnedRoutes - This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientBeginGetLearnedRoutesOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetLearnedRoutes method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayLearnedRoutes.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetLearnedRoutes(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientGetLearnedRoutesResult)
}

Output:

func (*VirtualNetworkGatewaysClient) BeginGetVPNProfilePackageURL 

func (client *VirtualNetworkGatewaysClient) BeginGetVPNProfilePackageURL(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientBeginGetVPNProfilePackageURLOptions) (VirtualNetworkGatewaysClientGetVPNProfilePackageURLPollerResponse, error)

BeginGetVPNProfilePackageURL - Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientBeginGetVPNProfilePackageURLOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetVPNProfilePackageURL method.

func (*VirtualNetworkGatewaysClient) BeginGetVpnclientConnectionHealth 

func (client *VirtualNetworkGatewaysClient) BeginGetVpnclientConnectionHealth(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientBeginGetVpnclientConnectionHealthOptions) (VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPollerResponse, error)

BeginGetVpnclientConnectionHealth - Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientBeginGetVpnclientConnectionHealthOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetVpnclientConnectionHealth method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetVpnclientConnectionHealth(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResult)
}

Output:

func (*VirtualNetworkGatewaysClient) BeginGetVpnclientIPSecParameters 

func (client *VirtualNetworkGatewaysClient) BeginGetVpnclientIPSecParameters(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientBeginGetVpnclientIPSecParametersOptions) (VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPollerResponse, error)

BeginGetVpnclientIPSecParameters - The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The virtual network gateway name. options - VirtualNetworkGatewaysClientBeginGetVpnclientIPSecParametersOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetVpnclientIPSecParameters method.

func (*VirtualNetworkGatewaysClient) BeginReset 

func (client *VirtualNetworkGatewaysClient) BeginReset(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientBeginResetOptions) (VirtualNetworkGatewaysClientResetPollerResponse, error)

BeginReset - Resets the primary of the virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientBeginResetOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginReset method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayReset.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginReset(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		&armnetwork.VirtualNetworkGatewaysClientBeginResetOptions{GatewayVip: nil})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientResetResult)
}

Output:

func (*VirtualNetworkGatewaysClient) BeginResetVPNClientSharedKey 

func (client *VirtualNetworkGatewaysClient) BeginResetVPNClientSharedKey(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientBeginResetVPNClientSharedKeyOptions) (VirtualNetworkGatewaysClientResetVPNClientSharedKeyPollerResponse, error)

BeginResetVPNClientSharedKey - Resets the VPN client shared key of the virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientBeginResetVPNClientSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginResetVPNClientSharedKey method.

func (*VirtualNetworkGatewaysClient) BeginSetVpnclientIPSecParameters 

func (client *VirtualNetworkGatewaysClient) BeginSetVpnclientIPSecParameters(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, vpnclientIPSecParams VPNClientIPsecParameters, options *VirtualNetworkGatewaysClientBeginSetVpnclientIPSecParametersOptions) (VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPollerResponse, error)

BeginSetVpnclientIPSecParameters - The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. vpnclientIPSecParams - Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider. options - VirtualNetworkGatewaysClientBeginSetVpnclientIPSecParametersOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginSetVpnclientIPSecParameters method.

func (*VirtualNetworkGatewaysClient) BeginStartPacketCapture 

func (client *VirtualNetworkGatewaysClient) BeginStartPacketCapture(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions) (VirtualNetworkGatewaysClientStartPacketCapturePollerResponse, error)

BeginStartPacketCapture - Starts packet capture on virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginStartPacketCapture method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStartPacketCapture(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		&armnetwork.VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions{Parameters: &armnetwork.VPNPacketCaptureStartParameters{
			FilterData: to.StringPtr("<filter-data>"),
		},
		})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientStartPacketCaptureResult)
}

Output:

func (*VirtualNetworkGatewaysClient) BeginStopPacketCapture 

func (client *VirtualNetworkGatewaysClient) BeginStopPacketCapture(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, parameters VPNPacketCaptureStopParameters, options *VirtualNetworkGatewaysClientBeginStopPacketCaptureOptions) (VirtualNetworkGatewaysClientStopPacketCapturePollerResponse, error)

BeginStopPacketCapture - Stops packet capture on virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. parameters - Virtual network gateway packet capture parameters supplied to stop packet capture on gateway. options - VirtualNetworkGatewaysClientBeginStopPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginStopPacketCapture method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayStopPacketCapture.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginStopPacketCapture(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		armnetwork.VPNPacketCaptureStopParameters{
			SasURL: to.StringPtr("<sas-url>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientStopPacketCaptureResult)
}

Output:

func (*VirtualNetworkGatewaysClient) BeginUpdateTags 

func (client *VirtualNetworkGatewaysClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, parameters TagsObject, options *VirtualNetworkGatewaysClientBeginUpdateTagsOptions) (VirtualNetworkGatewaysClientUpdateTagsPollerResponse, error)

BeginUpdateTags - Updates a virtual network gateway tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. parameters - Parameters supplied to update virtual network gateway tags. options - VirtualNetworkGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginUpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayUpdateTags.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdateTags(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientUpdateTagsResult)
}

Output:

func (*VirtualNetworkGatewaysClient) Get 

func (client *VirtualNetworkGatewaysClient) Get(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientGetOptions) (VirtualNetworkGatewaysClientGetResponse, error)

Get - Gets the specified virtual network gateway by resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientGetOptions contains the optional parameters for the VirtualNetworkGatewaysClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-network-gateway-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkGatewaysClientGetResult)
}

Output:

func (*VirtualNetworkGatewaysClient) List 

func (client *VirtualNetworkGatewaysClient) List(resourceGroupName string, options *VirtualNetworkGatewaysClientListOptions) *VirtualNetworkGatewaysClientListPager

List - Gets all virtual network gateways by resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - VirtualNetworkGatewaysClientListOptions contains the optional parameters for the VirtualNetworkGatewaysClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewayList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualNetworkGatewaysClient) ListConnections 

func (client *VirtualNetworkGatewaysClient) ListConnections(resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientListConnectionsOptions) *VirtualNetworkGatewaysClientListConnectionsPager

ListConnections - Gets all the connections in a virtual network gateway. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientListConnectionsOptions contains the optional parameters for the VirtualNetworkGatewaysClient.ListConnections method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGatewaysListConnections.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkGatewaysClient("<subscription-id>", cred, nil)
	pager := client.ListConnections("<resource-group-name>",
		"<virtual-network-gateway-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualNetworkGatewaysClient) SupportedVPNDevices 

func (client *VirtualNetworkGatewaysClient) SupportedVPNDevices(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientSupportedVPNDevicesOptions) (VirtualNetworkGatewaysClientSupportedVPNDevicesResponse, error)

SupportedVPNDevices - Gets a xml format representation for supported vpn devices. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The name of the virtual network gateway. options - VirtualNetworkGatewaysClientSupportedVPNDevicesOptions contains the optional parameters for the VirtualNetworkGatewaysClient.SupportedVPNDevices method.

func (*VirtualNetworkGatewaysClient) VPNDeviceConfigurationScript 

func (client *VirtualNetworkGatewaysClient) VPNDeviceConfigurationScript(ctx context.Context, resourceGroupName string, virtualNetworkGatewayConnectionName string, parameters VPNDeviceScriptParameters, options *VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptOptions) (VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResponse, error)

VPNDeviceConfigurationScript - Gets a xml format representation for vpn device configuration script. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkGatewayConnectionName - The name of the virtual network gateway connection for which the configuration script is generated. parameters - Parameters supplied to the generate vpn device script operation. options - VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptOptions contains the optional parameters for the VirtualNetworkGatewaysClient.VPNDeviceConfigurationScript method.

type VirtualNetworkGatewaysClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginCreateOrUpdateOptions struct {
}

VirtualNetworkGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginCreateOrUpdate method.

type VirtualNetworkGatewaysClientBeginDeleteOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginDeleteOptions struct {
}

VirtualNetworkGatewaysClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginDelete method.

type VirtualNetworkGatewaysClientBeginDisconnectVirtualNetworkGatewayVPNConnectionsOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginDisconnectVirtualNetworkGatewayVPNConnectionsOptions struct {
}

VirtualNetworkGatewaysClientBeginDisconnectVirtualNetworkGatewayVPNConnectionsOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginDisconnectVirtualNetworkGatewayVPNConnections method.

type VirtualNetworkGatewaysClientBeginGenerateVPNProfileOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginGenerateVPNProfileOptions struct {
}

VirtualNetworkGatewaysClientBeginGenerateVPNProfileOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGenerateVPNProfile method.

type VirtualNetworkGatewaysClientBeginGeneratevpnclientpackageOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginGeneratevpnclientpackageOptions struct {
}

VirtualNetworkGatewaysClientBeginGeneratevpnclientpackageOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGeneratevpnclientpackage method.

type VirtualNetworkGatewaysClientBeginGetAdvertisedRoutesOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginGetAdvertisedRoutesOptions struct {
}

VirtualNetworkGatewaysClientBeginGetAdvertisedRoutesOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetAdvertisedRoutes method.

type VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions struct {
	// The IP address of the peer to retrieve the status of.
	Peer *string
}

VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetBgpPeerStatus method.

type VirtualNetworkGatewaysClientBeginGetLearnedRoutesOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginGetLearnedRoutesOptions struct {
}

VirtualNetworkGatewaysClientBeginGetLearnedRoutesOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetLearnedRoutes method.

type VirtualNetworkGatewaysClientBeginGetVPNProfilePackageURLOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginGetVPNProfilePackageURLOptions struct {
}

VirtualNetworkGatewaysClientBeginGetVPNProfilePackageURLOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetVPNProfilePackageURL method.

type VirtualNetworkGatewaysClientBeginGetVpnclientConnectionHealthOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginGetVpnclientConnectionHealthOptions struct {
}

VirtualNetworkGatewaysClientBeginGetVpnclientConnectionHealthOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetVpnclientConnectionHealth method.

type VirtualNetworkGatewaysClientBeginGetVpnclientIPSecParametersOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginGetVpnclientIPSecParametersOptions struct {
}

VirtualNetworkGatewaysClientBeginGetVpnclientIPSecParametersOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetVpnclientIPSecParameters method.

type VirtualNetworkGatewaysClientBeginResetOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginResetOptions struct {
	// Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway.
	GatewayVip *string
}

VirtualNetworkGatewaysClientBeginResetOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginReset method.

type VirtualNetworkGatewaysClientBeginResetVPNClientSharedKeyOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginResetVPNClientSharedKeyOptions struct {
}

VirtualNetworkGatewaysClientBeginResetVPNClientSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginResetVPNClientSharedKey method.

type VirtualNetworkGatewaysClientBeginSetVpnclientIPSecParametersOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginSetVpnclientIPSecParametersOptions struct {
}

VirtualNetworkGatewaysClientBeginSetVpnclientIPSecParametersOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginSetVpnclientIPSecParameters method.

type VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions struct {
	// Virtual network gateway packet capture parameters supplied to start packet capture on gateway.
	Parameters *VPNPacketCaptureStartParameters
}

VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginStartPacketCapture method.

type VirtualNetworkGatewaysClientBeginStopPacketCaptureOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginStopPacketCaptureOptions struct {
}

VirtualNetworkGatewaysClientBeginStopPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginStopPacketCapture method.

type VirtualNetworkGatewaysClientBeginUpdateTagsOptions added in v0.3.0 

type VirtualNetworkGatewaysClientBeginUpdateTagsOptions struct {
}

VirtualNetworkGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginUpdateTags method.

type VirtualNetworkGatewaysClientCreateOrUpdatePoller added in v0.3.0 

type VirtualNetworkGatewaysClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientCreateOrUpdateResponse will be returned.

func (*VirtualNetworkGatewaysClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientCreateOrUpdatePollerResponse contains the response from method VirtualNetworkGatewaysClient.CreateOrUpdate.

func (VirtualNetworkGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientCreateOrUpdateResponse added in v0.3.0 

type VirtualNetworkGatewaysClientCreateOrUpdateResponse struct {
	VirtualNetworkGatewaysClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientCreateOrUpdateResponse contains the response from method VirtualNetworkGatewaysClient.CreateOrUpdate.

type VirtualNetworkGatewaysClientCreateOrUpdateResult added in v0.3.0 

type VirtualNetworkGatewaysClientCreateOrUpdateResult struct {
	VirtualNetworkGateway
}

VirtualNetworkGatewaysClientCreateOrUpdateResult contains the result from method VirtualNetworkGatewaysClient.CreateOrUpdate.

type VirtualNetworkGatewaysClientDeletePoller added in v0.3.0 

type VirtualNetworkGatewaysClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientDeletePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientDeletePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientDeleteResponse will be returned.

func (*VirtualNetworkGatewaysClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientDeletePollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientDeletePollerResponse contains the response from method VirtualNetworkGatewaysClient.Delete.

func (VirtualNetworkGatewaysClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientDeletePollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientDeleteResponse added in v0.3.0 

type VirtualNetworkGatewaysClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientDeleteResponse contains the response from method VirtualNetworkGatewaysClient.Delete.

type VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller added in v0.3.0 

type VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsResponse will be returned.

func (*VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPollerResponse contains the response from method VirtualNetworkGatewaysClient.DisconnectVirtualNetworkGatewayVPNConnections.

func (VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsResponse added in v0.3.0 

type VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsResponse contains the response from method VirtualNetworkGatewaysClient.DisconnectVirtualNetworkGatewayVPNConnections.

type VirtualNetworkGatewaysClientGenerateVPNProfilePoller added in v0.3.0 

type VirtualNetworkGatewaysClientGenerateVPNProfilePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientGenerateVPNProfilePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientGenerateVPNProfilePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGenerateVPNProfilePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientGenerateVPNProfilePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGenerateVPNProfilePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientGenerateVPNProfileResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientGenerateVPNProfileResponse will be returned.

func (*VirtualNetworkGatewaysClientGenerateVPNProfilePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGenerateVPNProfilePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientGenerateVPNProfilePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGenerateVPNProfilePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientGenerateVPNProfilePollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGenerateVPNProfilePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientGenerateVPNProfilePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGenerateVPNProfilePollerResponse contains the response from method VirtualNetworkGatewaysClient.GenerateVPNProfile.

func (VirtualNetworkGatewaysClientGenerateVPNProfilePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientGenerateVPNProfilePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientGenerateVPNProfileResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientGenerateVPNProfilePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientGenerateVPNProfilePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientGenerateVPNProfilePollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientGenerateVPNProfileResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGenerateVPNProfileResponse struct {
	VirtualNetworkGatewaysClientGenerateVPNProfileResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGenerateVPNProfileResponse contains the response from method VirtualNetworkGatewaysClient.GenerateVPNProfile.

type VirtualNetworkGatewaysClientGenerateVPNProfileResult added in v0.3.0 

type VirtualNetworkGatewaysClientGenerateVPNProfileResult struct {
	Value *string
}

VirtualNetworkGatewaysClientGenerateVPNProfileResult contains the result from method VirtualNetworkGatewaysClient.GenerateVPNProfile.

type VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller added in v0.3.0 

type VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse will be returned.

func (*VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientGeneratevpnclientpackagePollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGeneratevpnclientpackagePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientGeneratevpnclientpackagePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGeneratevpnclientpackagePollerResponse contains the response from method VirtualNetworkGatewaysClient.Generatevpnclientpackage.

func (VirtualNetworkGatewaysClientGeneratevpnclientpackagePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientGeneratevpnclientpackagePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientGeneratevpnclientpackagePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientGeneratevpnclientpackagePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientGeneratevpnclientpackagePollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse struct {
	VirtualNetworkGatewaysClientGeneratevpnclientpackageResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse contains the response from method VirtualNetworkGatewaysClient.Generatevpnclientpackage.

type VirtualNetworkGatewaysClientGeneratevpnclientpackageResult added in v0.3.0 

type VirtualNetworkGatewaysClientGeneratevpnclientpackageResult struct {
	Value *string
}

VirtualNetworkGatewaysClientGeneratevpnclientpackageResult contains the result from method VirtualNetworkGatewaysClient.Generatevpnclientpackage.

type VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller added in v0.3.0 

type VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientGetAdvertisedRoutesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientGetAdvertisedRoutesResponse will be returned.

func (*VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientGetAdvertisedRoutesPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetAdvertisedRoutesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientGetAdvertisedRoutesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetAdvertisedRoutesPollerResponse contains the response from method VirtualNetworkGatewaysClient.GetAdvertisedRoutes.

func (VirtualNetworkGatewaysClientGetAdvertisedRoutesPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientGetAdvertisedRoutesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientGetAdvertisedRoutesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientGetAdvertisedRoutesPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientGetAdvertisedRoutesPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientGetAdvertisedRoutesPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientGetAdvertisedRoutesResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetAdvertisedRoutesResponse struct {
	VirtualNetworkGatewaysClientGetAdvertisedRoutesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetAdvertisedRoutesResponse contains the response from method VirtualNetworkGatewaysClient.GetAdvertisedRoutes.

type VirtualNetworkGatewaysClientGetAdvertisedRoutesResult added in v0.3.0 

type VirtualNetworkGatewaysClientGetAdvertisedRoutesResult struct {
	GatewayRouteListResult
}

VirtualNetworkGatewaysClientGetAdvertisedRoutesResult contains the result from method VirtualNetworkGatewaysClient.GetAdvertisedRoutes.

type VirtualNetworkGatewaysClientGetBgpPeerStatusPoller added in v0.3.0 

type VirtualNetworkGatewaysClientGetBgpPeerStatusPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientGetBgpPeerStatusPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientGetBgpPeerStatusPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetBgpPeerStatusPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientGetBgpPeerStatusPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetBgpPeerStatusPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientGetBgpPeerStatusResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientGetBgpPeerStatusResponse will be returned.

func (*VirtualNetworkGatewaysClientGetBgpPeerStatusPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetBgpPeerStatusPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientGetBgpPeerStatusPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetBgpPeerStatusPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientGetBgpPeerStatusPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetBgpPeerStatusPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientGetBgpPeerStatusPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetBgpPeerStatusPollerResponse contains the response from method VirtualNetworkGatewaysClient.GetBgpPeerStatus.

func (VirtualNetworkGatewaysClientGetBgpPeerStatusPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientGetBgpPeerStatusPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientGetBgpPeerStatusResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientGetBgpPeerStatusPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientGetBgpPeerStatusPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientGetBgpPeerStatusPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientGetBgpPeerStatusResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetBgpPeerStatusResponse struct {
	VirtualNetworkGatewaysClientGetBgpPeerStatusResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetBgpPeerStatusResponse contains the response from method VirtualNetworkGatewaysClient.GetBgpPeerStatus.

type VirtualNetworkGatewaysClientGetBgpPeerStatusResult added in v0.3.0 

type VirtualNetworkGatewaysClientGetBgpPeerStatusResult struct {
	BgpPeerStatusListResult
}

VirtualNetworkGatewaysClientGetBgpPeerStatusResult contains the result from method VirtualNetworkGatewaysClient.GetBgpPeerStatus.

type VirtualNetworkGatewaysClientGetLearnedRoutesPoller added in v0.3.0 

type VirtualNetworkGatewaysClientGetLearnedRoutesPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientGetLearnedRoutesPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientGetLearnedRoutesPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetLearnedRoutesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientGetLearnedRoutesPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetLearnedRoutesPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientGetLearnedRoutesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientGetLearnedRoutesResponse will be returned.

func (*VirtualNetworkGatewaysClientGetLearnedRoutesPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetLearnedRoutesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientGetLearnedRoutesPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetLearnedRoutesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientGetLearnedRoutesPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetLearnedRoutesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientGetLearnedRoutesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetLearnedRoutesPollerResponse contains the response from method VirtualNetworkGatewaysClient.GetLearnedRoutes.

func (VirtualNetworkGatewaysClientGetLearnedRoutesPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientGetLearnedRoutesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientGetLearnedRoutesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientGetLearnedRoutesPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientGetLearnedRoutesPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientGetLearnedRoutesPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientGetLearnedRoutesResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetLearnedRoutesResponse struct {
	VirtualNetworkGatewaysClientGetLearnedRoutesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetLearnedRoutesResponse contains the response from method VirtualNetworkGatewaysClient.GetLearnedRoutes.

type VirtualNetworkGatewaysClientGetLearnedRoutesResult added in v0.3.0 

type VirtualNetworkGatewaysClientGetLearnedRoutesResult struct {
	GatewayRouteListResult
}

VirtualNetworkGatewaysClientGetLearnedRoutesResult contains the result from method VirtualNetworkGatewaysClient.GetLearnedRoutes.

type VirtualNetworkGatewaysClientGetOptions added in v0.3.0 

type VirtualNetworkGatewaysClientGetOptions struct {
}

VirtualNetworkGatewaysClientGetOptions contains the optional parameters for the VirtualNetworkGatewaysClient.Get method.

type VirtualNetworkGatewaysClientGetResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetResponse struct {
	VirtualNetworkGatewaysClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetResponse contains the response from method VirtualNetworkGatewaysClient.Get.

type VirtualNetworkGatewaysClientGetResult added in v0.3.0 

type VirtualNetworkGatewaysClientGetResult struct {
	VirtualNetworkGateway
}

VirtualNetworkGatewaysClientGetResult contains the result from method VirtualNetworkGatewaysClient.Get.

type VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller added in v0.3.0 

type VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse will be returned.

func (*VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientGetVPNProfilePackageURLPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetVPNProfilePackageURLPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientGetVPNProfilePackageURLPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetVPNProfilePackageURLPollerResponse contains the response from method VirtualNetworkGatewaysClient.GetVPNProfilePackageURL.

func (VirtualNetworkGatewaysClientGetVPNProfilePackageURLPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientGetVPNProfilePackageURLPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientGetVPNProfilePackageURLPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientGetVPNProfilePackageURLPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientGetVPNProfilePackageURLPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse struct {
	VirtualNetworkGatewaysClientGetVPNProfilePackageURLResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse contains the response from method VirtualNetworkGatewaysClient.GetVPNProfilePackageURL.

type VirtualNetworkGatewaysClientGetVPNProfilePackageURLResult added in v0.3.0 

type VirtualNetworkGatewaysClientGetVPNProfilePackageURLResult struct {
	Value *string
}

VirtualNetworkGatewaysClientGetVPNProfilePackageURLResult contains the result from method VirtualNetworkGatewaysClient.GetVPNProfilePackageURL.

type VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller added in v0.3.0 

type VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResponse will be returned.

func (*VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPollerResponse contains the response from method VirtualNetworkGatewaysClient.GetVpnclientConnectionHealth.

func (VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientGetVpnclientConnectionHealthPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResponse struct {
	VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResponse contains the response from method VirtualNetworkGatewaysClient.GetVpnclientConnectionHealth.

type VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResult added in v0.3.0 

type VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResult struct {
	VPNClientConnectionHealthDetailListResult
}

VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResult contains the result from method VirtualNetworkGatewaysClient.GetVpnclientConnectionHealth.

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller added in v0.3.0 

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse will be returned.

func (*VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPollerResponse contains the response from method VirtualNetworkGatewaysClient.GetVpnclientIPSecParameters.

func (VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientGetVpnclientIPSecParametersPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse added in v0.3.0 

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse struct {
	VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse contains the response from method VirtualNetworkGatewaysClient.GetVpnclientIPSecParameters.

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResult added in v0.3.0 

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResult struct {
	VPNClientIPsecParameters
}

VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResult contains the result from method VirtualNetworkGatewaysClient.GetVpnclientIPSecParameters.

type VirtualNetworkGatewaysClientListConnectionsOptions added in v0.3.0 

type VirtualNetworkGatewaysClientListConnectionsOptions struct {
}

VirtualNetworkGatewaysClientListConnectionsOptions contains the optional parameters for the VirtualNetworkGatewaysClient.ListConnections method.

type VirtualNetworkGatewaysClientListConnectionsPager added in v0.3.0 

type VirtualNetworkGatewaysClientListConnectionsPager struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientListConnectionsPager provides operations for iterating over paged responses.

func (*VirtualNetworkGatewaysClientListConnectionsPager) Err added in v0.3.0 

func (p *VirtualNetworkGatewaysClientListConnectionsPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualNetworkGatewaysClientListConnectionsPager) NextPage added in v0.3.0 

func (p *VirtualNetworkGatewaysClientListConnectionsPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworkGatewaysClientListConnectionsPager) PageResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientListConnectionsPager) PageResponse() VirtualNetworkGatewaysClientListConnectionsResponse

PageResponse returns the current VirtualNetworkGatewaysClientListConnectionsResponse page.

type VirtualNetworkGatewaysClientListConnectionsResponse added in v0.3.0 

type VirtualNetworkGatewaysClientListConnectionsResponse struct {
	VirtualNetworkGatewaysClientListConnectionsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientListConnectionsResponse contains the response from method VirtualNetworkGatewaysClient.ListConnections.

type VirtualNetworkGatewaysClientListConnectionsResult added in v0.3.0 

type VirtualNetworkGatewaysClientListConnectionsResult struct {
	VirtualNetworkGatewayListConnectionsResult
}

VirtualNetworkGatewaysClientListConnectionsResult contains the result from method VirtualNetworkGatewaysClient.ListConnections.

type VirtualNetworkGatewaysClientListOptions added in v0.3.0 

type VirtualNetworkGatewaysClientListOptions struct {
}

VirtualNetworkGatewaysClientListOptions contains the optional parameters for the VirtualNetworkGatewaysClient.List method.

type VirtualNetworkGatewaysClientListPager added in v0.3.0 

type VirtualNetworkGatewaysClientListPager struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientListPager provides operations for iterating over paged responses.

func (*VirtualNetworkGatewaysClientListPager) Err added in v0.3.0 

func (p *VirtualNetworkGatewaysClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualNetworkGatewaysClientListPager) NextPage added in v0.3.0 

func (p *VirtualNetworkGatewaysClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworkGatewaysClientListPager) PageResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientListPager) PageResponse() VirtualNetworkGatewaysClientListResponse

PageResponse returns the current VirtualNetworkGatewaysClientListResponse page.

type VirtualNetworkGatewaysClientListResponse added in v0.3.0 

type VirtualNetworkGatewaysClientListResponse struct {
	VirtualNetworkGatewaysClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientListResponse contains the response from method VirtualNetworkGatewaysClient.List.

type VirtualNetworkGatewaysClientListResult added in v0.3.0 

type VirtualNetworkGatewaysClientListResult struct {
	VirtualNetworkGatewayListResult
}

VirtualNetworkGatewaysClientListResult contains the result from method VirtualNetworkGatewaysClient.List.

type VirtualNetworkGatewaysClientResetPoller added in v0.3.0 

type VirtualNetworkGatewaysClientResetPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientResetPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientResetPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientResetPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientResetPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientResetPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientResetResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientResetResponse will be returned.

func (*VirtualNetworkGatewaysClientResetPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientResetPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientResetPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientResetPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientResetPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientResetPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientResetPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientResetPollerResponse contains the response from method VirtualNetworkGatewaysClient.Reset.

func (VirtualNetworkGatewaysClientResetPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientResetPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientResetResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientResetPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientResetPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientResetPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientResetResponse added in v0.3.0 

type VirtualNetworkGatewaysClientResetResponse struct {
	VirtualNetworkGatewaysClientResetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientResetResponse contains the response from method VirtualNetworkGatewaysClient.Reset.

type VirtualNetworkGatewaysClientResetResult added in v0.3.0 

type VirtualNetworkGatewaysClientResetResult struct {
	VirtualNetworkGateway
}

VirtualNetworkGatewaysClientResetResult contains the result from method VirtualNetworkGatewaysClient.Reset.

type VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller added in v0.3.0 

type VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse will be returned.

func (*VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientResetVPNClientSharedKeyPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientResetVPNClientSharedKeyPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientResetVPNClientSharedKeyPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientResetVPNClientSharedKeyPollerResponse contains the response from method VirtualNetworkGatewaysClient.ResetVPNClientSharedKey.

func (VirtualNetworkGatewaysClientResetVPNClientSharedKeyPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientResetVPNClientSharedKeyPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientResetVPNClientSharedKeyPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientResetVPNClientSharedKeyPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientResetVPNClientSharedKeyPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse added in v0.3.0 

type VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse contains the response from method VirtualNetworkGatewaysClient.ResetVPNClientSharedKey.

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller added in v0.3.0 

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse will be returned.

func (*VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPollerResponse contains the response from method VirtualNetworkGatewaysClient.SetVpnclientIPSecParameters.

func (VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientSetVpnclientIPSecParametersPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse added in v0.3.0 

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse struct {
	VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse contains the response from method VirtualNetworkGatewaysClient.SetVpnclientIPSecParameters.

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResult added in v0.3.0 

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResult struct {
	VPNClientIPsecParameters
}

VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResult contains the result from method VirtualNetworkGatewaysClient.SetVpnclientIPSecParameters.

type VirtualNetworkGatewaysClientStartPacketCapturePoller added in v0.3.0 

type VirtualNetworkGatewaysClientStartPacketCapturePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientStartPacketCapturePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientStartPacketCapturePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientStartPacketCapturePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientStartPacketCapturePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientStartPacketCapturePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientStartPacketCaptureResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientStartPacketCaptureResponse will be returned.

func (*VirtualNetworkGatewaysClientStartPacketCapturePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientStartPacketCapturePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientStartPacketCapturePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientStartPacketCapturePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientStartPacketCapturePollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientStartPacketCapturePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientStartPacketCapturePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientStartPacketCapturePollerResponse contains the response from method VirtualNetworkGatewaysClient.StartPacketCapture.

func (VirtualNetworkGatewaysClientStartPacketCapturePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientStartPacketCapturePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientStartPacketCaptureResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientStartPacketCapturePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientStartPacketCapturePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientStartPacketCapturePollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientStartPacketCaptureResponse added in v0.3.0 

type VirtualNetworkGatewaysClientStartPacketCaptureResponse struct {
	VirtualNetworkGatewaysClientStartPacketCaptureResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientStartPacketCaptureResponse contains the response from method VirtualNetworkGatewaysClient.StartPacketCapture.

type VirtualNetworkGatewaysClientStartPacketCaptureResult added in v0.3.0 

type VirtualNetworkGatewaysClientStartPacketCaptureResult struct {
	Value *string
}

VirtualNetworkGatewaysClientStartPacketCaptureResult contains the result from method VirtualNetworkGatewaysClient.StartPacketCapture.

type VirtualNetworkGatewaysClientStopPacketCapturePoller added in v0.3.0 

type VirtualNetworkGatewaysClientStopPacketCapturePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientStopPacketCapturePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientStopPacketCapturePoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientStopPacketCapturePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientStopPacketCapturePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientStopPacketCapturePoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientStopPacketCaptureResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientStopPacketCaptureResponse will be returned.

func (*VirtualNetworkGatewaysClientStopPacketCapturePoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientStopPacketCapturePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientStopPacketCapturePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientStopPacketCapturePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientStopPacketCapturePollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientStopPacketCapturePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientStopPacketCapturePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientStopPacketCapturePollerResponse contains the response from method VirtualNetworkGatewaysClient.StopPacketCapture.

func (VirtualNetworkGatewaysClientStopPacketCapturePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientStopPacketCapturePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientStopPacketCaptureResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientStopPacketCapturePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientStopPacketCapturePollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientStopPacketCapturePollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientStopPacketCaptureResponse added in v0.3.0 

type VirtualNetworkGatewaysClientStopPacketCaptureResponse struct {
	VirtualNetworkGatewaysClientStopPacketCaptureResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientStopPacketCaptureResponse contains the response from method VirtualNetworkGatewaysClient.StopPacketCapture.

type VirtualNetworkGatewaysClientStopPacketCaptureResult added in v0.3.0 

type VirtualNetworkGatewaysClientStopPacketCaptureResult struct {
	Value *string
}

VirtualNetworkGatewaysClientStopPacketCaptureResult contains the result from method VirtualNetworkGatewaysClient.StopPacketCapture.

type VirtualNetworkGatewaysClientSupportedVPNDevicesOptions added in v0.3.0 

type VirtualNetworkGatewaysClientSupportedVPNDevicesOptions struct {
}

VirtualNetworkGatewaysClientSupportedVPNDevicesOptions contains the optional parameters for the VirtualNetworkGatewaysClient.SupportedVPNDevices method.

type VirtualNetworkGatewaysClientSupportedVPNDevicesResponse added in v0.3.0 

type VirtualNetworkGatewaysClientSupportedVPNDevicesResponse struct {
	VirtualNetworkGatewaysClientSupportedVPNDevicesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientSupportedVPNDevicesResponse contains the response from method VirtualNetworkGatewaysClient.SupportedVPNDevices.

type VirtualNetworkGatewaysClientSupportedVPNDevicesResult added in v0.3.0 

type VirtualNetworkGatewaysClientSupportedVPNDevicesResult struct {
	Value *string
}

VirtualNetworkGatewaysClientSupportedVPNDevicesResult contains the result from method VirtualNetworkGatewaysClient.SupportedVPNDevices.

type VirtualNetworkGatewaysClientUpdateTagsPoller added in v0.3.0 

type VirtualNetworkGatewaysClientUpdateTagsPoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkGatewaysClientUpdateTagsPoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkGatewaysClientUpdateTagsPoller) Done added in v0.3.0 

func (p *VirtualNetworkGatewaysClientUpdateTagsPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkGatewaysClientUpdateTagsPoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkGatewaysClientUpdateTagsPoller) FinalResponse(ctx context.Context) (VirtualNetworkGatewaysClientUpdateTagsResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkGatewaysClientUpdateTagsResponse will be returned.

func (*VirtualNetworkGatewaysClientUpdateTagsPoller) Poll added in v0.3.0 

func (p *VirtualNetworkGatewaysClientUpdateTagsPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkGatewaysClientUpdateTagsPoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkGatewaysClientUpdateTagsPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkGatewaysClientUpdateTagsPollerResponse added in v0.3.0 

type VirtualNetworkGatewaysClientUpdateTagsPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkGatewaysClientUpdateTagsPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientUpdateTagsPollerResponse contains the response from method VirtualNetworkGatewaysClient.UpdateTags.

func (VirtualNetworkGatewaysClientUpdateTagsPollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkGatewaysClientUpdateTagsPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkGatewaysClientUpdateTagsResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkGatewaysClientUpdateTagsPollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkGatewaysClientUpdateTagsPollerResponse) Resume(ctx context.Context, client *VirtualNetworkGatewaysClient, token string) error

Resume rehydrates a VirtualNetworkGatewaysClientUpdateTagsPollerResponse from the provided client and resume token.

type VirtualNetworkGatewaysClientUpdateTagsResponse added in v0.3.0 

type VirtualNetworkGatewaysClientUpdateTagsResponse struct {
	VirtualNetworkGatewaysClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientUpdateTagsResponse contains the response from method VirtualNetworkGatewaysClient.UpdateTags.

type VirtualNetworkGatewaysClientUpdateTagsResult added in v0.3.0 

type VirtualNetworkGatewaysClientUpdateTagsResult struct {
	VirtualNetworkGateway
}

VirtualNetworkGatewaysClientUpdateTagsResult contains the result from method VirtualNetworkGatewaysClient.UpdateTags.

type VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptOptions added in v0.3.0 

type VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptOptions struct {
}

VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptOptions contains the optional parameters for the VirtualNetworkGatewaysClient.VPNDeviceConfigurationScript method.

type VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResponse added in v0.3.0 

type VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResponse struct {
	VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResponse contains the response from method VirtualNetworkGatewaysClient.VPNDeviceConfigurationScript.

type VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResult added in v0.3.0 

type VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResult struct {
	Value *string
}

VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResult contains the result from method VirtualNetworkGatewaysClient.VPNDeviceConfigurationScript.

type VirtualNetworkListResult 

type VirtualNetworkListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of VirtualNetwork resources in a resource group.
	Value []*VirtualNetwork `json:"value,omitempty"`
}

VirtualNetworkListResult - Response for the ListVirtualNetworks API service call.

func (VirtualNetworkListResult) MarshalJSON 

func (v VirtualNetworkListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkListResult.

type VirtualNetworkListUsageResult 

type VirtualNetworkListUsageResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// READ-ONLY; VirtualNetwork usage stats.
	Value []*VirtualNetworkUsage `json:"value,omitempty" azure:"ro"`
}

VirtualNetworkListUsageResult - Response for the virtual networks GetUsage API service call.

func (VirtualNetworkListUsageResult) MarshalJSON 

func (v VirtualNetworkListUsageResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkListUsageResult.

type VirtualNetworkPeering 

type VirtualNetworkPeering struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// 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"`

	// Properties of the virtual network peering.
	Properties *VirtualNetworkPeeringPropertiesFormat `json:"properties,omitempty"`

	// Resource type.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

VirtualNetworkPeering - Peerings in a virtual network resource.

type VirtualNetworkPeeringLevel 

type VirtualNetworkPeeringLevel string

VirtualNetworkPeeringLevel - The peering sync status of the virtual network peering. 

const (
	VirtualNetworkPeeringLevelFullyInSync             VirtualNetworkPeeringLevel = "FullyInSync"
	VirtualNetworkPeeringLevelLocalAndRemoteNotInSync VirtualNetworkPeeringLevel = "LocalAndRemoteNotInSync"
	VirtualNetworkPeeringLevelLocalNotInSync          VirtualNetworkPeeringLevel = "LocalNotInSync"
	VirtualNetworkPeeringLevelRemoteNotInSync         VirtualNetworkPeeringLevel = "RemoteNotInSync"
)

func PossibleVirtualNetworkPeeringLevelValues 

func PossibleVirtualNetworkPeeringLevelValues() []VirtualNetworkPeeringLevel

PossibleVirtualNetworkPeeringLevelValues returns the possible values for the VirtualNetworkPeeringLevel const type.

func (VirtualNetworkPeeringLevel) ToPtr 

func (c VirtualNetworkPeeringLevel) ToPtr() *VirtualNetworkPeeringLevel

ToPtr returns a *VirtualNetworkPeeringLevel pointing to the current value.

type VirtualNetworkPeeringListResult 

type VirtualNetworkPeeringListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// The peerings in a virtual network.
	Value []*VirtualNetworkPeering `json:"value,omitempty"`
}

VirtualNetworkPeeringListResult - Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network.

func (VirtualNetworkPeeringListResult) MarshalJSON 

func (v VirtualNetworkPeeringListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkPeeringListResult.

type VirtualNetworkPeeringPropertiesFormat 

type VirtualNetworkPeeringPropertiesFormat struct {
	// Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
	AllowForwardedTraffic *bool `json:"allowForwardedTraffic,omitempty"`

	// If gateway links can be used in remote virtual networking to link to this virtual network.
	AllowGatewayTransit *bool `json:"allowGatewayTransit,omitempty"`

	// Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
	AllowVirtualNetworkAccess *bool `json:"allowVirtualNetworkAccess,omitempty"`

	// If we need to verify the provisioning state of the remote gateway.
	DoNotVerifyRemoteGateways *bool `json:"doNotVerifyRemoteGateways,omitempty"`

	// The status of the virtual network peering.
	PeeringState *VirtualNetworkPeeringState `json:"peeringState,omitempty"`

	// The peering sync status of the virtual network peering.
	PeeringSyncLevel *VirtualNetworkPeeringLevel `json:"peeringSyncLevel,omitempty"`

	// The reference to the address space peered with the remote virtual network.
	RemoteAddressSpace *AddressSpace `json:"remoteAddressSpace,omitempty"`

	// The reference to the remote virtual network's Bgp Communities.
	RemoteBgpCommunities *VirtualNetworkBgpCommunities `json:"remoteBgpCommunities,omitempty"`

	// The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview).
	// See here to register for the preview and learn more
	// (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).
	RemoteVirtualNetwork *SubResource `json:"remoteVirtualNetwork,omitempty"`

	// The reference to the current address space of the remote virtual network.
	RemoteVirtualNetworkAddressSpace *AddressSpace `json:"remoteVirtualNetworkAddressSpace,omitempty"`

	// If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering
	// is also true, virtual network will use gateways of remote virtual network
	// for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a
	// gateway.
	UseRemoteGateways *bool `json:"useRemoteGateways,omitempty"`

	// READ-ONLY; The provisioning state of the virtual network peering resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The reference to the remote virtual network's encryption
	RemoteVirtualNetworkEncryption *VirtualNetworkEncryption `json:"remoteVirtualNetworkEncryption,omitempty" azure:"ro"`

	// READ-ONLY; The resourceGuid property of the Virtual Network peering resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

VirtualNetworkPeeringPropertiesFormat - Properties of the virtual network peering.

type VirtualNetworkPeeringState 

type VirtualNetworkPeeringState string

VirtualNetworkPeeringState - The status of the virtual network peering. 

const (
	VirtualNetworkPeeringStateConnected    VirtualNetworkPeeringState = "Connected"
	VirtualNetworkPeeringStateDisconnected VirtualNetworkPeeringState = "Disconnected"
	VirtualNetworkPeeringStateInitiated    VirtualNetworkPeeringState = "Initiated"
)

func PossibleVirtualNetworkPeeringStateValues 

func PossibleVirtualNetworkPeeringStateValues() []VirtualNetworkPeeringState

PossibleVirtualNetworkPeeringStateValues returns the possible values for the VirtualNetworkPeeringState const type.

func (VirtualNetworkPeeringState) ToPtr 

func (c VirtualNetworkPeeringState) ToPtr() *VirtualNetworkPeeringState

ToPtr returns a *VirtualNetworkPeeringState pointing to the current value.

type VirtualNetworkPeeringsClient 

type VirtualNetworkPeeringsClient struct {
	// contains filtered or unexported fields
}

VirtualNetworkPeeringsClient contains the methods for the VirtualNetworkPeerings group. Don't use this type directly, use NewVirtualNetworkPeeringsClient() instead.

func NewVirtualNetworkPeeringsClient 

func NewVirtualNetworkPeeringsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualNetworkPeeringsClient

NewVirtualNetworkPeeringsClient creates a new instance of VirtualNetworkPeeringsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualNetworkPeeringsClient) BeginCreateOrUpdate 

func (client *VirtualNetworkPeeringsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualNetworkName string, virtualNetworkPeeringName string, virtualNetworkPeeringParameters VirtualNetworkPeering, options *VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions) (VirtualNetworkPeeringsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a peering in the specified virtual network. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. virtualNetworkPeeringName - The name of the peering. virtualNetworkPeeringParameters - Parameters supplied to the create or update virtual network peering operation. options - VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkPeeringsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkPeeringCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkPeeringsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<virtual-network-peering-name>",
		armnetwork.VirtualNetworkPeering{
			Properties: &armnetwork.VirtualNetworkPeeringPropertiesFormat{
				AllowForwardedTraffic:     to.BoolPtr(true),
				AllowGatewayTransit:       to.BoolPtr(false),
				AllowVirtualNetworkAccess: to.BoolPtr(true),
				RemoteVirtualNetwork: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
				UseRemoteGateways: to.BoolPtr(false),
			},
		},
		&armnetwork.VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions{SyncRemoteAddressSpace: nil})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkPeeringsClientCreateOrUpdateResult)
}

Output:

func (*VirtualNetworkPeeringsClient) BeginDelete 

func (client *VirtualNetworkPeeringsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualNetworkName string, virtualNetworkPeeringName string, options *VirtualNetworkPeeringsClientBeginDeleteOptions) (VirtualNetworkPeeringsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified virtual network peering. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. virtualNetworkPeeringName - The name of the virtual network peering. options - VirtualNetworkPeeringsClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkPeeringsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkPeeringDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkPeeringsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<virtual-network-peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualNetworkPeeringsClient) Get 

func (client *VirtualNetworkPeeringsClient) Get(ctx context.Context, resourceGroupName string, virtualNetworkName string, virtualNetworkPeeringName string, options *VirtualNetworkPeeringsClientGetOptions) (VirtualNetworkPeeringsClientGetResponse, error)

Get - Gets the specified virtual network peering. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. virtualNetworkPeeringName - The name of the virtual network peering. options - VirtualNetworkPeeringsClientGetOptions contains the optional parameters for the VirtualNetworkPeeringsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkPeeringGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkPeeringsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<virtual-network-peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkPeeringsClientGetResult)
}

Output:

func (*VirtualNetworkPeeringsClient) List 

func (client *VirtualNetworkPeeringsClient) List(resourceGroupName string, virtualNetworkName string, options *VirtualNetworkPeeringsClientListOptions) *VirtualNetworkPeeringsClientListPager

List - Gets all virtual network peerings in a virtual network. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. options - VirtualNetworkPeeringsClientListOptions contains the optional parameters for the VirtualNetworkPeeringsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkPeeringList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkPeeringsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<virtual-network-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions struct {
	// Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated.
	SyncRemoteAddressSpace *SyncRemoteAddressSpace
}

VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkPeeringsClient.BeginCreateOrUpdate method.

type VirtualNetworkPeeringsClientBeginDeleteOptions added in v0.3.0 

type VirtualNetworkPeeringsClientBeginDeleteOptions struct {
}

VirtualNetworkPeeringsClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkPeeringsClient.BeginDelete method.

type VirtualNetworkPeeringsClientCreateOrUpdatePoller added in v0.3.0 

type VirtualNetworkPeeringsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkPeeringsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkPeeringsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualNetworkPeeringsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkPeeringsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkPeeringsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualNetworkPeeringsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkPeeringsClientCreateOrUpdateResponse will be returned.

func (*VirtualNetworkPeeringsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualNetworkPeeringsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkPeeringsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkPeeringsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkPeeringsClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualNetworkPeeringsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkPeeringsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkPeeringsClientCreateOrUpdatePollerResponse contains the response from method VirtualNetworkPeeringsClient.CreateOrUpdate.

func (VirtualNetworkPeeringsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkPeeringsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkPeeringsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkPeeringsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkPeeringsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualNetworkPeeringsClient, token string) error

Resume rehydrates a VirtualNetworkPeeringsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualNetworkPeeringsClientCreateOrUpdateResponse added in v0.3.0 

type VirtualNetworkPeeringsClientCreateOrUpdateResponse struct {
	VirtualNetworkPeeringsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkPeeringsClientCreateOrUpdateResponse contains the response from method VirtualNetworkPeeringsClient.CreateOrUpdate.

type VirtualNetworkPeeringsClientCreateOrUpdateResult added in v0.3.0 

type VirtualNetworkPeeringsClientCreateOrUpdateResult struct {
	VirtualNetworkPeering
}

VirtualNetworkPeeringsClientCreateOrUpdateResult contains the result from method VirtualNetworkPeeringsClient.CreateOrUpdate.

type VirtualNetworkPeeringsClientDeletePoller added in v0.3.0 

type VirtualNetworkPeeringsClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkPeeringsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkPeeringsClientDeletePoller) Done added in v0.3.0 

func (p *VirtualNetworkPeeringsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkPeeringsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkPeeringsClientDeletePoller) FinalResponse(ctx context.Context) (VirtualNetworkPeeringsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkPeeringsClientDeleteResponse will be returned.

func (*VirtualNetworkPeeringsClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualNetworkPeeringsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkPeeringsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkPeeringsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkPeeringsClientDeletePollerResponse added in v0.3.0 

type VirtualNetworkPeeringsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkPeeringsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkPeeringsClientDeletePollerResponse contains the response from method VirtualNetworkPeeringsClient.Delete.

func (VirtualNetworkPeeringsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkPeeringsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkPeeringsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkPeeringsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkPeeringsClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualNetworkPeeringsClient, token string) error

Resume rehydrates a VirtualNetworkPeeringsClientDeletePollerResponse from the provided client and resume token.

type VirtualNetworkPeeringsClientDeleteResponse added in v0.3.0 

type VirtualNetworkPeeringsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkPeeringsClientDeleteResponse contains the response from method VirtualNetworkPeeringsClient.Delete.

type VirtualNetworkPeeringsClientGetOptions added in v0.3.0 

type VirtualNetworkPeeringsClientGetOptions struct {
}

VirtualNetworkPeeringsClientGetOptions contains the optional parameters for the VirtualNetworkPeeringsClient.Get method.

type VirtualNetworkPeeringsClientGetResponse added in v0.3.0 

type VirtualNetworkPeeringsClientGetResponse struct {
	VirtualNetworkPeeringsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkPeeringsClientGetResponse contains the response from method VirtualNetworkPeeringsClient.Get.

type VirtualNetworkPeeringsClientGetResult added in v0.3.0 

type VirtualNetworkPeeringsClientGetResult struct {
	VirtualNetworkPeering
}

VirtualNetworkPeeringsClientGetResult contains the result from method VirtualNetworkPeeringsClient.Get.

type VirtualNetworkPeeringsClientListOptions added in v0.3.0 

type VirtualNetworkPeeringsClientListOptions struct {
}

VirtualNetworkPeeringsClientListOptions contains the optional parameters for the VirtualNetworkPeeringsClient.List method.

type VirtualNetworkPeeringsClientListPager added in v0.3.0 

type VirtualNetworkPeeringsClientListPager struct {
	// contains filtered or unexported fields
}

VirtualNetworkPeeringsClientListPager provides operations for iterating over paged responses.

func (*VirtualNetworkPeeringsClientListPager) Err added in v0.3.0 

func (p *VirtualNetworkPeeringsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualNetworkPeeringsClientListPager) NextPage added in v0.3.0 

func (p *VirtualNetworkPeeringsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworkPeeringsClientListPager) PageResponse added in v0.3.0 

func (p *VirtualNetworkPeeringsClientListPager) PageResponse() VirtualNetworkPeeringsClientListResponse

PageResponse returns the current VirtualNetworkPeeringsClientListResponse page.

type VirtualNetworkPeeringsClientListResponse added in v0.3.0 

type VirtualNetworkPeeringsClientListResponse struct {
	VirtualNetworkPeeringsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkPeeringsClientListResponse contains the response from method VirtualNetworkPeeringsClient.List.

type VirtualNetworkPeeringsClientListResult added in v0.3.0 

type VirtualNetworkPeeringsClientListResult struct {
	VirtualNetworkPeeringListResult
}

VirtualNetworkPeeringsClientListResult contains the result from method VirtualNetworkPeeringsClient.List.

type VirtualNetworkPrivateEndpointNetworkPolicies 

type VirtualNetworkPrivateEndpointNetworkPolicies string

VirtualNetworkPrivateEndpointNetworkPolicies - Enable or Disable apply network policies on private end point in the subnet. 

const (
	VirtualNetworkPrivateEndpointNetworkPoliciesDisabled VirtualNetworkPrivateEndpointNetworkPolicies = "Disabled"
	VirtualNetworkPrivateEndpointNetworkPoliciesEnabled  VirtualNetworkPrivateEndpointNetworkPolicies = "Enabled"
)

func PossibleVirtualNetworkPrivateEndpointNetworkPoliciesValues 

func PossibleVirtualNetworkPrivateEndpointNetworkPoliciesValues() []VirtualNetworkPrivateEndpointNetworkPolicies

PossibleVirtualNetworkPrivateEndpointNetworkPoliciesValues returns the possible values for the VirtualNetworkPrivateEndpointNetworkPolicies const type.

func (VirtualNetworkPrivateEndpointNetworkPolicies) ToPtr 

func (c VirtualNetworkPrivateEndpointNetworkPolicies) ToPtr() *VirtualNetworkPrivateEndpointNetworkPolicies

ToPtr returns a *VirtualNetworkPrivateEndpointNetworkPolicies pointing to the current value.

type VirtualNetworkPrivateLinkServiceNetworkPolicies 

type VirtualNetworkPrivateLinkServiceNetworkPolicies string

VirtualNetworkPrivateLinkServiceNetworkPolicies - Enable or Disable apply network policies on private link service in the subnet. 

const (
	VirtualNetworkPrivateLinkServiceNetworkPoliciesDisabled VirtualNetworkPrivateLinkServiceNetworkPolicies = "Disabled"
	VirtualNetworkPrivateLinkServiceNetworkPoliciesEnabled  VirtualNetworkPrivateLinkServiceNetworkPolicies = "Enabled"
)

func PossibleVirtualNetworkPrivateLinkServiceNetworkPoliciesValues 

func PossibleVirtualNetworkPrivateLinkServiceNetworkPoliciesValues() []VirtualNetworkPrivateLinkServiceNetworkPolicies

PossibleVirtualNetworkPrivateLinkServiceNetworkPoliciesValues returns the possible values for the VirtualNetworkPrivateLinkServiceNetworkPolicies const type.

func (VirtualNetworkPrivateLinkServiceNetworkPolicies) ToPtr 

func (c VirtualNetworkPrivateLinkServiceNetworkPolicies) ToPtr() *VirtualNetworkPrivateLinkServiceNetworkPolicies

ToPtr returns a *VirtualNetworkPrivateLinkServiceNetworkPolicies pointing to the current value.

type VirtualNetworkPropertiesFormat 

type VirtualNetworkPropertiesFormat struct {
	// The AddressSpace that contains an array of IP address ranges that can be used by subnets.
	AddressSpace *AddressSpace `json:"addressSpace,omitempty"`

	// Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.
	BgpCommunities *VirtualNetworkBgpCommunities `json:"bgpCommunities,omitempty"`

	// The DDoS protection plan associated with the virtual network.
	DdosProtectionPlan *SubResource `json:"ddosProtectionPlan,omitempty"`

	// The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.
	DhcpOptions *DhcpOptions `json:"dhcpOptions,omitempty"`

	// Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection
	// plan associated with the resource.
	EnableDdosProtection *bool `json:"enableDdosProtection,omitempty"`

	// Indicates if VM protection is enabled for all the subnets in the virtual network.
	EnableVMProtection *bool `json:"enableVmProtection,omitempty"`

	// Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet.
	Encryption *VirtualNetworkEncryption `json:"encryption,omitempty"`

	// The FlowTimeout value (in minutes) for the Virtual Network
	FlowTimeoutInMinutes *int32 `json:"flowTimeoutInMinutes,omitempty"`

	// Array of IpAllocation which reference this VNET.
	IPAllocations []*SubResource `json:"ipAllocations,omitempty"`

	// A list of subnets in a Virtual Network.
	Subnets []*Subnet `json:"subnets,omitempty"`

	// A list of peerings in a Virtual Network.
	VirtualNetworkPeerings []*VirtualNetworkPeering `json:"virtualNetworkPeerings,omitempty"`

	// READ-ONLY; The provisioning state of the virtual network resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resourceGuid property of the Virtual Network resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

VirtualNetworkPropertiesFormat - Properties of the virtual network.

func (VirtualNetworkPropertiesFormat) MarshalJSON 

func (v VirtualNetworkPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkPropertiesFormat.

type VirtualNetworkTap 

type VirtualNetworkTap struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Virtual Network Tap Properties.
	Properties *VirtualNetworkTapPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualNetworkTap - Virtual Network Tap resource.

func (VirtualNetworkTap) MarshalJSON 

func (v VirtualNetworkTap) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkTap.

type VirtualNetworkTapListResult 

type VirtualNetworkTapListResult struct {
	// The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// A list of VirtualNetworkTaps in a resource group.
	Value []*VirtualNetworkTap `json:"value,omitempty"`
}

VirtualNetworkTapListResult - Response for ListVirtualNetworkTap API service call.

func (VirtualNetworkTapListResult) MarshalJSON 

func (v VirtualNetworkTapListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkTapListResult.

type VirtualNetworkTapPropertiesFormat 

type VirtualNetworkTapPropertiesFormat struct {
	// The reference to the private IP address on the internal Load Balancer that will receive the tap.
	DestinationLoadBalancerFrontEndIPConfiguration *FrontendIPConfiguration `json:"destinationLoadBalancerFrontEndIPConfiguration,omitempty"`

	// The reference to the private IP Address of the collector nic that will receive the tap.
	DestinationNetworkInterfaceIPConfiguration *InterfaceIPConfiguration `json:"destinationNetworkInterfaceIPConfiguration,omitempty"`

	// The VXLAN destination port that will receive the tapped traffic.
	DestinationPort *int32 `json:"destinationPort,omitempty"`

	// READ-ONLY; Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped.
	NetworkInterfaceTapConfigurations []*InterfaceTapConfiguration `json:"networkInterfaceTapConfigurations,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the virtual network tap resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resource GUID property of the virtual network tap resource.
	ResourceGUID *string `json:"resourceGuid,omitempty" azure:"ro"`
}

VirtualNetworkTapPropertiesFormat - Virtual Network Tap properties.

func (VirtualNetworkTapPropertiesFormat) MarshalJSON 

func (v VirtualNetworkTapPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkTapPropertiesFormat.

type VirtualNetworkTapsClient 

type VirtualNetworkTapsClient struct {
	// contains filtered or unexported fields
}

VirtualNetworkTapsClient contains the methods for the VirtualNetworkTaps group. Don't use this type directly, use NewVirtualNetworkTapsClient() instead.

func NewVirtualNetworkTapsClient 

func NewVirtualNetworkTapsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualNetworkTapsClient

NewVirtualNetworkTapsClient creates a new instance of VirtualNetworkTapsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualNetworkTapsClient) BeginCreateOrUpdate 

func (client *VirtualNetworkTapsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, tapName string, parameters VirtualNetworkTap, options *VirtualNetworkTapsClientBeginCreateOrUpdateOptions) (VirtualNetworkTapsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a Virtual Network Tap. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. tapName - The name of the virtual network tap. parameters - Parameters supplied to the create or update virtual network tap operation. options - VirtualNetworkTapsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkTapsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkTapCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkTapsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<tap-name>",
		armnetwork.VirtualNetworkTap{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.VirtualNetworkTapPropertiesFormat{
				DestinationNetworkInterfaceIPConfiguration: &armnetwork.InterfaceIPConfiguration{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkTapsClientCreateOrUpdateResult)
}

Output:

func (*VirtualNetworkTapsClient) BeginDelete 

func (client *VirtualNetworkTapsClient) BeginDelete(ctx context.Context, resourceGroupName string, tapName string, options *VirtualNetworkTapsClientBeginDeleteOptions) (VirtualNetworkTapsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified virtual network tap. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. tapName - The name of the virtual network tap. options - VirtualNetworkTapsClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkTapsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkTapDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkTapsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<tap-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualNetworkTapsClient) Get 

func (client *VirtualNetworkTapsClient) Get(ctx context.Context, resourceGroupName string, tapName string, options *VirtualNetworkTapsClientGetOptions) (VirtualNetworkTapsClientGetResponse, error)

Get - Gets information about the specified virtual network tap. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. tapName - The name of virtual network tap. options - VirtualNetworkTapsClientGetOptions contains the optional parameters for the VirtualNetworkTapsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkTapGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkTapsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<tap-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkTapsClientGetResult)
}

Output:

func (*VirtualNetworkTapsClient) ListAll 

func (client *VirtualNetworkTapsClient) ListAll(options *VirtualNetworkTapsClientListAllOptions) *VirtualNetworkTapsClientListAllPager

ListAll - Gets all the VirtualNetworkTaps in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - VirtualNetworkTapsClientListAllOptions contains the optional parameters for the VirtualNetworkTapsClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkTapListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkTapsClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualNetworkTapsClient) ListByResourceGroup 

func (client *VirtualNetworkTapsClient) ListByResourceGroup(resourceGroupName string, options *VirtualNetworkTapsClientListByResourceGroupOptions) *VirtualNetworkTapsClientListByResourceGroupPager

ListByResourceGroup - Gets all the VirtualNetworkTaps in a subscription. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - VirtualNetworkTapsClientListByResourceGroupOptions contains the optional parameters for the VirtualNetworkTapsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkTapList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkTapsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualNetworkTapsClient) UpdateTags 

func (client *VirtualNetworkTapsClient) UpdateTags(ctx context.Context, resourceGroupName string, tapName string, tapParameters TagsObject, options *VirtualNetworkTapsClientUpdateTagsOptions) (VirtualNetworkTapsClientUpdateTagsResponse, error)

UpdateTags - Updates an VirtualNetworkTap tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. tapName - The name of the tap. tapParameters - Parameters supplied to update VirtualNetworkTap tags. options - VirtualNetworkTapsClientUpdateTagsOptions contains the optional parameters for the VirtualNetworkTapsClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkTapUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworkTapsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<tap-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworkTapsClientUpdateTagsResult)
}

Output:

type VirtualNetworkTapsClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualNetworkTapsClientBeginCreateOrUpdateOptions struct {
}

VirtualNetworkTapsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkTapsClient.BeginCreateOrUpdate method.

type VirtualNetworkTapsClientBeginDeleteOptions added in v0.3.0 

type VirtualNetworkTapsClientBeginDeleteOptions struct {
}

VirtualNetworkTapsClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkTapsClient.BeginDelete method.

type VirtualNetworkTapsClientCreateOrUpdatePoller added in v0.3.0 

type VirtualNetworkTapsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkTapsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkTapsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualNetworkTapsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkTapsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkTapsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualNetworkTapsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkTapsClientCreateOrUpdateResponse will be returned.

func (*VirtualNetworkTapsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualNetworkTapsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkTapsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkTapsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkTapsClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualNetworkTapsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkTapsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkTapsClientCreateOrUpdatePollerResponse contains the response from method VirtualNetworkTapsClient.CreateOrUpdate.

func (VirtualNetworkTapsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkTapsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkTapsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkTapsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkTapsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualNetworkTapsClient, token string) error

Resume rehydrates a VirtualNetworkTapsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualNetworkTapsClientCreateOrUpdateResponse added in v0.3.0 

type VirtualNetworkTapsClientCreateOrUpdateResponse struct {
	VirtualNetworkTapsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkTapsClientCreateOrUpdateResponse contains the response from method VirtualNetworkTapsClient.CreateOrUpdate.

type VirtualNetworkTapsClientCreateOrUpdateResult added in v0.3.0 

type VirtualNetworkTapsClientCreateOrUpdateResult struct {
	VirtualNetworkTap
}

VirtualNetworkTapsClientCreateOrUpdateResult contains the result from method VirtualNetworkTapsClient.CreateOrUpdate.

type VirtualNetworkTapsClientDeletePoller added in v0.3.0 

type VirtualNetworkTapsClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworkTapsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworkTapsClientDeletePoller) Done added in v0.3.0 

func (p *VirtualNetworkTapsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworkTapsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworkTapsClientDeletePoller) FinalResponse(ctx context.Context) (VirtualNetworkTapsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworkTapsClientDeleteResponse will be returned.

func (*VirtualNetworkTapsClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualNetworkTapsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworkTapsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworkTapsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworkTapsClientDeletePollerResponse added in v0.3.0 

type VirtualNetworkTapsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworkTapsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkTapsClientDeletePollerResponse contains the response from method VirtualNetworkTapsClient.Delete.

func (VirtualNetworkTapsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworkTapsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworkTapsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworkTapsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworkTapsClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualNetworkTapsClient, token string) error

Resume rehydrates a VirtualNetworkTapsClientDeletePollerResponse from the provided client and resume token.

type VirtualNetworkTapsClientDeleteResponse added in v0.3.0 

type VirtualNetworkTapsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkTapsClientDeleteResponse contains the response from method VirtualNetworkTapsClient.Delete.

type VirtualNetworkTapsClientGetOptions added in v0.3.0 

type VirtualNetworkTapsClientGetOptions struct {
}

VirtualNetworkTapsClientGetOptions contains the optional parameters for the VirtualNetworkTapsClient.Get method.

type VirtualNetworkTapsClientGetResponse added in v0.3.0 

type VirtualNetworkTapsClientGetResponse struct {
	VirtualNetworkTapsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkTapsClientGetResponse contains the response from method VirtualNetworkTapsClient.Get.

type VirtualNetworkTapsClientGetResult added in v0.3.0 

type VirtualNetworkTapsClientGetResult struct {
	VirtualNetworkTap
}

VirtualNetworkTapsClientGetResult contains the result from method VirtualNetworkTapsClient.Get.

type VirtualNetworkTapsClientListAllOptions added in v0.3.0 

type VirtualNetworkTapsClientListAllOptions struct {
}

VirtualNetworkTapsClientListAllOptions contains the optional parameters for the VirtualNetworkTapsClient.ListAll method.

type VirtualNetworkTapsClientListAllPager added in v0.3.0 

type VirtualNetworkTapsClientListAllPager struct {
	// contains filtered or unexported fields
}

VirtualNetworkTapsClientListAllPager provides operations for iterating over paged responses.

func (*VirtualNetworkTapsClientListAllPager) Err added in v0.3.0 

func (p *VirtualNetworkTapsClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualNetworkTapsClientListAllPager) NextPage added in v0.3.0 

func (p *VirtualNetworkTapsClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworkTapsClientListAllPager) PageResponse added in v0.3.0 

func (p *VirtualNetworkTapsClientListAllPager) PageResponse() VirtualNetworkTapsClientListAllResponse

PageResponse returns the current VirtualNetworkTapsClientListAllResponse page.

type VirtualNetworkTapsClientListAllResponse added in v0.3.0 

type VirtualNetworkTapsClientListAllResponse struct {
	VirtualNetworkTapsClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkTapsClientListAllResponse contains the response from method VirtualNetworkTapsClient.ListAll.

type VirtualNetworkTapsClientListAllResult added in v0.3.0 

type VirtualNetworkTapsClientListAllResult struct {
	VirtualNetworkTapListResult
}

VirtualNetworkTapsClientListAllResult contains the result from method VirtualNetworkTapsClient.ListAll.

type VirtualNetworkTapsClientListByResourceGroupOptions added in v0.3.0 

type VirtualNetworkTapsClientListByResourceGroupOptions struct {
}

VirtualNetworkTapsClientListByResourceGroupOptions contains the optional parameters for the VirtualNetworkTapsClient.ListByResourceGroup method.

type VirtualNetworkTapsClientListByResourceGroupPager added in v0.3.0 

type VirtualNetworkTapsClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

VirtualNetworkTapsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*VirtualNetworkTapsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *VirtualNetworkTapsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualNetworkTapsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *VirtualNetworkTapsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworkTapsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *VirtualNetworkTapsClientListByResourceGroupPager) PageResponse() VirtualNetworkTapsClientListByResourceGroupResponse

PageResponse returns the current VirtualNetworkTapsClientListByResourceGroupResponse page.

type VirtualNetworkTapsClientListByResourceGroupResponse added in v0.3.0 

type VirtualNetworkTapsClientListByResourceGroupResponse struct {
	VirtualNetworkTapsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkTapsClientListByResourceGroupResponse contains the response from method VirtualNetworkTapsClient.ListByResourceGroup.

type VirtualNetworkTapsClientListByResourceGroupResult added in v0.3.0 

type VirtualNetworkTapsClientListByResourceGroupResult struct {
	VirtualNetworkTapListResult
}

VirtualNetworkTapsClientListByResourceGroupResult contains the result from method VirtualNetworkTapsClient.ListByResourceGroup.

type VirtualNetworkTapsClientUpdateTagsOptions added in v0.3.0 

type VirtualNetworkTapsClientUpdateTagsOptions struct {
}

VirtualNetworkTapsClientUpdateTagsOptions contains the optional parameters for the VirtualNetworkTapsClient.UpdateTags method.

type VirtualNetworkTapsClientUpdateTagsResponse added in v0.3.0 

type VirtualNetworkTapsClientUpdateTagsResponse struct {
	VirtualNetworkTapsClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworkTapsClientUpdateTagsResponse contains the response from method VirtualNetworkTapsClient.UpdateTags.

type VirtualNetworkTapsClientUpdateTagsResult added in v0.3.0 

type VirtualNetworkTapsClientUpdateTagsResult struct {
	VirtualNetworkTap
}

VirtualNetworkTapsClientUpdateTagsResult contains the result from method VirtualNetworkTapsClient.UpdateTags.

type VirtualNetworkUsage 

type VirtualNetworkUsage struct {
	// READ-ONLY; Indicates number of IPs used from the Subnet.
	CurrentValue *float64 `json:"currentValue,omitempty" azure:"ro"`

	// READ-ONLY; Subnet identifier.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Indicates the size of the subnet.
	Limit *float64 `json:"limit,omitempty" azure:"ro"`

	// READ-ONLY; The name containing common and localized value for usage.
	Name *VirtualNetworkUsageName `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Usage units. Returns 'Count'.
	Unit *string `json:"unit,omitempty" azure:"ro"`
}

VirtualNetworkUsage - Usage details for subnet.

type VirtualNetworkUsageName 

type VirtualNetworkUsageName struct {
	// READ-ONLY; Localized subnet size and usage string.
	LocalizedValue *string `json:"localizedValue,omitempty" azure:"ro"`

	// READ-ONLY; Subnet size and usage string.
	Value *string `json:"value,omitempty" azure:"ro"`
}

VirtualNetworkUsageName - Usage strings container.

type VirtualNetworksClient 

type VirtualNetworksClient struct {
	// contains filtered or unexported fields
}

VirtualNetworksClient contains the methods for the VirtualNetworks group. Don't use this type directly, use NewVirtualNetworksClient() instead.

func NewVirtualNetworksClient 

func NewVirtualNetworksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualNetworksClient

NewVirtualNetworksClient creates a new instance of VirtualNetworksClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualNetworksClient) BeginCreateOrUpdate 

func (client *VirtualNetworksClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualNetworkName string, parameters VirtualNetwork, options *VirtualNetworksClientBeginCreateOrUpdateOptions) (VirtualNetworksClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates a virtual network in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. parameters - Parameters supplied to the create or update virtual network operation. options - VirtualNetworksClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworksClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkCreate.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworksClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		armnetwork.VirtualNetwork{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.VirtualNetworkPropertiesFormat{
				AddressSpace: &armnetwork.AddressSpace{
					AddressPrefixes: []*string{
						to.StringPtr("10.0.0.0/16")},
				},
				FlowTimeoutInMinutes: to.Int32Ptr(10),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworksClientCreateOrUpdateResult)
}

Output:

func (*VirtualNetworksClient) BeginDelete 

func (client *VirtualNetworksClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualNetworkName string, options *VirtualNetworksClientBeginDeleteOptions) (VirtualNetworksClientDeletePollerResponse, error)

BeginDelete - Deletes the specified virtual network. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. options - VirtualNetworksClientBeginDeleteOptions contains the optional parameters for the VirtualNetworksClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworksClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualNetworksClient) CheckIPAddressAvailability 

func (client *VirtualNetworksClient) CheckIPAddressAvailability(ctx context.Context, resourceGroupName string, virtualNetworkName string, ipAddress string, options *VirtualNetworksClientCheckIPAddressAvailabilityOptions) (VirtualNetworksClientCheckIPAddressAvailabilityResponse, error)

CheckIPAddressAvailability - Checks whether a private IP address is available for use. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. ipAddress - The private IP address to be verified. options - VirtualNetworksClientCheckIPAddressAvailabilityOptions contains the optional parameters for the VirtualNetworksClient.CheckIPAddressAvailability method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkCheckIPAddressAvailability.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworksClient("<subscription-id>", cred, nil)
	res, err := client.CheckIPAddressAvailability(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		"<ip-address>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworksClientCheckIPAddressAvailabilityResult)
}

Output:

func (*VirtualNetworksClient) Get 

func (client *VirtualNetworksClient) Get(ctx context.Context, resourceGroupName string, virtualNetworkName string, options *VirtualNetworksClientGetOptions) (VirtualNetworksClientGetResponse, error)

Get - Gets the specified virtual network by resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. options - VirtualNetworksClientGetOptions contains the optional parameters for the VirtualNetworksClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworksClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		&armnetwork.VirtualNetworksClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworksClientGetResult)
}

Output:

func (*VirtualNetworksClient) List 

func (client *VirtualNetworksClient) List(resourceGroupName string, options *VirtualNetworksClientListOptions) *VirtualNetworksClientListPager

List - Gets all virtual networks in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - VirtualNetworksClientListOptions contains the optional parameters for the VirtualNetworksClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworksClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualNetworksClient) ListAll 

func (client *VirtualNetworksClient) ListAll(options *VirtualNetworksClientListAllOptions) *VirtualNetworksClientListAllPager

ListAll - Gets all virtual networks in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - VirtualNetworksClientListAllOptions contains the optional parameters for the VirtualNetworksClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworksClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualNetworksClient) ListUsage 

func (client *VirtualNetworksClient) ListUsage(resourceGroupName string, virtualNetworkName string, options *VirtualNetworksClientListUsageOptions) *VirtualNetworksClientListUsagePager

ListUsage - Lists usage stats. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. options - VirtualNetworksClientListUsageOptions contains the optional parameters for the VirtualNetworksClient.ListUsage method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkListUsage.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworksClient("<subscription-id>", cred, nil)
	pager := client.ListUsage("<resource-group-name>",
		"<virtual-network-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualNetworksClient) UpdateTags 

func (client *VirtualNetworksClient) UpdateTags(ctx context.Context, resourceGroupName string, virtualNetworkName string, parameters TagsObject, options *VirtualNetworksClientUpdateTagsOptions) (VirtualNetworksClientUpdateTagsResponse, error)

UpdateTags - Updates a virtual network tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. parameters - Parameters supplied to update virtual network tags. options - VirtualNetworksClientUpdateTagsOptions contains the optional parameters for the VirtualNetworksClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualNetworkUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualNetworksClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<virtual-network-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualNetworksClientUpdateTagsResult)
}

Output:

type VirtualNetworksClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualNetworksClientBeginCreateOrUpdateOptions struct {
}

VirtualNetworksClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworksClient.BeginCreateOrUpdate method.

type VirtualNetworksClientBeginDeleteOptions added in v0.3.0 

type VirtualNetworksClientBeginDeleteOptions struct {
}

VirtualNetworksClientBeginDeleteOptions contains the optional parameters for the VirtualNetworksClient.BeginDelete method.

type VirtualNetworksClientCheckIPAddressAvailabilityOptions added in v0.3.0 

type VirtualNetworksClientCheckIPAddressAvailabilityOptions struct {
}

VirtualNetworksClientCheckIPAddressAvailabilityOptions contains the optional parameters for the VirtualNetworksClient.CheckIPAddressAvailability method.

type VirtualNetworksClientCheckIPAddressAvailabilityResponse added in v0.3.0 

type VirtualNetworksClientCheckIPAddressAvailabilityResponse struct {
	VirtualNetworksClientCheckIPAddressAvailabilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworksClientCheckIPAddressAvailabilityResponse contains the response from method VirtualNetworksClient.CheckIPAddressAvailability.

type VirtualNetworksClientCheckIPAddressAvailabilityResult added in v0.3.0 

type VirtualNetworksClientCheckIPAddressAvailabilityResult struct {
	IPAddressAvailabilityResult
}

VirtualNetworksClientCheckIPAddressAvailabilityResult contains the result from method VirtualNetworksClient.CheckIPAddressAvailability.

type VirtualNetworksClientCreateOrUpdatePoller added in v0.3.0 

type VirtualNetworksClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworksClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworksClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualNetworksClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworksClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworksClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualNetworksClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworksClientCreateOrUpdateResponse will be returned.

func (*VirtualNetworksClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualNetworksClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworksClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworksClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworksClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualNetworksClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworksClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworksClientCreateOrUpdatePollerResponse contains the response from method VirtualNetworksClient.CreateOrUpdate.

func (VirtualNetworksClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworksClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworksClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworksClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworksClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualNetworksClient, token string) error

Resume rehydrates a VirtualNetworksClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualNetworksClientCreateOrUpdateResponse added in v0.3.0 

type VirtualNetworksClientCreateOrUpdateResponse struct {
	VirtualNetworksClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworksClientCreateOrUpdateResponse contains the response from method VirtualNetworksClient.CreateOrUpdate.

type VirtualNetworksClientCreateOrUpdateResult added in v0.3.0 

type VirtualNetworksClientCreateOrUpdateResult struct {
	VirtualNetwork
}

VirtualNetworksClientCreateOrUpdateResult contains the result from method VirtualNetworksClient.CreateOrUpdate.

type VirtualNetworksClientDeletePoller added in v0.3.0 

type VirtualNetworksClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualNetworksClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualNetworksClientDeletePoller) Done added in v0.3.0 

func (p *VirtualNetworksClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualNetworksClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualNetworksClientDeletePoller) FinalResponse(ctx context.Context) (VirtualNetworksClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualNetworksClientDeleteResponse will be returned.

func (*VirtualNetworksClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualNetworksClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualNetworksClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualNetworksClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualNetworksClientDeletePollerResponse added in v0.3.0 

type VirtualNetworksClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualNetworksClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworksClientDeletePollerResponse contains the response from method VirtualNetworksClient.Delete.

func (VirtualNetworksClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualNetworksClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualNetworksClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualNetworksClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualNetworksClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualNetworksClient, token string) error

Resume rehydrates a VirtualNetworksClientDeletePollerResponse from the provided client and resume token.

type VirtualNetworksClientDeleteResponse added in v0.3.0 

type VirtualNetworksClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworksClientDeleteResponse contains the response from method VirtualNetworksClient.Delete.

type VirtualNetworksClientGetOptions added in v0.3.0 

type VirtualNetworksClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

VirtualNetworksClientGetOptions contains the optional parameters for the VirtualNetworksClient.Get method.

type VirtualNetworksClientGetResponse added in v0.3.0 

type VirtualNetworksClientGetResponse struct {
	VirtualNetworksClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworksClientGetResponse contains the response from method VirtualNetworksClient.Get.

type VirtualNetworksClientGetResult added in v0.3.0 

type VirtualNetworksClientGetResult struct {
	VirtualNetwork
}

VirtualNetworksClientGetResult contains the result from method VirtualNetworksClient.Get.

type VirtualNetworksClientListAllOptions added in v0.3.0 

type VirtualNetworksClientListAllOptions struct {
}

VirtualNetworksClientListAllOptions contains the optional parameters for the VirtualNetworksClient.ListAll method.

type VirtualNetworksClientListAllPager added in v0.3.0 

type VirtualNetworksClientListAllPager struct {
	// contains filtered or unexported fields
}

VirtualNetworksClientListAllPager provides operations for iterating over paged responses.

func (*VirtualNetworksClientListAllPager) Err added in v0.3.0 

func (p *VirtualNetworksClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualNetworksClientListAllPager) NextPage added in v0.3.0 

func (p *VirtualNetworksClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworksClientListAllPager) PageResponse added in v0.3.0 

func (p *VirtualNetworksClientListAllPager) PageResponse() VirtualNetworksClientListAllResponse

PageResponse returns the current VirtualNetworksClientListAllResponse page.

type VirtualNetworksClientListAllResponse added in v0.3.0 

type VirtualNetworksClientListAllResponse struct {
	VirtualNetworksClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworksClientListAllResponse contains the response from method VirtualNetworksClient.ListAll.

type VirtualNetworksClientListAllResult added in v0.3.0 

type VirtualNetworksClientListAllResult struct {
	VirtualNetworkListResult
}

VirtualNetworksClientListAllResult contains the result from method VirtualNetworksClient.ListAll.

type VirtualNetworksClientListOptions added in v0.3.0 

type VirtualNetworksClientListOptions struct {
}

VirtualNetworksClientListOptions contains the optional parameters for the VirtualNetworksClient.List method.

type VirtualNetworksClientListPager added in v0.3.0 

type VirtualNetworksClientListPager struct {
	// contains filtered or unexported fields
}

VirtualNetworksClientListPager provides operations for iterating over paged responses.

func (*VirtualNetworksClientListPager) Err added in v0.3.0 

func (p *VirtualNetworksClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualNetworksClientListPager) NextPage added in v0.3.0 

func (p *VirtualNetworksClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworksClientListPager) PageResponse added in v0.3.0 

func (p *VirtualNetworksClientListPager) PageResponse() VirtualNetworksClientListResponse

PageResponse returns the current VirtualNetworksClientListResponse page.

type VirtualNetworksClientListResponse added in v0.3.0 

type VirtualNetworksClientListResponse struct {
	VirtualNetworksClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworksClientListResponse contains the response from method VirtualNetworksClient.List.

type VirtualNetworksClientListResult added in v0.3.0 

type VirtualNetworksClientListResult struct {
	VirtualNetworkListResult
}

VirtualNetworksClientListResult contains the result from method VirtualNetworksClient.List.

type VirtualNetworksClientListUsageOptions added in v0.3.0 

type VirtualNetworksClientListUsageOptions struct {
}

VirtualNetworksClientListUsageOptions contains the optional parameters for the VirtualNetworksClient.ListUsage method.

type VirtualNetworksClientListUsagePager added in v0.3.0 

type VirtualNetworksClientListUsagePager struct {
	// contains filtered or unexported fields
}

VirtualNetworksClientListUsagePager provides operations for iterating over paged responses.

func (*VirtualNetworksClientListUsagePager) Err added in v0.3.0 

func (p *VirtualNetworksClientListUsagePager) Err() error

Err returns the last error encountered while paging.

func (*VirtualNetworksClientListUsagePager) NextPage added in v0.3.0 

func (p *VirtualNetworksClientListUsagePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualNetworksClientListUsagePager) PageResponse added in v0.3.0 

func (p *VirtualNetworksClientListUsagePager) PageResponse() VirtualNetworksClientListUsageResponse

PageResponse returns the current VirtualNetworksClientListUsageResponse page.

type VirtualNetworksClientListUsageResponse added in v0.3.0 

type VirtualNetworksClientListUsageResponse struct {
	VirtualNetworksClientListUsageResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworksClientListUsageResponse contains the response from method VirtualNetworksClient.ListUsage.

type VirtualNetworksClientListUsageResult added in v0.3.0 

type VirtualNetworksClientListUsageResult struct {
	VirtualNetworkListUsageResult
}

VirtualNetworksClientListUsageResult contains the result from method VirtualNetworksClient.ListUsage.

type VirtualNetworksClientUpdateTagsOptions added in v0.3.0 

type VirtualNetworksClientUpdateTagsOptions struct {
}

VirtualNetworksClientUpdateTagsOptions contains the optional parameters for the VirtualNetworksClient.UpdateTags method.

type VirtualNetworksClientUpdateTagsResponse added in v0.3.0 

type VirtualNetworksClientUpdateTagsResponse struct {
	VirtualNetworksClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualNetworksClientUpdateTagsResponse contains the response from method VirtualNetworksClient.UpdateTags.

type VirtualNetworksClientUpdateTagsResult added in v0.3.0 

type VirtualNetworksClientUpdateTagsResult struct {
	VirtualNetwork
}

VirtualNetworksClientUpdateTagsResult contains the result from method VirtualNetworksClient.UpdateTags.

type VirtualRouter 

type VirtualRouter struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the Virtual Router.
	Properties *VirtualRouterPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualRouter Resource.

func (VirtualRouter) MarshalJSON 

func (v VirtualRouter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualRouter.

type VirtualRouterListResult 

type VirtualRouterListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Virtual Routers.
	Value []*VirtualRouter `json:"value,omitempty"`
}

VirtualRouterListResult - Response for ListVirtualRouters API service call.

func (VirtualRouterListResult) MarshalJSON 

func (v VirtualRouterListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualRouterListResult.

type VirtualRouterPeering 

type VirtualRouterPeering struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Name of the virtual router peering that is unique within a virtual router.
	Name *string `json:"name,omitempty"`

	// The properties of the Virtual Router Peering.
	Properties *VirtualRouterPeeringProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Peering type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualRouterPeering - Virtual Router Peering resource.

type VirtualRouterPeeringListResult 

type VirtualRouterPeeringListResult struct {
	// URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty"`

	// List of VirtualRouterPeerings in a VirtualRouter.
	Value []*VirtualRouterPeering `json:"value,omitempty"`
}

VirtualRouterPeeringListResult - Response for ListVirtualRouterPeerings API service call.

func (VirtualRouterPeeringListResult) MarshalJSON 

func (v VirtualRouterPeeringListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualRouterPeeringListResult.

type VirtualRouterPeeringProperties 

type VirtualRouterPeeringProperties struct {
	// Peer ASN.
	PeerAsn *int64 `json:"peerAsn,omitempty"`

	// Peer IP.
	PeerIP *string `json:"peerIp,omitempty"`

	// READ-ONLY; The provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VirtualRouterPeeringProperties - Properties of the rule group.

type VirtualRouterPeeringsClient 

type VirtualRouterPeeringsClient struct {
	// contains filtered or unexported fields
}

VirtualRouterPeeringsClient contains the methods for the VirtualRouterPeerings group. Don't use this type directly, use NewVirtualRouterPeeringsClient() instead.

func NewVirtualRouterPeeringsClient 

func NewVirtualRouterPeeringsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualRouterPeeringsClient

NewVirtualRouterPeeringsClient creates a new instance of VirtualRouterPeeringsClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualRouterPeeringsClient) BeginCreateOrUpdate 

func (client *VirtualRouterPeeringsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualRouterName string, peeringName string, parameters VirtualRouterPeering, options *VirtualRouterPeeringsClientBeginCreateOrUpdateOptions) (VirtualRouterPeeringsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified Virtual Router Peering. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualRouterName - The name of the Virtual Router. peeringName - The name of the Virtual Router Peering. parameters - Parameters supplied to the create or update Virtual Router Peering operation. options - VirtualRouterPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualRouterPeeringsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterPeeringPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualRouterPeeringsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-router-name>",
		"<peering-name>",
		armnetwork.VirtualRouterPeering{
			Properties: &armnetwork.VirtualRouterPeeringProperties{
				PeerAsn: to.Int64Ptr(20000),
				PeerIP:  to.StringPtr("<peer-ip>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualRouterPeeringsClientCreateOrUpdateResult)
}

Output:

func (*VirtualRouterPeeringsClient) BeginDelete 

func (client *VirtualRouterPeeringsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualRouterName string, peeringName string, options *VirtualRouterPeeringsClientBeginDeleteOptions) (VirtualRouterPeeringsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified peering from a Virtual Router. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualRouterName - The name of the Virtual Router. peeringName - The name of the peering. options - VirtualRouterPeeringsClientBeginDeleteOptions contains the optional parameters for the VirtualRouterPeeringsClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterPeeringDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualRouterPeeringsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-router-name>",
		"<peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualRouterPeeringsClient) Get 

func (client *VirtualRouterPeeringsClient) Get(ctx context.Context, resourceGroupName string, virtualRouterName string, peeringName string, options *VirtualRouterPeeringsClientGetOptions) (VirtualRouterPeeringsClientGetResponse, error)

Get - Gets the specified Virtual Router Peering. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualRouterName - The name of the Virtual Router. peeringName - The name of the Virtual Router Peering. options - VirtualRouterPeeringsClientGetOptions contains the optional parameters for the VirtualRouterPeeringsClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterPeeringGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualRouterPeeringsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-router-name>",
		"<peering-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualRouterPeeringsClientGetResult)
}

Output:

func (*VirtualRouterPeeringsClient) List 

func (client *VirtualRouterPeeringsClient) List(resourceGroupName string, virtualRouterName string, options *VirtualRouterPeeringsClientListOptions) *VirtualRouterPeeringsClientListPager

List - Lists all Virtual Router Peerings in a Virtual Router resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualRouterName - The name of the Virtual Router. options - VirtualRouterPeeringsClientListOptions contains the optional parameters for the VirtualRouterPeeringsClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterPeeringList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualRouterPeeringsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<virtual-router-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VirtualRouterPeeringsClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualRouterPeeringsClientBeginCreateOrUpdateOptions struct {
}

VirtualRouterPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualRouterPeeringsClient.BeginCreateOrUpdate method.

type VirtualRouterPeeringsClientBeginDeleteOptions added in v0.3.0 

type VirtualRouterPeeringsClientBeginDeleteOptions struct {
}

VirtualRouterPeeringsClientBeginDeleteOptions contains the optional parameters for the VirtualRouterPeeringsClient.BeginDelete method.

type VirtualRouterPeeringsClientCreateOrUpdatePoller added in v0.3.0 

type VirtualRouterPeeringsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualRouterPeeringsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualRouterPeeringsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualRouterPeeringsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualRouterPeeringsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualRouterPeeringsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualRouterPeeringsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualRouterPeeringsClientCreateOrUpdateResponse will be returned.

func (*VirtualRouterPeeringsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualRouterPeeringsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualRouterPeeringsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualRouterPeeringsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualRouterPeeringsClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualRouterPeeringsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualRouterPeeringsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRouterPeeringsClientCreateOrUpdatePollerResponse contains the response from method VirtualRouterPeeringsClient.CreateOrUpdate.

func (VirtualRouterPeeringsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualRouterPeeringsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualRouterPeeringsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualRouterPeeringsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualRouterPeeringsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualRouterPeeringsClient, token string) error

Resume rehydrates a VirtualRouterPeeringsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualRouterPeeringsClientCreateOrUpdateResponse added in v0.3.0 

type VirtualRouterPeeringsClientCreateOrUpdateResponse struct {
	VirtualRouterPeeringsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRouterPeeringsClientCreateOrUpdateResponse contains the response from method VirtualRouterPeeringsClient.CreateOrUpdate.

type VirtualRouterPeeringsClientCreateOrUpdateResult added in v0.3.0 

type VirtualRouterPeeringsClientCreateOrUpdateResult struct {
	VirtualRouterPeering
}

VirtualRouterPeeringsClientCreateOrUpdateResult contains the result from method VirtualRouterPeeringsClient.CreateOrUpdate.

type VirtualRouterPeeringsClientDeletePoller added in v0.3.0 

type VirtualRouterPeeringsClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualRouterPeeringsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualRouterPeeringsClientDeletePoller) Done added in v0.3.0 

func (p *VirtualRouterPeeringsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualRouterPeeringsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualRouterPeeringsClientDeletePoller) FinalResponse(ctx context.Context) (VirtualRouterPeeringsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualRouterPeeringsClientDeleteResponse will be returned.

func (*VirtualRouterPeeringsClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualRouterPeeringsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualRouterPeeringsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualRouterPeeringsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualRouterPeeringsClientDeletePollerResponse added in v0.3.0 

type VirtualRouterPeeringsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualRouterPeeringsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRouterPeeringsClientDeletePollerResponse contains the response from method VirtualRouterPeeringsClient.Delete.

func (VirtualRouterPeeringsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualRouterPeeringsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualRouterPeeringsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualRouterPeeringsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualRouterPeeringsClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualRouterPeeringsClient, token string) error

Resume rehydrates a VirtualRouterPeeringsClientDeletePollerResponse from the provided client and resume token.

type VirtualRouterPeeringsClientDeleteResponse added in v0.3.0 

type VirtualRouterPeeringsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRouterPeeringsClientDeleteResponse contains the response from method VirtualRouterPeeringsClient.Delete.

type VirtualRouterPeeringsClientGetOptions added in v0.3.0 

type VirtualRouterPeeringsClientGetOptions struct {
}

VirtualRouterPeeringsClientGetOptions contains the optional parameters for the VirtualRouterPeeringsClient.Get method.

type VirtualRouterPeeringsClientGetResponse added in v0.3.0 

type VirtualRouterPeeringsClientGetResponse struct {
	VirtualRouterPeeringsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRouterPeeringsClientGetResponse contains the response from method VirtualRouterPeeringsClient.Get.

type VirtualRouterPeeringsClientGetResult added in v0.3.0 

type VirtualRouterPeeringsClientGetResult struct {
	VirtualRouterPeering
}

VirtualRouterPeeringsClientGetResult contains the result from method VirtualRouterPeeringsClient.Get.

type VirtualRouterPeeringsClientListOptions added in v0.3.0 

type VirtualRouterPeeringsClientListOptions struct {
}

VirtualRouterPeeringsClientListOptions contains the optional parameters for the VirtualRouterPeeringsClient.List method.

type VirtualRouterPeeringsClientListPager added in v0.3.0 

type VirtualRouterPeeringsClientListPager struct {
	// contains filtered or unexported fields
}

VirtualRouterPeeringsClientListPager provides operations for iterating over paged responses.

func (*VirtualRouterPeeringsClientListPager) Err added in v0.3.0 

func (p *VirtualRouterPeeringsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualRouterPeeringsClientListPager) NextPage added in v0.3.0 

func (p *VirtualRouterPeeringsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualRouterPeeringsClientListPager) PageResponse added in v0.3.0 

func (p *VirtualRouterPeeringsClientListPager) PageResponse() VirtualRouterPeeringsClientListResponse

PageResponse returns the current VirtualRouterPeeringsClientListResponse page.

type VirtualRouterPeeringsClientListResponse added in v0.3.0 

type VirtualRouterPeeringsClientListResponse struct {
	VirtualRouterPeeringsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRouterPeeringsClientListResponse contains the response from method VirtualRouterPeeringsClient.List.

type VirtualRouterPeeringsClientListResult added in v0.3.0 

type VirtualRouterPeeringsClientListResult struct {
	VirtualRouterPeeringListResult
}

VirtualRouterPeeringsClientListResult contains the result from method VirtualRouterPeeringsClient.List.

type VirtualRouterPropertiesFormat 

type VirtualRouterPropertiesFormat struct {
	// The Gateway on which VirtualRouter is hosted.
	HostedGateway *SubResource `json:"hostedGateway,omitempty"`

	// The Subnet on which VirtualRouter is hosted.
	HostedSubnet *SubResource `json:"hostedSubnet,omitempty"`

	// VirtualRouter ASN.
	VirtualRouterAsn *int64 `json:"virtualRouterAsn,omitempty"`

	// VirtualRouter IPs.
	VirtualRouterIPs []*string `json:"virtualRouterIps,omitempty"`

	// READ-ONLY; List of references to VirtualRouterPeerings.
	Peerings []*SubResource `json:"peerings,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

VirtualRouterPropertiesFormat - Virtual Router definition.

func (VirtualRouterPropertiesFormat) MarshalJSON 

func (v VirtualRouterPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualRouterPropertiesFormat.

type VirtualRoutersClient 

type VirtualRoutersClient struct {
	// contains filtered or unexported fields
}

VirtualRoutersClient contains the methods for the VirtualRouters group. Don't use this type directly, use NewVirtualRoutersClient() instead.

func NewVirtualRoutersClient 

func NewVirtualRoutersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualRoutersClient

NewVirtualRoutersClient creates a new instance of VirtualRoutersClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualRoutersClient) BeginCreateOrUpdate 

func (client *VirtualRoutersClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualRouterName string, parameters VirtualRouter, options *VirtualRoutersClientBeginCreateOrUpdateOptions) (VirtualRoutersClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates or updates the specified Virtual Router. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualRouterName - The name of the Virtual Router. parameters - Parameters supplied to the create or update Virtual Router. options - VirtualRoutersClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualRoutersClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualRoutersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-router-name>",
		armnetwork.VirtualRouter{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.VirtualRouterPropertiesFormat{
				HostedGateway: &armnetwork.SubResource{
					ID: to.StringPtr("<id>"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualRoutersClientCreateOrUpdateResult)
}

Output:

func (*VirtualRoutersClient) BeginDelete 

func (client *VirtualRoutersClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualRouterName string, options *VirtualRoutersClientBeginDeleteOptions) (VirtualRoutersClientDeletePollerResponse, error)

BeginDelete - Deletes the specified Virtual Router. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualRouterName - The name of the Virtual Router. options - VirtualRoutersClientBeginDeleteOptions contains the optional parameters for the VirtualRoutersClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualRoutersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-router-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualRoutersClient) Get 

func (client *VirtualRoutersClient) Get(ctx context.Context, resourceGroupName string, virtualRouterName string, options *VirtualRoutersClientGetOptions) (VirtualRoutersClientGetResponse, error)

Get - Gets the specified Virtual Router. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. virtualRouterName - The name of the Virtual Router. options - VirtualRoutersClientGetOptions contains the optional parameters for the VirtualRoutersClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualRoutersClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-router-name>",
		&armnetwork.VirtualRoutersClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualRoutersClientGetResult)
}

Output:

func (*VirtualRoutersClient) List 

func (client *VirtualRoutersClient) List(options *VirtualRoutersClientListOptions) *VirtualRoutersClientListPager

List - Gets all the Virtual Routers in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - VirtualRoutersClientListOptions contains the optional parameters for the VirtualRoutersClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualRoutersClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualRoutersClient) ListByResourceGroup 

func (client *VirtualRoutersClient) ListByResourceGroup(resourceGroupName string, options *VirtualRoutersClientListByResourceGroupOptions) *VirtualRoutersClientListByResourceGroupPager

ListByResourceGroup - Lists all Virtual Routers in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - VirtualRoutersClientListByResourceGroupOptions contains the optional parameters for the VirtualRoutersClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualRouterListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualRoutersClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type VirtualRoutersClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualRoutersClientBeginCreateOrUpdateOptions struct {
}

VirtualRoutersClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualRoutersClient.BeginCreateOrUpdate method.

type VirtualRoutersClientBeginDeleteOptions added in v0.3.0 

type VirtualRoutersClientBeginDeleteOptions struct {
}

VirtualRoutersClientBeginDeleteOptions contains the optional parameters for the VirtualRoutersClient.BeginDelete method.

type VirtualRoutersClientCreateOrUpdatePoller added in v0.3.0 

type VirtualRoutersClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualRoutersClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualRoutersClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualRoutersClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualRoutersClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualRoutersClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualRoutersClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualRoutersClientCreateOrUpdateResponse will be returned.

func (*VirtualRoutersClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualRoutersClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualRoutersClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualRoutersClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualRoutersClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualRoutersClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualRoutersClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRoutersClientCreateOrUpdatePollerResponse contains the response from method VirtualRoutersClient.CreateOrUpdate.

func (VirtualRoutersClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualRoutersClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualRoutersClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualRoutersClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualRoutersClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualRoutersClient, token string) error

Resume rehydrates a VirtualRoutersClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualRoutersClientCreateOrUpdateResponse added in v0.3.0 

type VirtualRoutersClientCreateOrUpdateResponse struct {
	VirtualRoutersClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRoutersClientCreateOrUpdateResponse contains the response from method VirtualRoutersClient.CreateOrUpdate.

type VirtualRoutersClientCreateOrUpdateResult added in v0.3.0 

type VirtualRoutersClientCreateOrUpdateResult struct {
	VirtualRouter
}

VirtualRoutersClientCreateOrUpdateResult contains the result from method VirtualRoutersClient.CreateOrUpdate.

type VirtualRoutersClientDeletePoller added in v0.3.0 

type VirtualRoutersClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualRoutersClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualRoutersClientDeletePoller) Done added in v0.3.0 

func (p *VirtualRoutersClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualRoutersClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualRoutersClientDeletePoller) FinalResponse(ctx context.Context) (VirtualRoutersClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualRoutersClientDeleteResponse will be returned.

func (*VirtualRoutersClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualRoutersClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualRoutersClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualRoutersClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualRoutersClientDeletePollerResponse added in v0.3.0 

type VirtualRoutersClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualRoutersClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRoutersClientDeletePollerResponse contains the response from method VirtualRoutersClient.Delete.

func (VirtualRoutersClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualRoutersClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualRoutersClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualRoutersClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualRoutersClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualRoutersClient, token string) error

Resume rehydrates a VirtualRoutersClientDeletePollerResponse from the provided client and resume token.

type VirtualRoutersClientDeleteResponse added in v0.3.0 

type VirtualRoutersClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRoutersClientDeleteResponse contains the response from method VirtualRoutersClient.Delete.

type VirtualRoutersClientGetOptions added in v0.3.0 

type VirtualRoutersClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

VirtualRoutersClientGetOptions contains the optional parameters for the VirtualRoutersClient.Get method.

type VirtualRoutersClientGetResponse added in v0.3.0 

type VirtualRoutersClientGetResponse struct {
	VirtualRoutersClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRoutersClientGetResponse contains the response from method VirtualRoutersClient.Get.

type VirtualRoutersClientGetResult added in v0.3.0 

type VirtualRoutersClientGetResult struct {
	VirtualRouter
}

VirtualRoutersClientGetResult contains the result from method VirtualRoutersClient.Get.

type VirtualRoutersClientListByResourceGroupOptions added in v0.3.0 

type VirtualRoutersClientListByResourceGroupOptions struct {
}

VirtualRoutersClientListByResourceGroupOptions contains the optional parameters for the VirtualRoutersClient.ListByResourceGroup method.

type VirtualRoutersClientListByResourceGroupPager added in v0.3.0 

type VirtualRoutersClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

VirtualRoutersClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*VirtualRoutersClientListByResourceGroupPager) Err added in v0.3.0 

func (p *VirtualRoutersClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualRoutersClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *VirtualRoutersClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualRoutersClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *VirtualRoutersClientListByResourceGroupPager) PageResponse() VirtualRoutersClientListByResourceGroupResponse

PageResponse returns the current VirtualRoutersClientListByResourceGroupResponse page.

type VirtualRoutersClientListByResourceGroupResponse added in v0.3.0 

type VirtualRoutersClientListByResourceGroupResponse struct {
	VirtualRoutersClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRoutersClientListByResourceGroupResponse contains the response from method VirtualRoutersClient.ListByResourceGroup.

type VirtualRoutersClientListByResourceGroupResult added in v0.3.0 

type VirtualRoutersClientListByResourceGroupResult struct {
	VirtualRouterListResult
}

VirtualRoutersClientListByResourceGroupResult contains the result from method VirtualRoutersClient.ListByResourceGroup.

type VirtualRoutersClientListOptions added in v0.3.0 

type VirtualRoutersClientListOptions struct {
}

VirtualRoutersClientListOptions contains the optional parameters for the VirtualRoutersClient.List method.

type VirtualRoutersClientListPager added in v0.3.0 

type VirtualRoutersClientListPager struct {
	// contains filtered or unexported fields
}

VirtualRoutersClientListPager provides operations for iterating over paged responses.

func (*VirtualRoutersClientListPager) Err added in v0.3.0 

func (p *VirtualRoutersClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualRoutersClientListPager) NextPage added in v0.3.0 

func (p *VirtualRoutersClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualRoutersClientListPager) PageResponse added in v0.3.0 

func (p *VirtualRoutersClientListPager) PageResponse() VirtualRoutersClientListResponse

PageResponse returns the current VirtualRoutersClientListResponse page.

type VirtualRoutersClientListResponse added in v0.3.0 

type VirtualRoutersClientListResponse struct {
	VirtualRoutersClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualRoutersClientListResponse contains the response from method VirtualRoutersClient.List.

type VirtualRoutersClientListResult added in v0.3.0 

type VirtualRoutersClientListResult struct {
	VirtualRouterListResult
}

VirtualRoutersClientListResult contains the result from method VirtualRoutersClient.List.

type VirtualWAN 

type VirtualWAN struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the virtual WAN.
	Properties *VirtualWanProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VirtualWAN Resource.

func (VirtualWAN) MarshalJSON 

func (v VirtualWAN) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualWAN.

type VirtualWanProperties 

type VirtualWanProperties struct {
	// True if branch to branch traffic is allowed.
	AllowBranchToBranchTraffic *bool `json:"allowBranchToBranchTraffic,omitempty"`

	// True if Vnet to Vnet traffic is allowed.
	AllowVnetToVnetTraffic *bool `json:"allowVnetToVnetTraffic,omitempty"`

	// Vpn encryption to be disabled or not.
	DisableVPNEncryption *bool `json:"disableVpnEncryption,omitempty"`

	// The type of the VirtualWAN.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; The office local breakout category.
	Office365LocalBreakoutCategory *OfficeTrafficCategory `json:"office365LocalBreakoutCategory,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the virtual WAN resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; List of VpnSites in the VirtualWAN.
	VPNSites []*SubResource `json:"vpnSites,omitempty" azure:"ro"`

	// READ-ONLY; List of VirtualHubs in the VirtualWAN.
	VirtualHubs []*SubResource `json:"virtualHubs,omitempty" azure:"ro"`
}

VirtualWanProperties - Parameters for VirtualWAN.

func (VirtualWanProperties) MarshalJSON 

func (v VirtualWanProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualWanProperties.

type VirtualWanSecurityProvider 

type VirtualWanSecurityProvider struct {
	// Name of the security provider.
	Name *string `json:"name,omitempty"`

	// Url of the security provider.
	URL *string `json:"url,omitempty"`

	// READ-ONLY; Name of the security provider.
	Type *VirtualWanSecurityProviderType `json:"type,omitempty" azure:"ro"`
}

VirtualWanSecurityProvider - Collection of SecurityProviders.

type VirtualWanSecurityProviderType 

type VirtualWanSecurityProviderType string

VirtualWanSecurityProviderType - The virtual wan security provider type. 

const (
	VirtualWanSecurityProviderTypeExternal VirtualWanSecurityProviderType = "External"
	VirtualWanSecurityProviderTypeNative   VirtualWanSecurityProviderType = "Native"
)

func PossibleVirtualWanSecurityProviderTypeValues 

func PossibleVirtualWanSecurityProviderTypeValues() []VirtualWanSecurityProviderType

PossibleVirtualWanSecurityProviderTypeValues returns the possible values for the VirtualWanSecurityProviderType const type.

func (VirtualWanSecurityProviderType) ToPtr 

func (c VirtualWanSecurityProviderType) ToPtr() *VirtualWanSecurityProviderType

ToPtr returns a *VirtualWanSecurityProviderType pointing to the current value.

type VirtualWanSecurityProviders 

type VirtualWanSecurityProviders struct {
	// List of VirtualWAN security providers.
	SupportedProviders []*VirtualWanSecurityProvider `json:"supportedProviders,omitempty"`
}

VirtualWanSecurityProviders - Collection of SecurityProviders.

func (VirtualWanSecurityProviders) MarshalJSON 

func (v VirtualWanSecurityProviders) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualWanSecurityProviders.

type VirtualWanVPNProfileParameters 

type VirtualWanVPNProfileParameters struct {
	// VPN client authentication method.
	AuthenticationMethod *AuthenticationMethod `json:"authenticationMethod,omitempty"`

	// VpnServerConfiguration partial resource uri with which VirtualWan is associated to.
	VPNServerConfigurationResourceID *string `json:"vpnServerConfigurationResourceId,omitempty"`
}

VirtualWanVPNProfileParameters - Virtual Wan Vpn profile parameters Vpn profile generation.

type VirtualWansClient 

type VirtualWansClient struct {
	// contains filtered or unexported fields
}

VirtualWansClient contains the methods for the VirtualWans group. Don't use this type directly, use NewVirtualWansClient() instead.

func NewVirtualWansClient 

func NewVirtualWansClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VirtualWansClient

NewVirtualWansClient creates a new instance of VirtualWansClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VirtualWansClient) BeginCreateOrUpdate 

func (client *VirtualWansClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualWANName string, wanParameters VirtualWAN, options *VirtualWansClientBeginCreateOrUpdateOptions) (VirtualWansClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualWan. virtualWANName - The name of the VirtualWAN being created or updated. wanParameters - Parameters supplied to create or update VirtualWAN. options - VirtualWansClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualWansClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualWANPut.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualWansClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<virtual-wanname>",
		armnetwork.VirtualWAN{
			Location: to.StringPtr("<location>"),
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
			},
			Properties: &armnetwork.VirtualWanProperties{
				Type:                 to.StringPtr("<type>"),
				DisableVPNEncryption: to.BoolPtr(false),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualWansClientCreateOrUpdateResult)
}

Output:

func (*VirtualWansClient) BeginDelete 

func (client *VirtualWansClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualWANName string, options *VirtualWansClientBeginDeleteOptions) (VirtualWansClientDeletePollerResponse, error)

BeginDelete - Deletes a VirtualWAN. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualWan. virtualWANName - The name of the VirtualWAN being deleted. options - VirtualWansClientBeginDeleteOptions contains the optional parameters for the VirtualWansClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualWANDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualWansClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<virtual-wanname>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VirtualWansClient) Get 

func (client *VirtualWansClient) Get(ctx context.Context, resourceGroupName string, virtualWANName string, options *VirtualWansClientGetOptions) (VirtualWansClientGetResponse, error)

Get - Retrieves the details of a VirtualWAN. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualWan. virtualWANName - The name of the VirtualWAN being retrieved. options - VirtualWansClientGetOptions contains the optional parameters for the VirtualWansClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualWANGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualWansClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<virtual-wanname>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualWansClientGetResult)
}

Output:

func (*VirtualWansClient) List 

func (client *VirtualWansClient) List(options *VirtualWansClientListOptions) *VirtualWansClientListPager

List - Lists all the VirtualWANs in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - VirtualWansClientListOptions contains the optional parameters for the VirtualWansClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualWANList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualWansClient("<subscription-id>", cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualWansClient) ListByResourceGroup 

func (client *VirtualWansClient) ListByResourceGroup(resourceGroupName string, options *VirtualWansClientListByResourceGroupOptions) *VirtualWansClientListByResourceGroupPager

ListByResourceGroup - Lists all the VirtualWANs in a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualWan. options - VirtualWansClientListByResourceGroupOptions contains the optional parameters for the VirtualWansClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualWANListByResourceGroup.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualWansClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VirtualWansClient) UpdateTags 

func (client *VirtualWansClient) UpdateTags(ctx context.Context, resourceGroupName string, virtualWANName string, wanParameters TagsObject, options *VirtualWansClientUpdateTagsOptions) (VirtualWansClientUpdateTagsResponse, error)

UpdateTags - Updates a VirtualWAN tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The resource group name of the VirtualWan. virtualWANName - The name of the VirtualWAN being updated. wanParameters - Parameters supplied to Update VirtualWAN tags. options - VirtualWansClientUpdateTagsOptions contains the optional parameters for the VirtualWansClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/VirtualWANUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewVirtualWansClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<virtual-wanname>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"key1": to.StringPtr("value1"),
				"key2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VirtualWansClientUpdateTagsResult)
}

Output:

type VirtualWansClientBeginCreateOrUpdateOptions added in v0.3.0 

type VirtualWansClientBeginCreateOrUpdateOptions struct {
}

VirtualWansClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualWansClient.BeginCreateOrUpdate method.

type VirtualWansClientBeginDeleteOptions added in v0.3.0 

type VirtualWansClientBeginDeleteOptions struct {
}

VirtualWansClientBeginDeleteOptions contains the optional parameters for the VirtualWansClient.BeginDelete method.

type VirtualWansClientCreateOrUpdatePoller added in v0.3.0 

type VirtualWansClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

VirtualWansClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualWansClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VirtualWansClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualWansClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VirtualWansClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VirtualWansClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualWansClientCreateOrUpdateResponse will be returned.

func (*VirtualWansClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VirtualWansClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualWansClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VirtualWansClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualWansClientCreateOrUpdatePollerResponse added in v0.3.0 

type VirtualWansClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualWansClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualWansClientCreateOrUpdatePollerResponse contains the response from method VirtualWansClient.CreateOrUpdate.

func (VirtualWansClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualWansClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualWansClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualWansClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VirtualWansClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VirtualWansClient, token string) error

Resume rehydrates a VirtualWansClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VirtualWansClientCreateOrUpdateResponse added in v0.3.0 

type VirtualWansClientCreateOrUpdateResponse struct {
	VirtualWansClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualWansClientCreateOrUpdateResponse contains the response from method VirtualWansClient.CreateOrUpdate.

type VirtualWansClientCreateOrUpdateResult added in v0.3.0 

type VirtualWansClientCreateOrUpdateResult struct {
	VirtualWAN
}

VirtualWansClientCreateOrUpdateResult contains the result from method VirtualWansClient.CreateOrUpdate.

type VirtualWansClientDeletePoller added in v0.3.0 

type VirtualWansClientDeletePoller struct {
	// contains filtered or unexported fields
}

VirtualWansClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*VirtualWansClientDeletePoller) Done added in v0.3.0 

func (p *VirtualWansClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VirtualWansClientDeletePoller) FinalResponse added in v0.3.0 

func (p *VirtualWansClientDeletePoller) FinalResponse(ctx context.Context) (VirtualWansClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VirtualWansClientDeleteResponse will be returned.

func (*VirtualWansClientDeletePoller) Poll added in v0.3.0 

func (p *VirtualWansClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VirtualWansClientDeletePoller) ResumeToken added in v0.3.0 

func (p *VirtualWansClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VirtualWansClientDeletePollerResponse added in v0.3.0 

type VirtualWansClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VirtualWansClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualWansClientDeletePollerResponse contains the response from method VirtualWansClient.Delete.

func (VirtualWansClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l VirtualWansClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VirtualWansClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VirtualWansClientDeletePollerResponse) Resume added in v0.3.0 

func (l *VirtualWansClientDeletePollerResponse) Resume(ctx context.Context, client *VirtualWansClient, token string) error

Resume rehydrates a VirtualWansClientDeletePollerResponse from the provided client and resume token.

type VirtualWansClientDeleteResponse added in v0.3.0 

type VirtualWansClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualWansClientDeleteResponse contains the response from method VirtualWansClient.Delete.

type VirtualWansClientGetOptions added in v0.3.0 

type VirtualWansClientGetOptions struct {
}

VirtualWansClientGetOptions contains the optional parameters for the VirtualWansClient.Get method.

type VirtualWansClientGetResponse added in v0.3.0 

type VirtualWansClientGetResponse struct {
	VirtualWansClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualWansClientGetResponse contains the response from method VirtualWansClient.Get.

type VirtualWansClientGetResult added in v0.3.0 

type VirtualWansClientGetResult struct {
	VirtualWAN
}

VirtualWansClientGetResult contains the result from method VirtualWansClient.Get.

type VirtualWansClientListByResourceGroupOptions added in v0.3.0 

type VirtualWansClientListByResourceGroupOptions struct {
}

VirtualWansClientListByResourceGroupOptions contains the optional parameters for the VirtualWansClient.ListByResourceGroup method.

type VirtualWansClientListByResourceGroupPager added in v0.3.0 

type VirtualWansClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

VirtualWansClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*VirtualWansClientListByResourceGroupPager) Err added in v0.3.0 

func (p *VirtualWansClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualWansClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *VirtualWansClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualWansClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *VirtualWansClientListByResourceGroupPager) PageResponse() VirtualWansClientListByResourceGroupResponse

PageResponse returns the current VirtualWansClientListByResourceGroupResponse page.

type VirtualWansClientListByResourceGroupResponse added in v0.3.0 

type VirtualWansClientListByResourceGroupResponse struct {
	VirtualWansClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualWansClientListByResourceGroupResponse contains the response from method VirtualWansClient.ListByResourceGroup.

type VirtualWansClientListByResourceGroupResult added in v0.3.0 

type VirtualWansClientListByResourceGroupResult struct {
	ListVirtualWANsResult
}

VirtualWansClientListByResourceGroupResult contains the result from method VirtualWansClient.ListByResourceGroup.

type VirtualWansClientListOptions added in v0.3.0 

type VirtualWansClientListOptions struct {
}

VirtualWansClientListOptions contains the optional parameters for the VirtualWansClient.List method.

type VirtualWansClientListPager added in v0.3.0 

type VirtualWansClientListPager struct {
	// contains filtered or unexported fields
}

VirtualWansClientListPager provides operations for iterating over paged responses.

func (*VirtualWansClientListPager) Err added in v0.3.0 

func (p *VirtualWansClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VirtualWansClientListPager) NextPage added in v0.3.0 

func (p *VirtualWansClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VirtualWansClientListPager) PageResponse added in v0.3.0 

func (p *VirtualWansClientListPager) PageResponse() VirtualWansClientListResponse

PageResponse returns the current VirtualWansClientListResponse page.

type VirtualWansClientListResponse added in v0.3.0 

type VirtualWansClientListResponse struct {
	VirtualWansClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualWansClientListResponse contains the response from method VirtualWansClient.List.

type VirtualWansClientListResult added in v0.3.0 

type VirtualWansClientListResult struct {
	ListVirtualWANsResult
}

VirtualWansClientListResult contains the result from method VirtualWansClient.List.

type VirtualWansClientUpdateTagsOptions added in v0.3.0 

type VirtualWansClientUpdateTagsOptions struct {
}

VirtualWansClientUpdateTagsOptions contains the optional parameters for the VirtualWansClient.UpdateTags method.

type VirtualWansClientUpdateTagsResponse added in v0.3.0 

type VirtualWansClientUpdateTagsResponse struct {
	VirtualWansClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VirtualWansClientUpdateTagsResponse contains the response from method VirtualWansClient.UpdateTags.

type VirtualWansClientUpdateTagsResult added in v0.3.0 

type VirtualWansClientUpdateTagsResult struct {
	VirtualWAN
}

VirtualWansClientUpdateTagsResult contains the result from method VirtualWansClient.UpdateTags.

type VnetRoute 

type VnetRoute struct {
	// List of all Static Routes.
	StaticRoutes []*StaticRoute `json:"staticRoutes,omitempty"`

	// READ-ONLY; The list of references to HubBgpConnection objects.
	BgpConnections []*SubResource `json:"bgpConnections,omitempty" azure:"ro"`
}

VnetRoute - List of routes that control routing from VirtualHub into a virtual network connection.

func (VnetRoute) MarshalJSON 

func (v VnetRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VnetRoute.

type Watcher added in v0.3.0 

type Watcher struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the network watcher.
	Properties *WatcherPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Watcher - Network watcher in a resource group.

func (Watcher) MarshalJSON added in v0.3.0 

func (w Watcher) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Watcher.

type WatcherListResult added in v0.3.0 

type WatcherListResult struct {
	// List of network watcher resources.
	Value []*Watcher `json:"value,omitempty"`
}

WatcherListResult - Response for ListNetworkWatchers API service call.

func (WatcherListResult) MarshalJSON added in v0.3.0 

func (w WatcherListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WatcherListResult.

type WatcherPropertiesFormat added in v0.3.0 

type WatcherPropertiesFormat struct {
	// READ-ONLY; The provisioning state of the network watcher resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

WatcherPropertiesFormat - The network watcher properties.

type WatchersClient added in v0.3.0 

type WatchersClient struct {
	// contains filtered or unexported fields
}

WatchersClient contains the methods for the NetworkWatchers group. Don't use this type directly, use NewWatchersClient() instead.

func NewWatchersClient added in v0.3.0 

func NewWatchersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *WatchersClient

NewWatchersClient creates a new instance of WatchersClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*WatchersClient) BeginCheckConnectivity added in v0.3.0 

func (client *WatchersClient) BeginCheckConnectivity(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters ConnectivityParameters, options *WatchersClientBeginCheckConnectivityOptions) (WatchersClientCheckConnectivityPollerResponse, error)

BeginCheckConnectivity - Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the network watcher resource group. networkWatcherName - The name of the network watcher resource. parameters - Parameters that determine how the connectivity check will be performed. options - WatchersClientBeginCheckConnectivityOptions contains the optional parameters for the WatchersClient.BeginCheckConnectivity method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherConnectivityCheck.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCheckConnectivity(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.ConnectivityParameters{
			Destination: &armnetwork.ConnectivityDestination{
				Address: to.StringPtr("<address>"),
				Port:    to.Int32Ptr(3389),
			},
			PreferredIPVersion: armnetwork.IPVersion("IPv4").ToPtr(),
			Source: &armnetwork.ConnectivitySource{
				ResourceID: to.StringPtr("<resource-id>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientCheckConnectivityResult)
}

Output:

func (*WatchersClient) BeginDelete added in v0.3.0 

func (client *WatchersClient) BeginDelete(ctx context.Context, resourceGroupName string, networkWatcherName string, options *WatchersClientBeginDeleteOptions) (WatchersClientDeletePollerResponse, error)

BeginDelete - Deletes the specified network watcher resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. options - WatchersClientBeginDeleteOptions contains the optional parameters for the WatchersClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*WatchersClient) BeginGetAzureReachabilityReport added in v0.3.0 

func (client *WatchersClient) BeginGetAzureReachabilityReport(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters AzureReachabilityReportParameters, options *WatchersClientBeginGetAzureReachabilityReportOptions) (WatchersClientGetAzureReachabilityReportPollerResponse, error)

BeginGetAzureReachabilityReport - NOTE: This feature is currently in preview and still being tested for stability. Gets the relative latency score for internet service providers from a specified location to Azure regions. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the network watcher resource group. networkWatcherName - The name of the network watcher resource. parameters - Parameters that determine Azure reachability report configuration. options - WatchersClientBeginGetAzureReachabilityReportOptions contains the optional parameters for the WatchersClient.BeginGetAzureReachabilityReport method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherAzureReachabilityReportGet.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetAzureReachabilityReport(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.AzureReachabilityReportParameters{
			AzureLocations: []*string{
				to.StringPtr("West US")},
			EndTime: to.TimePtr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-10T00:00:00Z"); return t }()),
			ProviderLocation: &armnetwork.AzureReachabilityReportLocation{
				Country: to.StringPtr("<country>"),
				State:   to.StringPtr("<state>"),
			},
			Providers: []*string{
				to.StringPtr("Frontier Communications of America, Inc. - ASN 5650")},
			StartTime: to.TimePtr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-07T00:00:00Z"); return t }()),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientGetAzureReachabilityReportResult)
}

Output:

func (*WatchersClient) BeginGetFlowLogStatus added in v0.3.0 

func (client *WatchersClient) BeginGetFlowLogStatus(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters FlowLogStatusParameters, options *WatchersClientBeginGetFlowLogStatusOptions) (WatchersClientGetFlowLogStatusPollerResponse, error)

BeginGetFlowLogStatus - Queries status of flow log and traffic analytics (optional) on a specified resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the network watcher resource group. networkWatcherName - The name of the network watcher resource. parameters - Parameters that define a resource to query flow log and traffic analytics (optional) status. options - WatchersClientBeginGetFlowLogStatusOptions contains the optional parameters for the WatchersClient.BeginGetFlowLogStatus method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherFlowLogStatusQuery.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetFlowLogStatus(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.FlowLogStatusParameters{
			TargetResourceID: to.StringPtr("<target-resource-id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientGetFlowLogStatusResult)
}

Output:

func (*WatchersClient) BeginGetNetworkConfigurationDiagnostic added in v0.3.0 

func (client *WatchersClient) BeginGetNetworkConfigurationDiagnostic(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters ConfigurationDiagnosticParameters, options *WatchersClientBeginGetNetworkConfigurationDiagnosticOptions) (WatchersClientGetNetworkConfigurationDiagnosticPollerResponse, error)

BeginGetNetworkConfigurationDiagnostic - Gets Network Configuration Diagnostic data to help customers understand and debug network behavior. It provides detailed information on what security rules were applied to a specified traffic flow and the result of evaluating these rules. Customers must provide details of a flow like source, destination, protocol, etc. The API returns whether traffic was allowed or denied, the rules evaluated for the specified flow and the evaluation results. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. parameters - Parameters to get network configuration diagnostic. options - WatchersClientBeginGetNetworkConfigurationDiagnosticOptions contains the optional parameters for the WatchersClient.BeginGetNetworkConfigurationDiagnostic method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetNetworkConfigurationDiagnostic(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.ConfigurationDiagnosticParameters{
			Profiles: []*armnetwork.ConfigurationDiagnosticProfile{
				{
					Destination:     to.StringPtr("<destination>"),
					DestinationPort: to.StringPtr("<destination-port>"),
					Direction:       armnetwork.Direction("Inbound").ToPtr(),
					Source:          to.StringPtr("<source>"),
					Protocol:        to.StringPtr("<protocol>"),
				}},
			TargetResourceID: to.StringPtr("<target-resource-id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientGetNetworkConfigurationDiagnosticResult)
}

Output:

func (*WatchersClient) BeginGetNextHop added in v0.3.0 

func (client *WatchersClient) BeginGetNextHop(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters NextHopParameters, options *WatchersClientBeginGetNextHopOptions) (WatchersClientGetNextHopPollerResponse, error)

BeginGetNextHop - Gets the next hop from the specified VM. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. parameters - Parameters that define the source and destination endpoint. options - WatchersClientBeginGetNextHopOptions contains the optional parameters for the WatchersClient.BeginGetNextHop method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherNextHopGet.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetNextHop(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.NextHopParameters{
			DestinationIPAddress: to.StringPtr("<destination-ipaddress>"),
			SourceIPAddress:      to.StringPtr("<source-ipaddress>"),
			TargetNicResourceID:  to.StringPtr("<target-nic-resource-id>"),
			TargetResourceID:     to.StringPtr("<target-resource-id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientGetNextHopResult)
}

Output:

func (*WatchersClient) BeginGetTroubleshooting added in v0.3.0 

func (client *WatchersClient) BeginGetTroubleshooting(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters TroubleshootingParameters, options *WatchersClientBeginGetTroubleshootingOptions) (WatchersClientGetTroubleshootingPollerResponse, error)

BeginGetTroubleshooting - Initiate troubleshooting on a specified resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher resource. parameters - Parameters that define the resource to troubleshoot. options - WatchersClientBeginGetTroubleshootingOptions contains the optional parameters for the WatchersClient.BeginGetTroubleshooting method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherTroubleshootGet.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetTroubleshooting(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.TroubleshootingParameters{
			Properties: &armnetwork.TroubleshootingProperties{
				StorageID:   to.StringPtr("<storage-id>"),
				StoragePath: to.StringPtr("<storage-path>"),
			},
			TargetResourceID: to.StringPtr("<target-resource-id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientGetTroubleshootingResult)
}

Output:

func (*WatchersClient) BeginGetTroubleshootingResult added in v0.3.0 

func (client *WatchersClient) BeginGetTroubleshootingResult(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters QueryTroubleshootingParameters, options *WatchersClientBeginGetTroubleshootingResultOptions) (WatchersClientGetTroubleshootingResultPollerResponse, error)

BeginGetTroubleshootingResult - Get the last completed troubleshooting result on a specified resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher resource. parameters - Parameters that define the resource to query the troubleshooting result. options - WatchersClientBeginGetTroubleshootingResultOptions contains the optional parameters for the WatchersClient.BeginGetTroubleshootingResult method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherTroubleshootResultQuery.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetTroubleshootingResult(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.QueryTroubleshootingParameters{
			TargetResourceID: to.StringPtr("<target-resource-id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientGetTroubleshootingResultResult)
}

Output:

func (*WatchersClient) BeginGetVMSecurityRules added in v0.3.0 

func (client *WatchersClient) BeginGetVMSecurityRules(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters SecurityGroupViewParameters, options *WatchersClientBeginGetVMSecurityRulesOptions) (WatchersClientGetVMSecurityRulesPollerResponse, error)

BeginGetVMSecurityRules - Gets the configured and effective security group rules on the specified VM. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. parameters - Parameters that define the VM to check security groups for. options - WatchersClientBeginGetVMSecurityRulesOptions contains the optional parameters for the WatchersClient.BeginGetVMSecurityRules method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherSecurityGroupViewGet.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginGetVMSecurityRules(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.SecurityGroupViewParameters{
			TargetResourceID: to.StringPtr("<target-resource-id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientGetVMSecurityRulesResult)
}

Output:

func (*WatchersClient) BeginListAvailableProviders added in v0.3.0 

func (client *WatchersClient) BeginListAvailableProviders(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters AvailableProvidersListParameters, options *WatchersClientBeginListAvailableProvidersOptions) (WatchersClientListAvailableProvidersPollerResponse, error)

BeginListAvailableProviders - NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the network watcher resource group. networkWatcherName - The name of the network watcher resource. parameters - Parameters that scope the list of available providers. options - WatchersClientBeginListAvailableProvidersOptions contains the optional parameters for the WatchersClient.BeginListAvailableProviders method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherAvailableProvidersListGet.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginListAvailableProviders(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.AvailableProvidersListParameters{
			AzureLocations: []*string{
				to.StringPtr("West US")},
			City:    to.StringPtr("<city>"),
			Country: to.StringPtr("<country>"),
			State:   to.StringPtr("<state>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientListAvailableProvidersResult)
}

Output:

func (*WatchersClient) BeginSetFlowLogConfiguration added in v0.3.0 

func (client *WatchersClient) BeginSetFlowLogConfiguration(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters FlowLogInformation, options *WatchersClientBeginSetFlowLogConfigurationOptions) (WatchersClientSetFlowLogConfigurationPollerResponse, error)

BeginSetFlowLogConfiguration - Configures flow log and traffic analytics (optional) on a specified resource. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the network watcher resource group. networkWatcherName - The name of the network watcher resource. parameters - Parameters that define the configuration of flow log. options - WatchersClientBeginSetFlowLogConfigurationOptions contains the optional parameters for the WatchersClient.BeginSetFlowLogConfiguration method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherFlowLogConfigure.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginSetFlowLogConfiguration(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.FlowLogInformation{
			Properties: &armnetwork.FlowLogProperties{
				Enabled:   to.BoolPtr(true),
				StorageID: to.StringPtr("<storage-id>"),
			},
			TargetResourceID: to.StringPtr("<target-resource-id>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientSetFlowLogConfigurationResult)
}

Output:

func (*WatchersClient) BeginVerifyIPFlow added in v0.3.0 

func (client *WatchersClient) BeginVerifyIPFlow(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters VerificationIPFlowParameters, options *WatchersClientBeginVerifyIPFlowOptions) (WatchersClientVerifyIPFlowPollerResponse, error)

BeginVerifyIPFlow - Verify IP flow from the specified VM to a location given the currently configured NSG rules. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. parameters - Parameters that define the IP flow to be verified. options - WatchersClientBeginVerifyIPFlowOptions contains the optional parameters for the WatchersClient.BeginVerifyIPFlow method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherIpFlowVerify.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginVerifyIPFlow(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.VerificationIPFlowParameters{
			Direction:        armnetwork.Direction("Outbound").ToPtr(),
			LocalIPAddress:   to.StringPtr("<local-ipaddress>"),
			LocalPort:        to.StringPtr("<local-port>"),
			RemoteIPAddress:  to.StringPtr("<remote-ipaddress>"),
			RemotePort:       to.StringPtr("<remote-port>"),
			TargetResourceID: to.StringPtr("<target-resource-id>"),
			Protocol:         armnetwork.IPFlowProtocol("TCP").ToPtr(),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientVerifyIPFlowResult)
}

Output:

func (*WatchersClient) CreateOrUpdate added in v0.3.0 

func (client *WatchersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters Watcher, options *WatchersClientCreateOrUpdateOptions) (WatchersClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a network watcher in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. parameters - Parameters that define the network watcher resource. options - WatchersClientCreateOrUpdateOptions contains the optional parameters for the WatchersClient.CreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherCreate.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.Watcher{
			Location:   to.StringPtr("<location>"),
			Properties: &armnetwork.WatcherPropertiesFormat{},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientCreateOrUpdateResult)
}

Output:

func (*WatchersClient) Get added in v0.3.0 

func (client *WatchersClient) Get(ctx context.Context, resourceGroupName string, networkWatcherName string, options *WatchersClientGetOptions) (WatchersClientGetResponse, error)

Get - Gets the specified network watcher by resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. options - WatchersClientGetOptions contains the optional parameters for the WatchersClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientGetResult)
}

Output:

func (*WatchersClient) GetTopology added in v0.3.0 

func (client *WatchersClient) GetTopology(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters TopologyParameters, options *WatchersClientGetTopologyOptions) (WatchersClientGetTopologyResponse, error)

GetTopology - Gets the current network topology by resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. parameters - Parameters that define the representation of topology. options - WatchersClientGetTopologyOptions contains the optional parameters for the WatchersClient.GetTopology method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherTopologyGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	res, err := client.GetTopology(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.TopologyParameters{
			TargetResourceGroupName: to.StringPtr("<target-resource-group-name>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientGetTopologyResult)
}

Output:

func (*WatchersClient) List added in v0.3.0 

func (client *WatchersClient) List(ctx context.Context, resourceGroupName string, options *WatchersClientListOptions) (WatchersClientListResponse, error)

List - Gets all network watchers by resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - WatchersClientListOptions contains the optional parameters for the WatchersClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherList.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	res, err := client.List(ctx,
		"<resource-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientListResult)
}

Output:

func (*WatchersClient) ListAll added in v0.3.0 

func (client *WatchersClient) ListAll(ctx context.Context, options *WatchersClientListAllOptions) (WatchersClientListAllResponse, error)

ListAll - Gets all network watchers by subscription. If the operation fails it returns an *azcore.ResponseError type. options - WatchersClientListAllOptions contains the optional parameters for the WatchersClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherListAll.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	res, err := client.ListAll(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientListAllResult)
}

Output:

func (*WatchersClient) UpdateTags added in v0.3.0 

func (client *WatchersClient) UpdateTags(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters TagsObject, options *WatchersClientUpdateTagsOptions) (WatchersClientUpdateTagsResponse, error)

UpdateTags - Updates a network watcher tags. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. networkWatcherName - The name of the network watcher. parameters - Parameters supplied to update network watcher tags. options - WatchersClientUpdateTagsOptions contains the optional parameters for the WatchersClient.UpdateTags method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/NetworkWatcherUpdateTags.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWatchersClient("<subscription-id>", cred, nil)
	res, err := client.UpdateTags(ctx,
		"<resource-group-name>",
		"<network-watcher-name>",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.StringPtr("value1"),
				"tag2": to.StringPtr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WatchersClientUpdateTagsResult)
}

Output:

type WatchersClientBeginCheckConnectivityOptions added in v0.3.0 

type WatchersClientBeginCheckConnectivityOptions struct {
}

WatchersClientBeginCheckConnectivityOptions contains the optional parameters for the WatchersClient.BeginCheckConnectivity method.

type WatchersClientBeginDeleteOptions added in v0.3.0 

type WatchersClientBeginDeleteOptions struct {
}

WatchersClientBeginDeleteOptions contains the optional parameters for the WatchersClient.BeginDelete method.

type WatchersClientBeginGetAzureReachabilityReportOptions added in v0.3.0 

type WatchersClientBeginGetAzureReachabilityReportOptions struct {
}

WatchersClientBeginGetAzureReachabilityReportOptions contains the optional parameters for the WatchersClient.BeginGetAzureReachabilityReport method.

type WatchersClientBeginGetFlowLogStatusOptions added in v0.3.0 

type WatchersClientBeginGetFlowLogStatusOptions struct {
}

WatchersClientBeginGetFlowLogStatusOptions contains the optional parameters for the WatchersClient.BeginGetFlowLogStatus method.

type WatchersClientBeginGetNetworkConfigurationDiagnosticOptions added in v0.3.0 

type WatchersClientBeginGetNetworkConfigurationDiagnosticOptions struct {
}

WatchersClientBeginGetNetworkConfigurationDiagnosticOptions contains the optional parameters for the WatchersClient.BeginGetNetworkConfigurationDiagnostic method.

type WatchersClientBeginGetNextHopOptions added in v0.3.0 

type WatchersClientBeginGetNextHopOptions struct {
}

WatchersClientBeginGetNextHopOptions contains the optional parameters for the WatchersClient.BeginGetNextHop method.

type WatchersClientBeginGetTroubleshootingOptions added in v0.3.0 

type WatchersClientBeginGetTroubleshootingOptions struct {
}

WatchersClientBeginGetTroubleshootingOptions contains the optional parameters for the WatchersClient.BeginGetTroubleshooting method.

type WatchersClientBeginGetTroubleshootingResultOptions added in v0.3.0 

type WatchersClientBeginGetTroubleshootingResultOptions struct {
}

WatchersClientBeginGetTroubleshootingResultOptions contains the optional parameters for the WatchersClient.BeginGetTroubleshootingResult method.

type WatchersClientBeginGetVMSecurityRulesOptions added in v0.3.0 

type WatchersClientBeginGetVMSecurityRulesOptions struct {
}

WatchersClientBeginGetVMSecurityRulesOptions contains the optional parameters for the WatchersClient.BeginGetVMSecurityRules method.

type WatchersClientBeginListAvailableProvidersOptions added in v0.3.0 

type WatchersClientBeginListAvailableProvidersOptions struct {
}

WatchersClientBeginListAvailableProvidersOptions contains the optional parameters for the WatchersClient.BeginListAvailableProviders method.

type WatchersClientBeginSetFlowLogConfigurationOptions added in v0.3.0 

type WatchersClientBeginSetFlowLogConfigurationOptions struct {
}

WatchersClientBeginSetFlowLogConfigurationOptions contains the optional parameters for the WatchersClient.BeginSetFlowLogConfiguration method.

type WatchersClientBeginVerifyIPFlowOptions added in v0.3.0 

type WatchersClientBeginVerifyIPFlowOptions struct {
}

WatchersClientBeginVerifyIPFlowOptions contains the optional parameters for the WatchersClient.BeginVerifyIPFlow method.

type WatchersClientCheckConnectivityPoller added in v0.3.0 

type WatchersClientCheckConnectivityPoller struct {
	// contains filtered or unexported fields
}

WatchersClientCheckConnectivityPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientCheckConnectivityPoller) Done added in v0.3.0 

func (p *WatchersClientCheckConnectivityPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientCheckConnectivityPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientCheckConnectivityPoller) FinalResponse(ctx context.Context) (WatchersClientCheckConnectivityResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientCheckConnectivityResponse will be returned.

func (*WatchersClientCheckConnectivityPoller) Poll added in v0.3.0 

func (p *WatchersClientCheckConnectivityPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientCheckConnectivityPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientCheckConnectivityPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientCheckConnectivityPollerResponse added in v0.3.0 

type WatchersClientCheckConnectivityPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientCheckConnectivityPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientCheckConnectivityPollerResponse contains the response from method WatchersClient.CheckConnectivity.

func (WatchersClientCheckConnectivityPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientCheckConnectivityPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientCheckConnectivityResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientCheckConnectivityPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientCheckConnectivityPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientCheckConnectivityPollerResponse from the provided client and resume token.

type WatchersClientCheckConnectivityResponse added in v0.3.0 

type WatchersClientCheckConnectivityResponse struct {
	WatchersClientCheckConnectivityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientCheckConnectivityResponse contains the response from method WatchersClient.CheckConnectivity.

type WatchersClientCheckConnectivityResult added in v0.3.0 

type WatchersClientCheckConnectivityResult struct {
	ConnectivityInformation
}

WatchersClientCheckConnectivityResult contains the result from method WatchersClient.CheckConnectivity.

type WatchersClientCreateOrUpdateOptions added in v0.3.0 

type WatchersClientCreateOrUpdateOptions struct {
}

WatchersClientCreateOrUpdateOptions contains the optional parameters for the WatchersClient.CreateOrUpdate method.

type WatchersClientCreateOrUpdateResponse added in v0.3.0 

type WatchersClientCreateOrUpdateResponse struct {
	WatchersClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientCreateOrUpdateResponse contains the response from method WatchersClient.CreateOrUpdate.

type WatchersClientCreateOrUpdateResult added in v0.3.0 

type WatchersClientCreateOrUpdateResult struct {
	Watcher
}

WatchersClientCreateOrUpdateResult contains the result from method WatchersClient.CreateOrUpdate.

type WatchersClientDeletePoller added in v0.3.0 

type WatchersClientDeletePoller struct {
	// contains filtered or unexported fields
}

WatchersClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientDeletePoller) Done added in v0.3.0 

func (p *WatchersClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientDeletePoller) FinalResponse added in v0.3.0 

func (p *WatchersClientDeletePoller) FinalResponse(ctx context.Context) (WatchersClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientDeleteResponse will be returned.

func (*WatchersClientDeletePoller) Poll added in v0.3.0 

func (p *WatchersClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientDeletePoller) ResumeToken added in v0.3.0 

func (p *WatchersClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientDeletePollerResponse added in v0.3.0 

type WatchersClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientDeletePollerResponse contains the response from method WatchersClient.Delete.

func (WatchersClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientDeletePollerResponse) Resume added in v0.3.0 

func (l *WatchersClientDeletePollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientDeletePollerResponse from the provided client and resume token.

type WatchersClientDeleteResponse added in v0.3.0 

type WatchersClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientDeleteResponse contains the response from method WatchersClient.Delete.

type WatchersClientGetAzureReachabilityReportPoller added in v0.3.0 

type WatchersClientGetAzureReachabilityReportPoller struct {
	// contains filtered or unexported fields
}

WatchersClientGetAzureReachabilityReportPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientGetAzureReachabilityReportPoller) Done added in v0.3.0 

func (p *WatchersClientGetAzureReachabilityReportPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientGetAzureReachabilityReportPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientGetAzureReachabilityReportPoller) FinalResponse(ctx context.Context) (WatchersClientGetAzureReachabilityReportResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientGetAzureReachabilityReportResponse will be returned.

func (*WatchersClientGetAzureReachabilityReportPoller) Poll added in v0.3.0 

func (p *WatchersClientGetAzureReachabilityReportPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientGetAzureReachabilityReportPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientGetAzureReachabilityReportPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientGetAzureReachabilityReportPollerResponse added in v0.3.0 

type WatchersClientGetAzureReachabilityReportPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientGetAzureReachabilityReportPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetAzureReachabilityReportPollerResponse contains the response from method WatchersClient.GetAzureReachabilityReport.

func (WatchersClientGetAzureReachabilityReportPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientGetAzureReachabilityReportPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientGetAzureReachabilityReportResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientGetAzureReachabilityReportPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientGetAzureReachabilityReportPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientGetAzureReachabilityReportPollerResponse from the provided client and resume token.

type WatchersClientGetAzureReachabilityReportResponse added in v0.3.0 

type WatchersClientGetAzureReachabilityReportResponse struct {
	WatchersClientGetAzureReachabilityReportResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetAzureReachabilityReportResponse contains the response from method WatchersClient.GetAzureReachabilityReport.

type WatchersClientGetAzureReachabilityReportResult added in v0.3.0 

type WatchersClientGetAzureReachabilityReportResult struct {
	AzureReachabilityReport
}

WatchersClientGetAzureReachabilityReportResult contains the result from method WatchersClient.GetAzureReachabilityReport.

type WatchersClientGetFlowLogStatusPoller added in v0.3.0 

type WatchersClientGetFlowLogStatusPoller struct {
	// contains filtered or unexported fields
}

WatchersClientGetFlowLogStatusPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientGetFlowLogStatusPoller) Done added in v0.3.0 

func (p *WatchersClientGetFlowLogStatusPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientGetFlowLogStatusPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientGetFlowLogStatusPoller) FinalResponse(ctx context.Context) (WatchersClientGetFlowLogStatusResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientGetFlowLogStatusResponse will be returned.

func (*WatchersClientGetFlowLogStatusPoller) Poll added in v0.3.0 

func (p *WatchersClientGetFlowLogStatusPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientGetFlowLogStatusPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientGetFlowLogStatusPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientGetFlowLogStatusPollerResponse added in v0.3.0 

type WatchersClientGetFlowLogStatusPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientGetFlowLogStatusPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetFlowLogStatusPollerResponse contains the response from method WatchersClient.GetFlowLogStatus.

func (WatchersClientGetFlowLogStatusPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientGetFlowLogStatusPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientGetFlowLogStatusResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientGetFlowLogStatusPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientGetFlowLogStatusPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientGetFlowLogStatusPollerResponse from the provided client and resume token.

type WatchersClientGetFlowLogStatusResponse added in v0.3.0 

type WatchersClientGetFlowLogStatusResponse struct {
	WatchersClientGetFlowLogStatusResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetFlowLogStatusResponse contains the response from method WatchersClient.GetFlowLogStatus.

type WatchersClientGetFlowLogStatusResult added in v0.3.0 

type WatchersClientGetFlowLogStatusResult struct {
	FlowLogInformation
}

WatchersClientGetFlowLogStatusResult contains the result from method WatchersClient.GetFlowLogStatus.

type WatchersClientGetNetworkConfigurationDiagnosticPoller added in v0.3.0 

type WatchersClientGetNetworkConfigurationDiagnosticPoller struct {
	// contains filtered or unexported fields
}

WatchersClientGetNetworkConfigurationDiagnosticPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientGetNetworkConfigurationDiagnosticPoller) Done added in v0.3.0 

func (p *WatchersClientGetNetworkConfigurationDiagnosticPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientGetNetworkConfigurationDiagnosticPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientGetNetworkConfigurationDiagnosticPoller) FinalResponse(ctx context.Context) (WatchersClientGetNetworkConfigurationDiagnosticResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientGetNetworkConfigurationDiagnosticResponse will be returned.

func (*WatchersClientGetNetworkConfigurationDiagnosticPoller) Poll added in v0.3.0 

func (p *WatchersClientGetNetworkConfigurationDiagnosticPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientGetNetworkConfigurationDiagnosticPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientGetNetworkConfigurationDiagnosticPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientGetNetworkConfigurationDiagnosticPollerResponse added in v0.3.0 

type WatchersClientGetNetworkConfigurationDiagnosticPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientGetNetworkConfigurationDiagnosticPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetNetworkConfigurationDiagnosticPollerResponse contains the response from method WatchersClient.GetNetworkConfigurationDiagnostic.

func (WatchersClientGetNetworkConfigurationDiagnosticPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientGetNetworkConfigurationDiagnosticPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientGetNetworkConfigurationDiagnosticResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientGetNetworkConfigurationDiagnosticPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientGetNetworkConfigurationDiagnosticPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientGetNetworkConfigurationDiagnosticPollerResponse from the provided client and resume token.

type WatchersClientGetNetworkConfigurationDiagnosticResponse added in v0.3.0 

type WatchersClientGetNetworkConfigurationDiagnosticResponse struct {
	WatchersClientGetNetworkConfigurationDiagnosticResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetNetworkConfigurationDiagnosticResponse contains the response from method WatchersClient.GetNetworkConfigurationDiagnostic.

type WatchersClientGetNetworkConfigurationDiagnosticResult added in v0.3.0 

type WatchersClientGetNetworkConfigurationDiagnosticResult struct {
	ConfigurationDiagnosticResponse
}

WatchersClientGetNetworkConfigurationDiagnosticResult contains the result from method WatchersClient.GetNetworkConfigurationDiagnostic.

type WatchersClientGetNextHopPoller added in v0.3.0 

type WatchersClientGetNextHopPoller struct {
	// contains filtered or unexported fields
}

WatchersClientGetNextHopPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientGetNextHopPoller) Done added in v0.3.0 

func (p *WatchersClientGetNextHopPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientGetNextHopPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientGetNextHopPoller) FinalResponse(ctx context.Context) (WatchersClientGetNextHopResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientGetNextHopResponse will be returned.

func (*WatchersClientGetNextHopPoller) Poll added in v0.3.0 

func (p *WatchersClientGetNextHopPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientGetNextHopPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientGetNextHopPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientGetNextHopPollerResponse added in v0.3.0 

type WatchersClientGetNextHopPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientGetNextHopPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetNextHopPollerResponse contains the response from method WatchersClient.GetNextHop.

func (WatchersClientGetNextHopPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientGetNextHopPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientGetNextHopResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientGetNextHopPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientGetNextHopPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientGetNextHopPollerResponse from the provided client and resume token.

type WatchersClientGetNextHopResponse added in v0.3.0 

type WatchersClientGetNextHopResponse struct {
	WatchersClientGetNextHopResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetNextHopResponse contains the response from method WatchersClient.GetNextHop.

type WatchersClientGetNextHopResult added in v0.3.0 

type WatchersClientGetNextHopResult struct {
	NextHopResult
}

WatchersClientGetNextHopResult contains the result from method WatchersClient.GetNextHop.

type WatchersClientGetOptions added in v0.3.0 

type WatchersClientGetOptions struct {
}

WatchersClientGetOptions contains the optional parameters for the WatchersClient.Get method.

type WatchersClientGetResponse added in v0.3.0 

type WatchersClientGetResponse struct {
	WatchersClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetResponse contains the response from method WatchersClient.Get.

type WatchersClientGetResult added in v0.3.0 

type WatchersClientGetResult struct {
	Watcher
}

WatchersClientGetResult contains the result from method WatchersClient.Get.

type WatchersClientGetTopologyOptions added in v0.3.0 

type WatchersClientGetTopologyOptions struct {
}

WatchersClientGetTopologyOptions contains the optional parameters for the WatchersClient.GetTopology method.

type WatchersClientGetTopologyResponse added in v0.3.0 

type WatchersClientGetTopologyResponse struct {
	WatchersClientGetTopologyResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetTopologyResponse contains the response from method WatchersClient.GetTopology.

type WatchersClientGetTopologyResult added in v0.3.0 

type WatchersClientGetTopologyResult struct {
	Topology
}

WatchersClientGetTopologyResult contains the result from method WatchersClient.GetTopology.

type WatchersClientGetTroubleshootingPoller added in v0.3.0 

type WatchersClientGetTroubleshootingPoller struct {
	// contains filtered or unexported fields
}

WatchersClientGetTroubleshootingPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientGetTroubleshootingPoller) Done added in v0.3.0 

func (p *WatchersClientGetTroubleshootingPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientGetTroubleshootingPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientGetTroubleshootingPoller) FinalResponse(ctx context.Context) (WatchersClientGetTroubleshootingResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientGetTroubleshootingResponse will be returned.

func (*WatchersClientGetTroubleshootingPoller) Poll added in v0.3.0 

func (p *WatchersClientGetTroubleshootingPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientGetTroubleshootingPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientGetTroubleshootingPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientGetTroubleshootingPollerResponse added in v0.3.0 

type WatchersClientGetTroubleshootingPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientGetTroubleshootingPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetTroubleshootingPollerResponse contains the response from method WatchersClient.GetTroubleshooting.

func (WatchersClientGetTroubleshootingPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientGetTroubleshootingPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientGetTroubleshootingResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientGetTroubleshootingPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientGetTroubleshootingPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientGetTroubleshootingPollerResponse from the provided client and resume token.

type WatchersClientGetTroubleshootingResponse added in v0.3.0 

type WatchersClientGetTroubleshootingResponse struct {
	WatchersClientGetTroubleshootingResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetTroubleshootingResponse contains the response from method WatchersClient.GetTroubleshooting.

type WatchersClientGetTroubleshootingResult added in v0.3.0 

type WatchersClientGetTroubleshootingResult struct {
	TroubleshootingResult
}

WatchersClientGetTroubleshootingResult contains the result from method WatchersClient.GetTroubleshooting.

type WatchersClientGetTroubleshootingResultPoller added in v0.3.0 

type WatchersClientGetTroubleshootingResultPoller struct {
	// contains filtered or unexported fields
}

WatchersClientGetTroubleshootingResultPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientGetTroubleshootingResultPoller) Done added in v0.3.0 

func (p *WatchersClientGetTroubleshootingResultPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientGetTroubleshootingResultPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientGetTroubleshootingResultPoller) FinalResponse(ctx context.Context) (WatchersClientGetTroubleshootingResultResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientGetTroubleshootingResultResponse will be returned.

func (*WatchersClientGetTroubleshootingResultPoller) Poll added in v0.3.0 

func (p *WatchersClientGetTroubleshootingResultPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientGetTroubleshootingResultPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientGetTroubleshootingResultPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientGetTroubleshootingResultPollerResponse added in v0.3.0 

type WatchersClientGetTroubleshootingResultPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientGetTroubleshootingResultPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetTroubleshootingResultPollerResponse contains the response from method WatchersClient.GetTroubleshootingResult.

func (WatchersClientGetTroubleshootingResultPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientGetTroubleshootingResultPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientGetTroubleshootingResultResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientGetTroubleshootingResultPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientGetTroubleshootingResultPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientGetTroubleshootingResultPollerResponse from the provided client and resume token.

type WatchersClientGetTroubleshootingResultResponse added in v0.3.0 

type WatchersClientGetTroubleshootingResultResponse struct {
	WatchersClientGetTroubleshootingResultResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetTroubleshootingResultResponse contains the response from method WatchersClient.GetTroubleshootingResult.

type WatchersClientGetTroubleshootingResultResult added in v0.3.0 

type WatchersClientGetTroubleshootingResultResult struct {
	TroubleshootingResult
}

WatchersClientGetTroubleshootingResultResult contains the result from method WatchersClient.GetTroubleshootingResult.

type WatchersClientGetVMSecurityRulesPoller added in v0.3.0 

type WatchersClientGetVMSecurityRulesPoller struct {
	// contains filtered or unexported fields
}

WatchersClientGetVMSecurityRulesPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientGetVMSecurityRulesPoller) Done added in v0.3.0 

func (p *WatchersClientGetVMSecurityRulesPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientGetVMSecurityRulesPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientGetVMSecurityRulesPoller) FinalResponse(ctx context.Context) (WatchersClientGetVMSecurityRulesResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientGetVMSecurityRulesResponse will be returned.

func (*WatchersClientGetVMSecurityRulesPoller) Poll added in v0.3.0 

func (p *WatchersClientGetVMSecurityRulesPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientGetVMSecurityRulesPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientGetVMSecurityRulesPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientGetVMSecurityRulesPollerResponse added in v0.3.0 

type WatchersClientGetVMSecurityRulesPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientGetVMSecurityRulesPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetVMSecurityRulesPollerResponse contains the response from method WatchersClient.GetVMSecurityRules.

func (WatchersClientGetVMSecurityRulesPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientGetVMSecurityRulesPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientGetVMSecurityRulesResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientGetVMSecurityRulesPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientGetVMSecurityRulesPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientGetVMSecurityRulesPollerResponse from the provided client and resume token.

type WatchersClientGetVMSecurityRulesResponse added in v0.3.0 

type WatchersClientGetVMSecurityRulesResponse struct {
	WatchersClientGetVMSecurityRulesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientGetVMSecurityRulesResponse contains the response from method WatchersClient.GetVMSecurityRules.

type WatchersClientGetVMSecurityRulesResult added in v0.3.0 

type WatchersClientGetVMSecurityRulesResult struct {
	SecurityGroupViewResult
}

WatchersClientGetVMSecurityRulesResult contains the result from method WatchersClient.GetVMSecurityRules.

type WatchersClientListAllOptions added in v0.3.0 

type WatchersClientListAllOptions struct {
}

WatchersClientListAllOptions contains the optional parameters for the WatchersClient.ListAll method.

type WatchersClientListAllResponse added in v0.3.0 

type WatchersClientListAllResponse struct {
	WatchersClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientListAllResponse contains the response from method WatchersClient.ListAll.

type WatchersClientListAllResult added in v0.3.0 

type WatchersClientListAllResult struct {
	WatcherListResult
}

WatchersClientListAllResult contains the result from method WatchersClient.ListAll.

type WatchersClientListAvailableProvidersPoller added in v0.3.0 

type WatchersClientListAvailableProvidersPoller struct {
	// contains filtered or unexported fields
}

WatchersClientListAvailableProvidersPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientListAvailableProvidersPoller) Done added in v0.3.0 

func (p *WatchersClientListAvailableProvidersPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientListAvailableProvidersPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientListAvailableProvidersPoller) FinalResponse(ctx context.Context) (WatchersClientListAvailableProvidersResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientListAvailableProvidersResponse will be returned.

func (*WatchersClientListAvailableProvidersPoller) Poll added in v0.3.0 

func (p *WatchersClientListAvailableProvidersPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientListAvailableProvidersPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientListAvailableProvidersPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientListAvailableProvidersPollerResponse added in v0.3.0 

type WatchersClientListAvailableProvidersPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientListAvailableProvidersPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientListAvailableProvidersPollerResponse contains the response from method WatchersClient.ListAvailableProviders.

func (WatchersClientListAvailableProvidersPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientListAvailableProvidersPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientListAvailableProvidersResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientListAvailableProvidersPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientListAvailableProvidersPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientListAvailableProvidersPollerResponse from the provided client and resume token.

type WatchersClientListAvailableProvidersResponse added in v0.3.0 

type WatchersClientListAvailableProvidersResponse struct {
	WatchersClientListAvailableProvidersResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientListAvailableProvidersResponse contains the response from method WatchersClient.ListAvailableProviders.

type WatchersClientListAvailableProvidersResult added in v0.3.0 

type WatchersClientListAvailableProvidersResult struct {
	AvailableProvidersList
}

WatchersClientListAvailableProvidersResult contains the result from method WatchersClient.ListAvailableProviders.

type WatchersClientListOptions added in v0.3.0 

type WatchersClientListOptions struct {
}

WatchersClientListOptions contains the optional parameters for the WatchersClient.List method.

type WatchersClientListResponse added in v0.3.0 

type WatchersClientListResponse struct {
	WatchersClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientListResponse contains the response from method WatchersClient.List.

type WatchersClientListResult added in v0.3.0 

type WatchersClientListResult struct {
	WatcherListResult
}

WatchersClientListResult contains the result from method WatchersClient.List.

type WatchersClientSetFlowLogConfigurationPoller added in v0.3.0 

type WatchersClientSetFlowLogConfigurationPoller struct {
	// contains filtered or unexported fields
}

WatchersClientSetFlowLogConfigurationPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientSetFlowLogConfigurationPoller) Done added in v0.3.0 

func (p *WatchersClientSetFlowLogConfigurationPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientSetFlowLogConfigurationPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientSetFlowLogConfigurationPoller) FinalResponse(ctx context.Context) (WatchersClientSetFlowLogConfigurationResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientSetFlowLogConfigurationResponse will be returned.

func (*WatchersClientSetFlowLogConfigurationPoller) Poll added in v0.3.0 

func (p *WatchersClientSetFlowLogConfigurationPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientSetFlowLogConfigurationPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientSetFlowLogConfigurationPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientSetFlowLogConfigurationPollerResponse added in v0.3.0 

type WatchersClientSetFlowLogConfigurationPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientSetFlowLogConfigurationPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientSetFlowLogConfigurationPollerResponse contains the response from method WatchersClient.SetFlowLogConfiguration.

func (WatchersClientSetFlowLogConfigurationPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientSetFlowLogConfigurationPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientSetFlowLogConfigurationResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientSetFlowLogConfigurationPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientSetFlowLogConfigurationPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientSetFlowLogConfigurationPollerResponse from the provided client and resume token.

type WatchersClientSetFlowLogConfigurationResponse added in v0.3.0 

type WatchersClientSetFlowLogConfigurationResponse struct {
	WatchersClientSetFlowLogConfigurationResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientSetFlowLogConfigurationResponse contains the response from method WatchersClient.SetFlowLogConfiguration.

type WatchersClientSetFlowLogConfigurationResult added in v0.3.0 

type WatchersClientSetFlowLogConfigurationResult struct {
	FlowLogInformation
}

WatchersClientSetFlowLogConfigurationResult contains the result from method WatchersClient.SetFlowLogConfiguration.

type WatchersClientUpdateTagsOptions added in v0.3.0 

type WatchersClientUpdateTagsOptions struct {
}

WatchersClientUpdateTagsOptions contains the optional parameters for the WatchersClient.UpdateTags method.

type WatchersClientUpdateTagsResponse added in v0.3.0 

type WatchersClientUpdateTagsResponse struct {
	WatchersClientUpdateTagsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientUpdateTagsResponse contains the response from method WatchersClient.UpdateTags.

type WatchersClientUpdateTagsResult added in v0.3.0 

type WatchersClientUpdateTagsResult struct {
	Watcher
}

WatchersClientUpdateTagsResult contains the result from method WatchersClient.UpdateTags.

type WatchersClientVerifyIPFlowPoller added in v0.3.0 

type WatchersClientVerifyIPFlowPoller struct {
	// contains filtered or unexported fields
}

WatchersClientVerifyIPFlowPoller provides polling facilities until the operation reaches a terminal state.

func (*WatchersClientVerifyIPFlowPoller) Done added in v0.3.0 

func (p *WatchersClientVerifyIPFlowPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WatchersClientVerifyIPFlowPoller) FinalResponse added in v0.3.0 

func (p *WatchersClientVerifyIPFlowPoller) FinalResponse(ctx context.Context) (WatchersClientVerifyIPFlowResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WatchersClientVerifyIPFlowResponse will be returned.

func (*WatchersClientVerifyIPFlowPoller) Poll added in v0.3.0 

func (p *WatchersClientVerifyIPFlowPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WatchersClientVerifyIPFlowPoller) ResumeToken added in v0.3.0 

func (p *WatchersClientVerifyIPFlowPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WatchersClientVerifyIPFlowPollerResponse added in v0.3.0 

type WatchersClientVerifyIPFlowPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WatchersClientVerifyIPFlowPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientVerifyIPFlowPollerResponse contains the response from method WatchersClient.VerifyIPFlow.

func (WatchersClientVerifyIPFlowPollerResponse) PollUntilDone added in v0.3.0 

func (l WatchersClientVerifyIPFlowPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WatchersClientVerifyIPFlowResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WatchersClientVerifyIPFlowPollerResponse) Resume added in v0.3.0 

func (l *WatchersClientVerifyIPFlowPollerResponse) Resume(ctx context.Context, client *WatchersClient, token string) error

Resume rehydrates a WatchersClientVerifyIPFlowPollerResponse from the provided client and resume token.

type WatchersClientVerifyIPFlowResponse added in v0.3.0 

type WatchersClientVerifyIPFlowResponse struct {
	WatchersClientVerifyIPFlowResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WatchersClientVerifyIPFlowResponse contains the response from method WatchersClient.VerifyIPFlow.

type WatchersClientVerifyIPFlowResult added in v0.3.0 

type WatchersClientVerifyIPFlowResult struct {
	VerificationIPFlowResult
}

WatchersClientVerifyIPFlowResult contains the result from method WatchersClient.VerifyIPFlow.

type WebApplicationFirewallAction 

type WebApplicationFirewallAction string

WebApplicationFirewallAction - Type of Actions. 

const (
	WebApplicationFirewallActionAllow WebApplicationFirewallAction = "Allow"
	WebApplicationFirewallActionBlock WebApplicationFirewallAction = "Block"
	WebApplicationFirewallActionLog   WebApplicationFirewallAction = "Log"
)

func PossibleWebApplicationFirewallActionValues 

func PossibleWebApplicationFirewallActionValues() []WebApplicationFirewallAction

PossibleWebApplicationFirewallActionValues returns the possible values for the WebApplicationFirewallAction const type.

func (WebApplicationFirewallAction) ToPtr 

func (c WebApplicationFirewallAction) ToPtr() *WebApplicationFirewallAction

ToPtr returns a *WebApplicationFirewallAction pointing to the current value.

type WebApplicationFirewallCustomRule 

type WebApplicationFirewallCustomRule struct {
	// REQUIRED; Type of Actions.
	Action *WebApplicationFirewallAction `json:"action,omitempty"`

	// REQUIRED; List of match conditions.
	MatchConditions []*MatchCondition `json:"matchConditions,omitempty"`

	// REQUIRED; Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.
	Priority *int32 `json:"priority,omitempty"`

	// REQUIRED; The rule type.
	RuleType *WebApplicationFirewallRuleType `json:"ruleType,omitempty"`

	// The name of the resource that is unique within a policy. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

WebApplicationFirewallCustomRule - Defines contents of a web application rule.

func (WebApplicationFirewallCustomRule) MarshalJSON 

func (w WebApplicationFirewallCustomRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebApplicationFirewallCustomRule.

type WebApplicationFirewallEnabledState 

type WebApplicationFirewallEnabledState string

WebApplicationFirewallEnabledState - The state of the policy. 

const (
	WebApplicationFirewallEnabledStateDisabled WebApplicationFirewallEnabledState = "Disabled"
	WebApplicationFirewallEnabledStateEnabled  WebApplicationFirewallEnabledState = "Enabled"
)

func PossibleWebApplicationFirewallEnabledStateValues 

func PossibleWebApplicationFirewallEnabledStateValues() []WebApplicationFirewallEnabledState

PossibleWebApplicationFirewallEnabledStateValues returns the possible values for the WebApplicationFirewallEnabledState const type.

func (WebApplicationFirewallEnabledState) ToPtr 

func (c WebApplicationFirewallEnabledState) ToPtr() *WebApplicationFirewallEnabledState

ToPtr returns a *WebApplicationFirewallEnabledState pointing to the current value.

type WebApplicationFirewallMatchVariable 

type WebApplicationFirewallMatchVariable string

WebApplicationFirewallMatchVariable - Match Variable. 

const (
	WebApplicationFirewallMatchVariablePostArgs       WebApplicationFirewallMatchVariable = "PostArgs"
	WebApplicationFirewallMatchVariableQueryString    WebApplicationFirewallMatchVariable = "QueryString"
	WebApplicationFirewallMatchVariableRemoteAddr     WebApplicationFirewallMatchVariable = "RemoteAddr"
	WebApplicationFirewallMatchVariableRequestBody    WebApplicationFirewallMatchVariable = "RequestBody"
	WebApplicationFirewallMatchVariableRequestCookies WebApplicationFirewallMatchVariable = "RequestCookies"
	WebApplicationFirewallMatchVariableRequestHeaders WebApplicationFirewallMatchVariable = "RequestHeaders"
	WebApplicationFirewallMatchVariableRequestMethod  WebApplicationFirewallMatchVariable = "RequestMethod"
	WebApplicationFirewallMatchVariableRequestURI     WebApplicationFirewallMatchVariable = "RequestUri"
)

func PossibleWebApplicationFirewallMatchVariableValues 

func PossibleWebApplicationFirewallMatchVariableValues() []WebApplicationFirewallMatchVariable

PossibleWebApplicationFirewallMatchVariableValues returns the possible values for the WebApplicationFirewallMatchVariable const type.

func (WebApplicationFirewallMatchVariable) ToPtr 

func (c WebApplicationFirewallMatchVariable) ToPtr() *WebApplicationFirewallMatchVariable

ToPtr returns a *WebApplicationFirewallMatchVariable pointing to the current value.

type WebApplicationFirewallMode 

type WebApplicationFirewallMode string

WebApplicationFirewallMode - The mode of the policy. 

const (
	WebApplicationFirewallModeDetection  WebApplicationFirewallMode = "Detection"
	WebApplicationFirewallModePrevention WebApplicationFirewallMode = "Prevention"
)

func PossibleWebApplicationFirewallModeValues 

func PossibleWebApplicationFirewallModeValues() []WebApplicationFirewallMode

PossibleWebApplicationFirewallModeValues returns the possible values for the WebApplicationFirewallMode const type.

func (WebApplicationFirewallMode) ToPtr 

func (c WebApplicationFirewallMode) ToPtr() *WebApplicationFirewallMode

ToPtr returns a *WebApplicationFirewallMode pointing to the current value.

type WebApplicationFirewallOperator 

type WebApplicationFirewallOperator string

WebApplicationFirewallOperator - The operator to be matched. 

const (
	WebApplicationFirewallOperatorBeginsWith         WebApplicationFirewallOperator = "BeginsWith"
	WebApplicationFirewallOperatorContains           WebApplicationFirewallOperator = "Contains"
	WebApplicationFirewallOperatorEndsWith           WebApplicationFirewallOperator = "EndsWith"
	WebApplicationFirewallOperatorEqual              WebApplicationFirewallOperator = "Equal"
	WebApplicationFirewallOperatorGeoMatch           WebApplicationFirewallOperator = "GeoMatch"
	WebApplicationFirewallOperatorGreaterThan        WebApplicationFirewallOperator = "GreaterThan"
	WebApplicationFirewallOperatorGreaterThanOrEqual WebApplicationFirewallOperator = "GreaterThanOrEqual"
	WebApplicationFirewallOperatorIPMatch            WebApplicationFirewallOperator = "IPMatch"
	WebApplicationFirewallOperatorLessThan           WebApplicationFirewallOperator = "LessThan"
	WebApplicationFirewallOperatorLessThanOrEqual    WebApplicationFirewallOperator = "LessThanOrEqual"
	WebApplicationFirewallOperatorRegex              WebApplicationFirewallOperator = "Regex"
)

func PossibleWebApplicationFirewallOperatorValues 

func PossibleWebApplicationFirewallOperatorValues() []WebApplicationFirewallOperator

PossibleWebApplicationFirewallOperatorValues returns the possible values for the WebApplicationFirewallOperator const type.

func (WebApplicationFirewallOperator) ToPtr 

func (c WebApplicationFirewallOperator) ToPtr() *WebApplicationFirewallOperator

ToPtr returns a *WebApplicationFirewallOperator pointing to the current value.

type WebApplicationFirewallPoliciesClient 

type WebApplicationFirewallPoliciesClient struct {
	// contains filtered or unexported fields
}

WebApplicationFirewallPoliciesClient contains the methods for the WebApplicationFirewallPolicies group. Don't use this type directly, use NewWebApplicationFirewallPoliciesClient() instead.

func NewWebApplicationFirewallPoliciesClient 

func NewWebApplicationFirewallPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *WebApplicationFirewallPoliciesClient

NewWebApplicationFirewallPoliciesClient creates a new instance of WebApplicationFirewallPoliciesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*WebApplicationFirewallPoliciesClient) BeginDelete 

func (client *WebApplicationFirewallPoliciesClient) BeginDelete(ctx context.Context, resourceGroupName string, policyName string, options *WebApplicationFirewallPoliciesClientBeginDeleteOptions) (WebApplicationFirewallPoliciesClientDeletePollerResponse, error)

BeginDelete - Deletes Policy. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. policyName - The name of the policy. options - WebApplicationFirewallPoliciesClientBeginDeleteOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.BeginDelete method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/WafPolicyDelete.json 

package main

import (
	"context"
	"log"

	"time"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWebApplicationFirewallPoliciesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<policy-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*WebApplicationFirewallPoliciesClient) CreateOrUpdate 

func (client *WebApplicationFirewallPoliciesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, policyName string, parameters WebApplicationFirewallPolicy, options *WebApplicationFirewallPoliciesClientCreateOrUpdateOptions) (WebApplicationFirewallPoliciesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or update policy with specified rule set name within a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. policyName - The name of the policy. parameters - Policy to be created. options - WebApplicationFirewallPoliciesClientCreateOrUpdateOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.CreateOrUpdate method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/WafPolicyCreateOrUpdate.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWebApplicationFirewallPoliciesClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<policy-name>",
		armnetwork.WebApplicationFirewallPolicy{
			Location: to.StringPtr("<location>"),
			Properties: &armnetwork.WebApplicationFirewallPolicyPropertiesFormat{
				CustomRules: []*armnetwork.WebApplicationFirewallCustomRule{
					{
						Name:   to.StringPtr("<name>"),
						Action: armnetwork.WebApplicationFirewallAction("Block").ToPtr(),
						MatchConditions: []*armnetwork.MatchCondition{
							{
								MatchValues: []*string{
									to.StringPtr("192.168.1.0/24"),
									to.StringPtr("10.0.0.0/24")},
								MatchVariables: []*armnetwork.MatchVariable{
									{
										VariableName: armnetwork.WebApplicationFirewallMatchVariable("RemoteAddr").ToPtr(),
									}},
								Operator: armnetwork.WebApplicationFirewallOperator("IPMatch").ToPtr(),
							}},
						Priority: to.Int32Ptr(1),
						RuleType: armnetwork.WebApplicationFirewallRuleType("MatchRule").ToPtr(),
					},
					{
						Name:   to.StringPtr("<name>"),
						Action: armnetwork.WebApplicationFirewallAction("Block").ToPtr(),
						MatchConditions: []*armnetwork.MatchCondition{
							{
								MatchValues: []*string{
									to.StringPtr("192.168.1.0/24")},
								MatchVariables: []*armnetwork.MatchVariable{
									{
										VariableName: armnetwork.WebApplicationFirewallMatchVariable("RemoteAddr").ToPtr(),
									}},
								Operator: armnetwork.WebApplicationFirewallOperator("IPMatch").ToPtr(),
							},
							{
								MatchValues: []*string{
									to.StringPtr("Windows")},
								MatchVariables: []*armnetwork.MatchVariable{
									{
										Selector:     to.StringPtr("<selector>"),
										VariableName: armnetwork.WebApplicationFirewallMatchVariable("RequestHeaders").ToPtr(),
									}},
								Operator: armnetwork.WebApplicationFirewallOperator("Contains").ToPtr(),
							}},
						Priority: to.Int32Ptr(2),
						RuleType: armnetwork.WebApplicationFirewallRuleType("MatchRule").ToPtr(),
					}},
				ManagedRules: &armnetwork.ManagedRulesDefinition{
					Exclusions: []*armnetwork.OwaspCrsExclusionEntry{
						{
							ExclusionManagedRuleSets: []*armnetwork.ExclusionManagedRuleSet{
								{
									RuleGroups: []*armnetwork.ExclusionManagedRuleGroup{
										{
											RuleGroupName: to.StringPtr("<rule-group-name>"),
											Rules: []*armnetwork.ExclusionManagedRule{
												{
													RuleID: to.StringPtr("<rule-id>"),
												}},
										},
										{
											RuleGroupName: to.StringPtr("<rule-group-name>"),
										}},
									RuleSetType:    to.StringPtr("<rule-set-type>"),
									RuleSetVersion: to.StringPtr("<rule-set-version>"),
								}},
							MatchVariable:         armnetwork.OwaspCrsExclusionEntryMatchVariable("RequestArgNames").ToPtr(),
							Selector:              to.StringPtr("<selector>"),
							SelectorMatchOperator: armnetwork.OwaspCrsExclusionEntrySelectorMatchOperator("StartsWith").ToPtr(),
						},
						{
							ExclusionManagedRuleSets: []*armnetwork.ExclusionManagedRuleSet{
								{
									RuleGroups:     []*armnetwork.ExclusionManagedRuleGroup{},
									RuleSetType:    to.StringPtr("<rule-set-type>"),
									RuleSetVersion: to.StringPtr("<rule-set-version>"),
								}},
							MatchVariable:         armnetwork.OwaspCrsExclusionEntryMatchVariable("RequestArgNames").ToPtr(),
							Selector:              to.StringPtr("<selector>"),
							SelectorMatchOperator: armnetwork.OwaspCrsExclusionEntrySelectorMatchOperator("EndsWith").ToPtr(),
						},
						{
							MatchVariable:         armnetwork.OwaspCrsExclusionEntryMatchVariable("RequestArgNames").ToPtr(),
							Selector:              to.StringPtr("<selector>"),
							SelectorMatchOperator: armnetwork.OwaspCrsExclusionEntrySelectorMatchOperator("StartsWith").ToPtr(),
						},
						{
							MatchVariable:         armnetwork.OwaspCrsExclusionEntryMatchVariable("RequestArgValues").ToPtr(),
							Selector:              to.StringPtr("<selector>"),
							SelectorMatchOperator: armnetwork.OwaspCrsExclusionEntrySelectorMatchOperator("StartsWith").ToPtr(),
						}},
					ManagedRuleSets: []*armnetwork.ManagedRuleSet{
						{
							RuleSetType:    to.StringPtr("<rule-set-type>"),
							RuleSetVersion: to.StringPtr("<rule-set-version>"),
						}},
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WebApplicationFirewallPoliciesClientCreateOrUpdateResult)
}

Output:

func (*WebApplicationFirewallPoliciesClient) Get 

func (client *WebApplicationFirewallPoliciesClient) Get(ctx context.Context, resourceGroupName string, policyName string, options *WebApplicationFirewallPoliciesClientGetOptions) (WebApplicationFirewallPoliciesClientGetResponse, error)

Get - Retrieve protection policy with specified name within a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. policyName - The name of the policy. options - WebApplicationFirewallPoliciesClientGetOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/WafPolicyGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWebApplicationFirewallPoliciesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<policy-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WebApplicationFirewallPoliciesClientGetResult)
}

Output:

func (*WebApplicationFirewallPoliciesClient) List 

func (client *WebApplicationFirewallPoliciesClient) List(resourceGroupName string, options *WebApplicationFirewallPoliciesClientListOptions) *WebApplicationFirewallPoliciesClientListPager

List - Lists all of the protection policies within a resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - WebApplicationFirewallPoliciesClientListOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.List method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/WafListPolicies.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWebApplicationFirewallPoliciesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*WebApplicationFirewallPoliciesClient) ListAll 

func (client *WebApplicationFirewallPoliciesClient) ListAll(options *WebApplicationFirewallPoliciesClientListAllOptions) *WebApplicationFirewallPoliciesClientListAllPager

ListAll - Gets all the WAF policies in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - WebApplicationFirewallPoliciesClientListAllOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.ListAll method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/WafListAllPolicies.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWebApplicationFirewallPoliciesClient("<subscription-id>", cred, nil)
	pager := client.ListAll(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type WebApplicationFirewallPoliciesClientBeginDeleteOptions added in v0.3.0 

type WebApplicationFirewallPoliciesClientBeginDeleteOptions struct {
}

WebApplicationFirewallPoliciesClientBeginDeleteOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.BeginDelete method.

type WebApplicationFirewallPoliciesClientCreateOrUpdateOptions added in v0.3.0 

type WebApplicationFirewallPoliciesClientCreateOrUpdateOptions struct {
}

WebApplicationFirewallPoliciesClientCreateOrUpdateOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.CreateOrUpdate method.

type WebApplicationFirewallPoliciesClientCreateOrUpdateResponse added in v0.3.0 

type WebApplicationFirewallPoliciesClientCreateOrUpdateResponse struct {
	WebApplicationFirewallPoliciesClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WebApplicationFirewallPoliciesClientCreateOrUpdateResponse contains the response from method WebApplicationFirewallPoliciesClient.CreateOrUpdate.

type WebApplicationFirewallPoliciesClientCreateOrUpdateResult added in v0.3.0 

type WebApplicationFirewallPoliciesClientCreateOrUpdateResult struct {
	WebApplicationFirewallPolicy
}

WebApplicationFirewallPoliciesClientCreateOrUpdateResult contains the result from method WebApplicationFirewallPoliciesClient.CreateOrUpdate.

type WebApplicationFirewallPoliciesClientDeletePoller added in v0.3.0 

type WebApplicationFirewallPoliciesClientDeletePoller struct {
	// contains filtered or unexported fields
}

WebApplicationFirewallPoliciesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*WebApplicationFirewallPoliciesClientDeletePoller) Done added in v0.3.0 

func (p *WebApplicationFirewallPoliciesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*WebApplicationFirewallPoliciesClientDeletePoller) FinalResponse added in v0.3.0 

func (p *WebApplicationFirewallPoliciesClientDeletePoller) FinalResponse(ctx context.Context) (WebApplicationFirewallPoliciesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final WebApplicationFirewallPoliciesClientDeleteResponse will be returned.

func (*WebApplicationFirewallPoliciesClientDeletePoller) Poll added in v0.3.0 

func (p *WebApplicationFirewallPoliciesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*WebApplicationFirewallPoliciesClientDeletePoller) ResumeToken added in v0.3.0 

func (p *WebApplicationFirewallPoliciesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type WebApplicationFirewallPoliciesClientDeletePollerResponse added in v0.3.0 

type WebApplicationFirewallPoliciesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *WebApplicationFirewallPoliciesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WebApplicationFirewallPoliciesClientDeletePollerResponse contains the response from method WebApplicationFirewallPoliciesClient.Delete.

func (WebApplicationFirewallPoliciesClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l WebApplicationFirewallPoliciesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (WebApplicationFirewallPoliciesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*WebApplicationFirewallPoliciesClientDeletePollerResponse) Resume added in v0.3.0 

func (l *WebApplicationFirewallPoliciesClientDeletePollerResponse) Resume(ctx context.Context, client *WebApplicationFirewallPoliciesClient, token string) error

Resume rehydrates a WebApplicationFirewallPoliciesClientDeletePollerResponse from the provided client and resume token.

type WebApplicationFirewallPoliciesClientDeleteResponse added in v0.3.0 

type WebApplicationFirewallPoliciesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WebApplicationFirewallPoliciesClientDeleteResponse contains the response from method WebApplicationFirewallPoliciesClient.Delete.

type WebApplicationFirewallPoliciesClientGetOptions added in v0.3.0 

type WebApplicationFirewallPoliciesClientGetOptions struct {
}

WebApplicationFirewallPoliciesClientGetOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.Get method.

type WebApplicationFirewallPoliciesClientGetResponse added in v0.3.0 

type WebApplicationFirewallPoliciesClientGetResponse struct {
	WebApplicationFirewallPoliciesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WebApplicationFirewallPoliciesClientGetResponse contains the response from method WebApplicationFirewallPoliciesClient.Get.

type WebApplicationFirewallPoliciesClientGetResult added in v0.3.0 

type WebApplicationFirewallPoliciesClientGetResult struct {
	WebApplicationFirewallPolicy
}

WebApplicationFirewallPoliciesClientGetResult contains the result from method WebApplicationFirewallPoliciesClient.Get.

type WebApplicationFirewallPoliciesClientListAllOptions added in v0.3.0 

type WebApplicationFirewallPoliciesClientListAllOptions struct {
}

WebApplicationFirewallPoliciesClientListAllOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.ListAll method.

type WebApplicationFirewallPoliciesClientListAllPager added in v0.3.0 

type WebApplicationFirewallPoliciesClientListAllPager struct {
	// contains filtered or unexported fields
}

WebApplicationFirewallPoliciesClientListAllPager provides operations for iterating over paged responses.

func (*WebApplicationFirewallPoliciesClientListAllPager) Err added in v0.3.0 

func (p *WebApplicationFirewallPoliciesClientListAllPager) Err() error

Err returns the last error encountered while paging.

func (*WebApplicationFirewallPoliciesClientListAllPager) NextPage added in v0.3.0 

func (p *WebApplicationFirewallPoliciesClientListAllPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*WebApplicationFirewallPoliciesClientListAllPager) PageResponse added in v0.3.0 

func (p *WebApplicationFirewallPoliciesClientListAllPager) PageResponse() WebApplicationFirewallPoliciesClientListAllResponse

PageResponse returns the current WebApplicationFirewallPoliciesClientListAllResponse page.

type WebApplicationFirewallPoliciesClientListAllResponse added in v0.3.0 

type WebApplicationFirewallPoliciesClientListAllResponse struct {
	WebApplicationFirewallPoliciesClientListAllResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WebApplicationFirewallPoliciesClientListAllResponse contains the response from method WebApplicationFirewallPoliciesClient.ListAll.

type WebApplicationFirewallPoliciesClientListAllResult added in v0.3.0 

type WebApplicationFirewallPoliciesClientListAllResult struct {
	WebApplicationFirewallPolicyListResult
}

WebApplicationFirewallPoliciesClientListAllResult contains the result from method WebApplicationFirewallPoliciesClient.ListAll.

type WebApplicationFirewallPoliciesClientListOptions added in v0.3.0 

type WebApplicationFirewallPoliciesClientListOptions struct {
}

WebApplicationFirewallPoliciesClientListOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.List method.

type WebApplicationFirewallPoliciesClientListPager added in v0.3.0 

type WebApplicationFirewallPoliciesClientListPager struct {
	// contains filtered or unexported fields
}

WebApplicationFirewallPoliciesClientListPager provides operations for iterating over paged responses.

func (*WebApplicationFirewallPoliciesClientListPager) Err added in v0.3.0 

func (p *WebApplicationFirewallPoliciesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*WebApplicationFirewallPoliciesClientListPager) NextPage added in v0.3.0 

func (p *WebApplicationFirewallPoliciesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*WebApplicationFirewallPoliciesClientListPager) PageResponse added in v0.3.0 

func (p *WebApplicationFirewallPoliciesClientListPager) PageResponse() WebApplicationFirewallPoliciesClientListResponse

PageResponse returns the current WebApplicationFirewallPoliciesClientListResponse page.

type WebApplicationFirewallPoliciesClientListResponse added in v0.3.0 

type WebApplicationFirewallPoliciesClientListResponse struct {
	WebApplicationFirewallPoliciesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WebApplicationFirewallPoliciesClientListResponse contains the response from method WebApplicationFirewallPoliciesClient.List.

type WebApplicationFirewallPoliciesClientListResult added in v0.3.0 

type WebApplicationFirewallPoliciesClientListResult struct {
	WebApplicationFirewallPolicyListResult
}

WebApplicationFirewallPoliciesClientListResult contains the result from method WebApplicationFirewallPoliciesClient.List.

type WebApplicationFirewallPolicy 

type WebApplicationFirewallPolicy struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Resource location.
	Location *string `json:"location,omitempty"`

	// Properties of the web application firewall policy.
	Properties *WebApplicationFirewallPolicyPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Resource name.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

WebApplicationFirewallPolicy - Defines web application firewall policy.

func (WebApplicationFirewallPolicy) MarshalJSON 

func (w WebApplicationFirewallPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebApplicationFirewallPolicy.

type WebApplicationFirewallPolicyListResult 

type WebApplicationFirewallPolicyListResult struct {
	// READ-ONLY; URL to get the next set of WebApplicationFirewallPolicy objects if there are any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of WebApplicationFirewallPolicies within a resource group.
	Value []*WebApplicationFirewallPolicy `json:"value,omitempty" azure:"ro"`
}

WebApplicationFirewallPolicyListResult - Result of the request to list WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.

func (WebApplicationFirewallPolicyListResult) MarshalJSON 

func (w WebApplicationFirewallPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebApplicationFirewallPolicyListResult.

type WebApplicationFirewallPolicyPropertiesFormat 

type WebApplicationFirewallPolicyPropertiesFormat struct {
	// REQUIRED; Describes the managedRules structure.
	ManagedRules *ManagedRulesDefinition `json:"managedRules,omitempty"`

	// The custom rules inside the policy.
	CustomRules []*WebApplicationFirewallCustomRule `json:"customRules,omitempty"`

	// The PolicySettings for policy.
	PolicySettings *PolicySettings `json:"policySettings,omitempty"`

	// READ-ONLY; A collection of references to application gateways.
	ApplicationGateways []*ApplicationGateway `json:"applicationGateways,omitempty" azure:"ro"`

	// READ-ONLY; A collection of references to application gateway http listeners.
	HTTPListeners []*SubResource `json:"httpListeners,omitempty" azure:"ro"`

	// READ-ONLY; A collection of references to application gateway path rules.
	PathBasedRules []*SubResource `json:"pathBasedRules,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the web application firewall policy resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Resource status of the policy.
	ResourceState *WebApplicationFirewallPolicyResourceState `json:"resourceState,omitempty" azure:"ro"`
}

WebApplicationFirewallPolicyPropertiesFormat - Defines web application firewall policy properties.

func (WebApplicationFirewallPolicyPropertiesFormat) MarshalJSON 

func (w WebApplicationFirewallPolicyPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WebApplicationFirewallPolicyPropertiesFormat.

type WebApplicationFirewallPolicyResourceState 

type WebApplicationFirewallPolicyResourceState string

WebApplicationFirewallPolicyResourceState - Resource status of the policy. 

const (
	WebApplicationFirewallPolicyResourceStateCreating  WebApplicationFirewallPolicyResourceState = "Creating"
	WebApplicationFirewallPolicyResourceStateDeleting  WebApplicationFirewallPolicyResourceState = "Deleting"
	WebApplicationFirewallPolicyResourceStateDisabled  WebApplicationFirewallPolicyResourceState = "Disabled"
	WebApplicationFirewallPolicyResourceStateDisabling WebApplicationFirewallPolicyResourceState = "Disabling"
	WebApplicationFirewallPolicyResourceStateEnabled   WebApplicationFirewallPolicyResourceState = "Enabled"
	WebApplicationFirewallPolicyResourceStateEnabling  WebApplicationFirewallPolicyResourceState = "Enabling"
)

func PossibleWebApplicationFirewallPolicyResourceStateValues 

func PossibleWebApplicationFirewallPolicyResourceStateValues() []WebApplicationFirewallPolicyResourceState

PossibleWebApplicationFirewallPolicyResourceStateValues returns the possible values for the WebApplicationFirewallPolicyResourceState const type.

func (WebApplicationFirewallPolicyResourceState) ToPtr 

func (c WebApplicationFirewallPolicyResourceState) ToPtr() *WebApplicationFirewallPolicyResourceState

ToPtr returns a *WebApplicationFirewallPolicyResourceState pointing to the current value.

type WebApplicationFirewallRuleType 

type WebApplicationFirewallRuleType string

WebApplicationFirewallRuleType - The rule type. 

const (
	WebApplicationFirewallRuleTypeInvalid   WebApplicationFirewallRuleType = "Invalid"
	WebApplicationFirewallRuleTypeMatchRule WebApplicationFirewallRuleType = "MatchRule"
)

func PossibleWebApplicationFirewallRuleTypeValues 

func PossibleWebApplicationFirewallRuleTypeValues() []WebApplicationFirewallRuleType

PossibleWebApplicationFirewallRuleTypeValues returns the possible values for the WebApplicationFirewallRuleType const type.

func (WebApplicationFirewallRuleType) ToPtr 

func (c WebApplicationFirewallRuleType) ToPtr() *WebApplicationFirewallRuleType

ToPtr returns a *WebApplicationFirewallRuleType pointing to the current value.

type WebApplicationFirewallTransform 

type WebApplicationFirewallTransform string

WebApplicationFirewallTransform - Transforms applied before matching. 

const (
	WebApplicationFirewallTransformHTMLEntityDecode WebApplicationFirewallTransform = "HtmlEntityDecode"
	WebApplicationFirewallTransformLowercase        WebApplicationFirewallTransform = "Lowercase"
	WebApplicationFirewallTransformRemoveNulls      WebApplicationFirewallTransform = "RemoveNulls"
	WebApplicationFirewallTransformTrim             WebApplicationFirewallTransform = "Trim"
	WebApplicationFirewallTransformURLDecode        WebApplicationFirewallTransform = "UrlDecode"
	WebApplicationFirewallTransformURLEncode        WebApplicationFirewallTransform = "UrlEncode"
)

func PossibleWebApplicationFirewallTransformValues 

func PossibleWebApplicationFirewallTransformValues() []WebApplicationFirewallTransform

PossibleWebApplicationFirewallTransformValues returns the possible values for the WebApplicationFirewallTransform const type.

func (WebApplicationFirewallTransform) ToPtr 

func (c WebApplicationFirewallTransform) ToPtr() *WebApplicationFirewallTransform

ToPtr returns a *WebApplicationFirewallTransform pointing to the current value.

type WebCategoriesClient 

type WebCategoriesClient struct {
	// contains filtered or unexported fields
}

WebCategoriesClient contains the methods for the WebCategories group. Don't use this type directly, use NewWebCategoriesClient() instead.

func NewWebCategoriesClient 

func NewWebCategoriesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *WebCategoriesClient

NewWebCategoriesClient creates a new instance of WebCategoriesClient with the specified values. subscriptionID - The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*WebCategoriesClient) Get 

func (client *WebCategoriesClient) Get(ctx context.Context, name string, options *WebCategoriesClientGetOptions) (WebCategoriesClientGetResponse, error)

Get - Gets the specified Azure Web Category. If the operation fails it returns an *azcore.ResponseError type. name - The name of the azureWebCategory. options - WebCategoriesClientGetOptions contains the optional parameters for the WebCategoriesClient.Get method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AzureWebCategoryGet.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWebCategoriesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<name>",
		&armnetwork.WebCategoriesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WebCategoriesClientGetResult)
}

Output:

func (*WebCategoriesClient) ListBySubscription 

func (client *WebCategoriesClient) ListBySubscription(options *WebCategoriesClientListBySubscriptionOptions) *WebCategoriesClientListBySubscriptionPager

ListBySubscription - Gets all the Azure Web Categories in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - WebCategoriesClientListBySubscriptionOptions contains the optional parameters for the WebCategoriesClient.ListBySubscription method.

Example

x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-05-01/examples/AzureWebCategoriesListBySubscription.json 

package main

import (
	"context"
	"log"

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

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armnetwork.NewWebCategoriesClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type WebCategoriesClientGetOptions added in v0.3.0 

type WebCategoriesClientGetOptions struct {
	// Expands resourceIds back referenced by the azureWebCategory resource.
	Expand *string
}

WebCategoriesClientGetOptions contains the optional parameters for the WebCategoriesClient.Get method.

type WebCategoriesClientGetResponse added in v0.3.0 

type WebCategoriesClientGetResponse struct {
	WebCategoriesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WebCategoriesClientGetResponse contains the response from method WebCategoriesClient.Get.

type WebCategoriesClientGetResult added in v0.3.0 

type WebCategoriesClientGetResult struct {
	AzureWebCategory
}

WebCategoriesClientGetResult contains the result from method WebCategoriesClient.Get.

type WebCategoriesClientListBySubscriptionOptions added in v0.3.0 

type WebCategoriesClientListBySubscriptionOptions struct {
}

WebCategoriesClientListBySubscriptionOptions contains the optional parameters for the WebCategoriesClient.ListBySubscription method.

type WebCategoriesClientListBySubscriptionPager added in v0.3.0 

type WebCategoriesClientListBySubscriptionPager struct {
	// contains filtered or unexported fields
}

WebCategoriesClientListBySubscriptionPager provides operations for iterating over paged responses.

func (*WebCategoriesClientListBySubscriptionPager) Err added in v0.3.0 

func (p *WebCategoriesClientListBySubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*WebCategoriesClientListBySubscriptionPager) NextPage added in v0.3.0 

func (p *WebCategoriesClientListBySubscriptionPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*WebCategoriesClientListBySubscriptionPager) PageResponse added in v0.3.0 

func (p *WebCategoriesClientListBySubscriptionPager) PageResponse() WebCategoriesClientListBySubscriptionResponse

PageResponse returns the current WebCategoriesClientListBySubscriptionResponse page.

type WebCategoriesClientListBySubscriptionResponse added in v0.3.0 

type WebCategoriesClientListBySubscriptionResponse struct {
	WebCategoriesClientListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WebCategoriesClientListBySubscriptionResponse contains the response from method WebCategoriesClient.ListBySubscription.

type WebCategoriesClientListBySubscriptionResult added in v0.3.0 

type WebCategoriesClientListBySubscriptionResult struct {
	AzureWebCategoryListResult
}

WebCategoriesClientListBySubscriptionResult contains the result from method WebCategoriesClient.ListBySubscription.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.