armnetwork

package module
v2.0.0 Latest Latest
Warning

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

Go to latest
Published: Oct 8, 2022 License: MIT Imports: 17 Imported by: 35

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, err := 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 {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client, err := 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.

func (AADAuthenticationParameters) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AADAuthenticationParameters.

func (*AADAuthenticationParameters) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AADAuthenticationParameters.

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.

type Action

type Action struct {
	// List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If
	// type is add, parameters would have list of ASN numbers to be added
	Parameters []*Parameter `json:"parameters,omitempty"`

	// Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'
	Type *RouteMapActionType `json:"type,omitempty"`
}

Action to be taken on a route matching a RouteMap criterion.

func (Action) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Action.

func (*Action) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Action.

type ActionType

type ActionType string

ActionType - Defines the action to take on rule match.

const (
	ActionTypeAllow          ActionType = "Allow"
	ActionTypeAnomalyScoring ActionType = "AnomalyScoring"
	ActionTypeBlock          ActionType = "Block"
	ActionTypeLog            ActionType = "Log"
)

func PossibleActionTypeValues

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns the possible values for the ActionType const type.

type ActiveBaseSecurityAdminRule

type ActiveBaseSecurityAdminRule struct {
	// REQUIRED; Whether the rule is custom or default.
	Kind *EffectiveAdminRuleKind `json:"kind,omitempty"`

	// Deployment time string.
	CommitTime *time.Time `json:"commitTime,omitempty"`

	// A description of the security admin configuration.
	ConfigurationDescription *string `json:"configurationDescription,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Deployment region.
	Region *string `json:"region,omitempty"`

	// Groups for rule collection
	RuleCollectionAppliesToGroups []*ManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`

	// A description of the rule collection.
	RuleCollectionDescription *string `json:"ruleCollectionDescription,omitempty"`

	// Effective configuration groups.
	RuleGroups []*ConfigurationGroup `json:"ruleGroups,omitempty"`
}

ActiveBaseSecurityAdminRule - Network base admin rule.

func (*ActiveBaseSecurityAdminRule) GetActiveBaseSecurityAdminRule

func (a *ActiveBaseSecurityAdminRule) GetActiveBaseSecurityAdminRule() *ActiveBaseSecurityAdminRule

GetActiveBaseSecurityAdminRule implements the ActiveBaseSecurityAdminRuleClassification interface for type ActiveBaseSecurityAdminRule.

func (ActiveBaseSecurityAdminRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ActiveBaseSecurityAdminRule.

func (*ActiveBaseSecurityAdminRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ActiveBaseSecurityAdminRule.

type ActiveBaseSecurityAdminRuleClassification

type ActiveBaseSecurityAdminRuleClassification interface {
	// GetActiveBaseSecurityAdminRule returns the ActiveBaseSecurityAdminRule content of the underlying type.
	GetActiveBaseSecurityAdminRule() *ActiveBaseSecurityAdminRule
}

ActiveBaseSecurityAdminRuleClassification provides polymorphic access to related types. Call the interface's GetActiveBaseSecurityAdminRule() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ActiveBaseSecurityAdminRule, *ActiveDefaultSecurityAdminRule, *ActiveSecurityAdminRule

type ActiveConfigurationParameter

type ActiveConfigurationParameter struct {
	// List of regions.
	Regions []*string `json:"regions,omitempty"`

	// When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current
	// request) to retrieve the next page of data.
	SkipToken *string `json:"skipToken,omitempty"`
}

ActiveConfigurationParameter - Effective Virtual Networks Parameter.

func (ActiveConfigurationParameter) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ActiveConfigurationParameter.

func (*ActiveConfigurationParameter) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ActiveConfigurationParameter.

type ActiveConnectivityConfiguration

type ActiveConnectivityConfiguration struct {
	// Deployment time string.
	CommitTime *time.Time `json:"commitTime,omitempty"`

	// Effective configuration groups.
	ConfigurationGroups []*ConfigurationGroup `json:"configurationGroups,omitempty"`

	// Connectivity configuration ID.
	ID *string `json:"id,omitempty"`

	// Properties of a network manager connectivity configuration
	Properties *ConnectivityConfigurationProperties `json:"properties,omitempty"`

	// Deployment region.
	Region *string `json:"region,omitempty"`
}

ActiveConnectivityConfiguration - Active connectivity configuration.

func (ActiveConnectivityConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ActiveConnectivityConfiguration.

func (*ActiveConnectivityConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ActiveConnectivityConfiguration.

type ActiveConnectivityConfigurationsListResult

type ActiveConnectivityConfigurationsListResult struct {
	// When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current
	// request) to retrieve the next page of data.
	SkipToken *string `json:"skipToken,omitempty"`

	// Gets a page of active connectivity configurations.
	Value []*ActiveConnectivityConfiguration `json:"value,omitempty"`
}

ActiveConnectivityConfigurationsListResult - Result of the request to list active connectivity configurations. It contains a list of active connectivity configurations and a skiptoken to get the next set of results.

func (ActiveConnectivityConfigurationsListResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ActiveConnectivityConfigurationsListResult.

func (*ActiveConnectivityConfigurationsListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ActiveConnectivityConfigurationsListResult.

type ActiveDefaultSecurityAdminRule

type ActiveDefaultSecurityAdminRule struct {
	// REQUIRED; Whether the rule is custom or default.
	Kind *EffectiveAdminRuleKind `json:"kind,omitempty"`

	// Deployment time string.
	CommitTime *time.Time `json:"commitTime,omitempty"`

	// A description of the security admin configuration.
	ConfigurationDescription *string `json:"configurationDescription,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Indicates the properties of the default security admin rule
	Properties *DefaultAdminPropertiesFormat `json:"properties,omitempty"`

	// Deployment region.
	Region *string `json:"region,omitempty"`

	// Groups for rule collection
	RuleCollectionAppliesToGroups []*ManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`

	// A description of the rule collection.
	RuleCollectionDescription *string `json:"ruleCollectionDescription,omitempty"`

	// Effective configuration groups.
	RuleGroups []*ConfigurationGroup `json:"ruleGroups,omitempty"`
}

ActiveDefaultSecurityAdminRule - Network default admin rule.

func (*ActiveDefaultSecurityAdminRule) GetActiveBaseSecurityAdminRule

func (a *ActiveDefaultSecurityAdminRule) GetActiveBaseSecurityAdminRule() *ActiveBaseSecurityAdminRule

GetActiveBaseSecurityAdminRule implements the ActiveBaseSecurityAdminRuleClassification interface for type ActiveDefaultSecurityAdminRule.

func (ActiveDefaultSecurityAdminRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ActiveDefaultSecurityAdminRule.

func (*ActiveDefaultSecurityAdminRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ActiveDefaultSecurityAdminRule.

type ActiveSecurityAdminRule

type ActiveSecurityAdminRule struct {
	// REQUIRED; Whether the rule is custom or default.
	Kind *EffectiveAdminRuleKind `json:"kind,omitempty"`

	// Deployment time string.
	CommitTime *time.Time `json:"commitTime,omitempty"`

	// A description of the security admin configuration.
	ConfigurationDescription *string `json:"configurationDescription,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Indicates the properties of the security admin rule
	Properties *AdminPropertiesFormat `json:"properties,omitempty"`

	// Deployment region.
	Region *string `json:"region,omitempty"`

	// Groups for rule collection
	RuleCollectionAppliesToGroups []*ManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`

	// A description of the rule collection.
	RuleCollectionDescription *string `json:"ruleCollectionDescription,omitempty"`

	// Effective configuration groups.
	RuleGroups []*ConfigurationGroup `json:"ruleGroups,omitempty"`
}

ActiveSecurityAdminRule - Network admin rule.

func (*ActiveSecurityAdminRule) GetActiveBaseSecurityAdminRule

func (a *ActiveSecurityAdminRule) GetActiveBaseSecurityAdminRule() *ActiveBaseSecurityAdminRule

GetActiveBaseSecurityAdminRule implements the ActiveBaseSecurityAdminRuleClassification interface for type ActiveSecurityAdminRule.

func (ActiveSecurityAdminRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ActiveSecurityAdminRule.

func (*ActiveSecurityAdminRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ActiveSecurityAdminRule.

type ActiveSecurityAdminRulesListResult

type ActiveSecurityAdminRulesListResult struct {
	// When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current
	// request) to retrieve the next page of data.
	SkipToken *string `json:"skipToken,omitempty"`

	// Gets a page of active security admin rules.
	Value []ActiveBaseSecurityAdminRuleClassification `json:"value,omitempty"`
}

ActiveSecurityAdminRulesListResult - Result of the request to list active security admin rules. It contains a list of active security admin rules and a skiptoken to get the next set of results.

func (ActiveSecurityAdminRulesListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ActiveSecurityAdminRulesListResult.

func (*ActiveSecurityAdminRulesListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ActiveSecurityAdminRulesListResult.

type AddressPrefixItem

type AddressPrefixItem struct {
	// Address prefix.
	AddressPrefix *string `json:"addressPrefix,omitempty"`

	// Address prefix type.
	AddressPrefixType *AddressPrefixType `json:"addressPrefixType,omitempty"`
}

AddressPrefixItem - Address prefix item.

func (AddressPrefixItem) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AddressPrefixItem.

func (*AddressPrefixItem) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AddressPrefixItem.

type AddressPrefixType

type AddressPrefixType string

AddressPrefixType - Address prefix type.

const (
	AddressPrefixTypeIPPrefix   AddressPrefixType = "IPPrefix"
	AddressPrefixTypeServiceTag AddressPrefixType = "ServiceTag"
)

func PossibleAddressPrefixTypeValues

func PossibleAddressPrefixTypeValues() []AddressPrefixType

PossibleAddressPrefixTypeValues returns the possible values for the AddressPrefixType const type.

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.

func (*AddressSpace) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AddressSpace.

type AdminPropertiesFormat

type AdminPropertiesFormat struct {
	// REQUIRED; Indicates the access allowed for this particular rule
	Access *SecurityConfigurationRuleAccess `json:"access,omitempty"`

	// REQUIRED; Indicates if the traffic matched against the rule in inbound or outbound.
	Direction *SecurityConfigurationRuleDirection `json:"direction,omitempty"`

	// REQUIRED; The priority of the rule. The value can be between 1 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"`

	// REQUIRED; Network protocol this rule applies to.
	Protocol *SecurityConfigurationRuleProtocol `json:"protocol,omitempty"`

	// A description for this rule. Restricted to 140 chars.
	Description *string `json:"description,omitempty"`

	// The destination port ranges.
	DestinationPortRanges []*string `json:"destinationPortRanges,omitempty"`

	// The destination address prefixes. CIDR or destination IP ranges.
	Destinations []*AddressPrefixItem `json:"destinations,omitempty"`

	// The source port ranges.
	SourcePortRanges []*string `json:"sourcePortRanges,omitempty"`

	// The CIDR or source IP ranges.
	Sources []*AddressPrefixItem `json:"sources,omitempty"`

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

AdminPropertiesFormat - Security admin rule resource.

func (AdminPropertiesFormat) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AdminPropertiesFormat.

func (*AdminPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AdminPropertiesFormat.

type AdminRule

type AdminRule struct {
	// REQUIRED; Whether the rule is custom or default.
	Kind *AdminRuleKind `json:"kind,omitempty"`

	// Indicates the properties of the security admin rule
	Properties *AdminPropertiesFormat `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 ID.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

AdminRule - Network admin rule.

func (*AdminRule) GetBaseAdminRule

func (a *AdminRule) GetBaseAdminRule() *BaseAdminRule

GetBaseAdminRule implements the BaseAdminRuleClassification interface for type AdminRule.

func (AdminRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AdminRule.

func (*AdminRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AdminRule.

type AdminRuleCollection

type AdminRuleCollection struct {
	// Indicates the properties for the network manager admin rule collection.
	Properties *AdminRuleCollectionPropertiesFormat `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 ID.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

AdminRuleCollection - Defines the admin rule collection.

func (AdminRuleCollection) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AdminRuleCollection.

func (*AdminRuleCollection) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AdminRuleCollection.

type AdminRuleCollectionListResult

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

	// A list of network manager security admin configuration rule collections
	Value []*AdminRuleCollection `json:"value,omitempty"`
}

AdminRuleCollectionListResult - Security admin configuration rule collection list result.

func (AdminRuleCollectionListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AdminRuleCollectionListResult.

func (*AdminRuleCollectionListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AdminRuleCollectionListResult.

type AdminRuleCollectionPropertiesFormat

type AdminRuleCollectionPropertiesFormat struct {
	// REQUIRED; Groups for configuration
	AppliesToGroups []*ManagerSecurityGroupItem `json:"appliesToGroups,omitempty"`

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

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

AdminRuleCollectionPropertiesFormat - Defines the admin rule collection properties.

func (AdminRuleCollectionPropertiesFormat) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AdminRuleCollectionPropertiesFormat.

func (*AdminRuleCollectionPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AdminRuleCollectionPropertiesFormat.

type AdminRuleCollectionsClient

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

AdminRuleCollectionsClient contains the methods for the AdminRuleCollections group. Don't use this type directly, use NewAdminRuleCollectionsClient() instead.

func NewAdminRuleCollectionsClient

func NewAdminRuleCollectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AdminRuleCollectionsClient, error)

NewAdminRuleCollectionsClient creates a new instance of AdminRuleCollectionsClient 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 (*AdminRuleCollectionsClient) BeginDelete

func (client *AdminRuleCollectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkManagerName string, configurationName string, ruleCollectionName string, options *AdminRuleCollectionsClientBeginDeleteOptions) (*runtime.Poller[AdminRuleCollectionsClientDeleteResponse], error)

BeginDelete - Deletes an admin rule collection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. ruleCollectionName - The name of the network manager security Configuration rule collection. options - AdminRuleCollectionsClientBeginDeleteOptions contains the optional parameters for the AdminRuleCollectionsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerAdminRuleCollectionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAdminRuleCollectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", "testRuleCollection", &armnetwork.AdminRuleCollectionsClientBeginDeleteOptions{Force: to.Ptr(false)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*AdminRuleCollectionsClient) CreateOrUpdate

func (client *AdminRuleCollectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkManagerName string, configurationName string, ruleCollectionName string, ruleCollection AdminRuleCollection, options *AdminRuleCollectionsClientCreateOrUpdateOptions) (AdminRuleCollectionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates an admin rule collection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. ruleCollectionName - The name of the network manager security Configuration rule collection. ruleCollection - The Rule Collection to create or update options - AdminRuleCollectionsClientCreateOrUpdateOptions contains the optional parameters for the AdminRuleCollectionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerAdminRuleCollectionPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAdminRuleCollectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", "testRuleCollection", armnetwork.AdminRuleCollection{
	Properties: &armnetwork.AdminRuleCollectionPropertiesFormat{
		Description: to.Ptr("A sample policy"),
		AppliesToGroups: []*armnetwork.ManagerSecurityGroupItem{
			{
				NetworkGroupID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup"),
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*AdminRuleCollectionsClient) Get

func (client *AdminRuleCollectionsClient) Get(ctx context.Context, resourceGroupName string, networkManagerName string, configurationName string, ruleCollectionName string, options *AdminRuleCollectionsClientGetOptions) (AdminRuleCollectionsClientGetResponse, error)

Get - Gets a network manager security admin configuration rule collection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. ruleCollectionName - The name of the network manager security Configuration rule collection. options - AdminRuleCollectionsClientGetOptions contains the optional parameters for the AdminRuleCollectionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerAdminRuleCollectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAdminRuleCollectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", "testRuleCollection", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*AdminRuleCollectionsClient) NewListPager

func (client *AdminRuleCollectionsClient) NewListPager(resourceGroupName string, networkManagerName string, configurationName string, options *AdminRuleCollectionsClientListOptions) *runtime.Pager[AdminRuleCollectionsClientListResponse]

NewListPager - Lists all the rule collections in a security admin configuration, in a paginated format. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. options - AdminRuleCollectionsClientListOptions contains the optional parameters for the AdminRuleCollectionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerAdminRuleCollectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAdminRuleCollectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "testNetworkManager", "myTestSecurityConfig", &armnetwork.AdminRuleCollectionsClientListOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type AdminRuleCollectionsClientBeginDeleteOptions

type AdminRuleCollectionsClientBeginDeleteOptions struct {
	// Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service
	// will do a cleanup deployment in the background, prior to the delete.
	Force *bool
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AdminRuleCollectionsClientBeginDeleteOptions contains the optional parameters for the AdminRuleCollectionsClient.BeginDelete method.

type AdminRuleCollectionsClientCreateOrUpdateOptions

type AdminRuleCollectionsClientCreateOrUpdateOptions struct {
}

AdminRuleCollectionsClientCreateOrUpdateOptions contains the optional parameters for the AdminRuleCollectionsClient.CreateOrUpdate method.

type AdminRuleCollectionsClientCreateOrUpdateResponse

type AdminRuleCollectionsClientCreateOrUpdateResponse struct {
	AdminRuleCollection
}

AdminRuleCollectionsClientCreateOrUpdateResponse contains the response from method AdminRuleCollectionsClient.CreateOrUpdate.

type AdminRuleCollectionsClientDeleteResponse

type AdminRuleCollectionsClientDeleteResponse struct {
}

AdminRuleCollectionsClientDeleteResponse contains the response from method AdminRuleCollectionsClient.Delete.

type AdminRuleCollectionsClientGetOptions

type AdminRuleCollectionsClientGetOptions struct {
}

AdminRuleCollectionsClientGetOptions contains the optional parameters for the AdminRuleCollectionsClient.Get method.

type AdminRuleCollectionsClientGetResponse

type AdminRuleCollectionsClientGetResponse struct {
	AdminRuleCollection
}

AdminRuleCollectionsClientGetResponse contains the response from method AdminRuleCollectionsClient.Get.

type AdminRuleCollectionsClientListOptions

type AdminRuleCollectionsClientListOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

AdminRuleCollectionsClientListOptions contains the optional parameters for the AdminRuleCollectionsClient.List method.

type AdminRuleCollectionsClientListResponse

type AdminRuleCollectionsClientListResponse struct {
	AdminRuleCollectionListResult
}

AdminRuleCollectionsClientListResponse contains the response from method AdminRuleCollectionsClient.List.

type AdminRuleKind

type AdminRuleKind string

AdminRuleKind - Whether the rule is custom or default.

const (
	AdminRuleKindCustom  AdminRuleKind = "Custom"
	AdminRuleKindDefault AdminRuleKind = "Default"
)

func PossibleAdminRuleKindValues

func PossibleAdminRuleKindValues() []AdminRuleKind

PossibleAdminRuleKindValues returns the possible values for the AdminRuleKind const type.

type AdminRuleListResult

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

	// A list of admin rules
	Value []BaseAdminRuleClassification `json:"value,omitempty"`
}

AdminRuleListResult - security configuration admin rule list result.

func (AdminRuleListResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AdminRuleListResult.

func (*AdminRuleListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AdminRuleListResult.

type AdminRulesClient

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

AdminRulesClient contains the methods for the AdminRules group. Don't use this type directly, use NewAdminRulesClient() instead.

func NewAdminRulesClient

func NewAdminRulesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AdminRulesClient, error)

NewAdminRulesClient creates a new instance of AdminRulesClient 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 (*AdminRulesClient) BeginDelete

func (client *AdminRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkManagerName string, configurationName string, ruleCollectionName string, ruleName string, options *AdminRulesClientBeginDeleteOptions) (*runtime.Poller[AdminRulesClientDeleteResponse], error)

BeginDelete - Deletes an admin rule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. ruleCollectionName - The name of the network manager security Configuration rule collection. ruleName - The name of the rule. options - AdminRulesClientBeginDeleteOptions contains the optional parameters for the AdminRulesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerAdminRuleDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAdminRulesClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", "testRuleCollection", "SampleAdminRule", &armnetwork.AdminRulesClientBeginDeleteOptions{Force: to.Ptr(false)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*AdminRulesClient) CreateOrUpdate

func (client *AdminRulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkManagerName string, configurationName string, ruleCollectionName string, ruleName string, adminRule BaseAdminRuleClassification, options *AdminRulesClientCreateOrUpdateOptions) (AdminRulesClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates an admin rule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. ruleCollectionName - The name of the network manager security Configuration rule collection. ruleName - The name of the rule. adminRule - The admin rule to create or update options - AdminRulesClientCreateOrUpdateOptions contains the optional parameters for the AdminRulesClient.CreateOrUpdate method.

Example (CreateADefaultAdminRule)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerDefaultAdminRulePut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAdminRulesClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", "testRuleCollection", "SampleDefaultAdminRule", &armnetwork.DefaultAdminRule{
	Kind: to.Ptr(armnetwork.AdminRuleKindDefault),
	Properties: &armnetwork.DefaultAdminPropertiesFormat{
		Flag: to.Ptr("AllowVnetInbound"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateAnAdminRule)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerAdminRulePut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAdminRulesClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", "testRuleCollection", "SampleAdminRule", &armnetwork.AdminRule{
	Kind: to.Ptr(armnetwork.AdminRuleKindCustom),
	Properties: &armnetwork.AdminPropertiesFormat{
		Description: to.Ptr("This is Sample Admin Rule"),
		Access:      to.Ptr(armnetwork.SecurityConfigurationRuleAccessDeny),
		DestinationPortRanges: []*string{
			to.Ptr("22")},
		Destinations: []*armnetwork.AddressPrefixItem{
			{
				AddressPrefix:     to.Ptr("*"),
				AddressPrefixType: to.Ptr(armnetwork.AddressPrefixTypeIPPrefix),
			}},
		Direction: to.Ptr(armnetwork.SecurityConfigurationRuleDirectionInbound),
		Priority:  to.Ptr[int32](1),
		SourcePortRanges: []*string{
			to.Ptr("0-65535")},
		Sources: []*armnetwork.AddressPrefixItem{
			{
				AddressPrefix:     to.Ptr("Internet"),
				AddressPrefixType: to.Ptr(armnetwork.AddressPrefixTypeServiceTag),
			}},
		Protocol: to.Ptr(armnetwork.SecurityConfigurationRuleProtocolTCP),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*AdminRulesClient) Get

func (client *AdminRulesClient) Get(ctx context.Context, resourceGroupName string, networkManagerName string, configurationName string, ruleCollectionName string, ruleName string, options *AdminRulesClientGetOptions) (AdminRulesClientGetResponse, error)

Get - Gets a network manager security configuration admin rule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. ruleCollectionName - The name of the network manager security Configuration rule collection. ruleName - The name of the rule. options - AdminRulesClientGetOptions contains the optional parameters for the AdminRulesClient.Get method.

Example (GetsSecurityAdminRule)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerAdminRuleGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAdminRulesClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", "testRuleCollection", "SampleAdminRule", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetsSecurityDefaultAdminRule)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerDefaultAdminRuleGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAdminRulesClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", "testRuleCollection", "SampleDefaultAdminRule", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*AdminRulesClient) NewListPager

func (client *AdminRulesClient) NewListPager(resourceGroupName string, networkManagerName string, configurationName string, ruleCollectionName string, options *AdminRulesClientListOptions) *runtime.Pager[AdminRulesClientListResponse]

NewListPager - List all network manager security configuration admin rules. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. ruleCollectionName - The name of the network manager security Configuration rule collection. options - AdminRulesClientListOptions contains the optional parameters for the AdminRulesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerAdminRuleList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAdminRulesClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "testNetworkManager", "myTestSecurityConfig", "testRuleCollection", &armnetwork.AdminRulesClientListOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type AdminRulesClientBeginDeleteOptions

type AdminRulesClientBeginDeleteOptions struct {
	// Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service
	// will do a cleanup deployment in the background, prior to the delete.
	Force *bool
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AdminRulesClientBeginDeleteOptions contains the optional parameters for the AdminRulesClient.BeginDelete method.

type AdminRulesClientCreateOrUpdateOptions

type AdminRulesClientCreateOrUpdateOptions struct {
}

AdminRulesClientCreateOrUpdateOptions contains the optional parameters for the AdminRulesClient.CreateOrUpdate method.

type AdminRulesClientCreateOrUpdateResponse

type AdminRulesClientCreateOrUpdateResponse struct {
	BaseAdminRuleClassification
}

AdminRulesClientCreateOrUpdateResponse contains the response from method AdminRulesClient.CreateOrUpdate.

func (*AdminRulesClientCreateOrUpdateResponse) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AdminRulesClientCreateOrUpdateResponse.

type AdminRulesClientDeleteResponse

type AdminRulesClientDeleteResponse struct {
}

AdminRulesClientDeleteResponse contains the response from method AdminRulesClient.Delete.

type AdminRulesClientGetOptions

type AdminRulesClientGetOptions struct {
}

AdminRulesClientGetOptions contains the optional parameters for the AdminRulesClient.Get method.

type AdminRulesClientGetResponse

type AdminRulesClientGetResponse struct {
	BaseAdminRuleClassification
}

AdminRulesClientGetResponse contains the response from method AdminRulesClient.Get.

func (*AdminRulesClientGetResponse) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AdminRulesClientGetResponse.

type AdminRulesClientListOptions

type AdminRulesClientListOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

AdminRulesClientListOptions contains the optional parameters for the AdminRulesClient.List method.

type AdminRulesClientListResponse

type AdminRulesClientListResponse struct {
	AdminRuleListResult
}

AdminRulesClientListResponse contains the response from method AdminRulesClient.List.

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.

func (*ApplicationGateway) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayAuthenticationCertificate) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayAuthenticationCertificate.

func (*ApplicationGatewayAuthenticationCertificate) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayAuthenticationCertificate.

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.

func (ApplicationGatewayAuthenticationCertificatePropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayAuthenticationCertificatePropertiesFormat.

func (*ApplicationGatewayAuthenticationCertificatePropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayAuthenticationCertificatePropertiesFormat.

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.

func (ApplicationGatewayAutoscaleConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayAutoscaleConfiguration.

func (*ApplicationGatewayAutoscaleConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayAutoscaleConfiguration.

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.

func (*ApplicationGatewayAvailableSSLOptions) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayAvailableSSLOptionsPropertiesFormat.

func (*ApplicationGatewayAvailableSSLOptionsPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayAvailableSSLPredefinedPolicies.

func (*ApplicationGatewayAvailableSSLPredefinedPolicies) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayAvailableWafRuleSetsResult.

func (*ApplicationGatewayAvailableWafRuleSetsResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayBackendAddress) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendAddress.

func (*ApplicationGatewayBackendAddress) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayBackendAddress.

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.

func (ApplicationGatewayBackendAddressPool) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendAddressPool.

func (*ApplicationGatewayBackendAddressPool) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayBackendAddressPool.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendAddressPoolPropertiesFormat.

func (*ApplicationGatewayBackendAddressPoolPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayBackendHTTPSettings) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendHTTPSettings.

func (*ApplicationGatewayBackendHTTPSettings) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayBackendHTTPSettings.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendHTTPSettingsPropertiesFormat.

func (*ApplicationGatewayBackendHTTPSettingsPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ApplicationGatewayBackendHealth) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendHealthHTTPSettings.

func (*ApplicationGatewayBackendHealthHTTPSettings) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayBackendHealthOnDemand) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendHealthOnDemand.

func (*ApplicationGatewayBackendHealthOnDemand) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayBackendHealthOnDemand.

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.

func (*ApplicationGatewayBackendHealthPool) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayBackendHealthServer) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendHealthServer.

func (*ApplicationGatewayBackendHealthServer) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayBackendHealthServer.

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.

type ApplicationGatewayBackendSettings

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

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

	// Properties of the application gateway backend settings.
	Properties *ApplicationGatewayBackendSettingsPropertiesFormat `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"`
}

ApplicationGatewayBackendSettings - Backend address pool settings of an application gateway.

func (ApplicationGatewayBackendSettings) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendSettings.

func (*ApplicationGatewayBackendSettings) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayBackendSettings.

type ApplicationGatewayBackendSettingsPropertiesFormat

type ApplicationGatewayBackendSettingsPropertiesFormat struct {
	// Server name indication to be sent to the backend servers for Tls protocol.
	HostName *string `json:"hostName,omitempty"`

	// Whether to pick server name indication from the host name of the backend server for Tls protocol. 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"`

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

	// Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout.
	// Acceptable values are from 1 second to 86400 seconds.
	Timeout *int32 `json:"timeout,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"`
}

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

func (ApplicationGatewayBackendSettingsPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayBackendSettingsPropertiesFormat.

func (*ApplicationGatewayBackendSettingsPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayBackendSettingsPropertiesFormat.

type ApplicationGatewayClientAuthConfiguration

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

	// Verify client certificate revocation status.
	VerifyClientRevocation *ApplicationGatewayClientRevocationOptions `json:"verifyClientRevocation,omitempty"`
}

ApplicationGatewayClientAuthConfiguration - Application gateway client authentication configuration.

func (ApplicationGatewayClientAuthConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayClientAuthConfiguration.

func (*ApplicationGatewayClientAuthConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayClientAuthConfiguration.

type ApplicationGatewayClientRevocationOptions

type ApplicationGatewayClientRevocationOptions string

ApplicationGatewayClientRevocationOptions - Verify client certificate revocation status.

const (
	ApplicationGatewayClientRevocationOptionsNone ApplicationGatewayClientRevocationOptions = "None"
	ApplicationGatewayClientRevocationOptionsOCSP ApplicationGatewayClientRevocationOptions = "OCSP"
)

func PossibleApplicationGatewayClientRevocationOptionsValues

func PossibleApplicationGatewayClientRevocationOptionsValues() []ApplicationGatewayClientRevocationOptions

PossibleApplicationGatewayClientRevocationOptionsValues returns the possible values for the ApplicationGatewayClientRevocationOptions const type.

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.

func (ApplicationGatewayConnectionDraining) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayConnectionDraining.

func (*ApplicationGatewayConnectionDraining) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayConnectionDraining.

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.

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.

func (ApplicationGatewayCustomError) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayCustomError.

func (*ApplicationGatewayCustomError) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayCustomError.

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.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFirewallDisabledRuleGroup.

func (*ApplicationGatewayFirewallDisabledRuleGroup) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayFirewallExclusion) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFirewallExclusion.

func (*ApplicationGatewayFirewallExclusion) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayFirewallExclusion.

type ApplicationGatewayFirewallManifestRuleSet

type ApplicationGatewayFirewallManifestRuleSet 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"`

	// The rule set status
	Status *ApplicationGatewayRuleSetStatusOptions `json:"status,omitempty"`

	// Tier of an application gateway that support the rule set.
	Tiers []*ApplicationGatewayTierTypes `json:"tiers,omitempty"`
}

ApplicationGatewayFirewallManifestRuleSet - Properties of the web application firewall rule set.

func (ApplicationGatewayFirewallManifestRuleSet) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFirewallManifestRuleSet.

func (*ApplicationGatewayFirewallManifestRuleSet) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayFirewallManifestRuleSet.

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.

type ApplicationGatewayFirewallRule

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

	// The string representation of the web application firewall rule action.
	Action *ApplicationGatewayWafRuleActionTypes `json:"action,omitempty"`

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

	// The string representation of the web application firewall rule identifier.
	RuleIDString *string `json:"ruleIdString,omitempty"`

	// The string representation of the web application firewall rule state.
	State *ApplicationGatewayWafRuleStateTypes `json:"state,omitempty"`
}

ApplicationGatewayFirewallRule - A web application firewall rule.

func (ApplicationGatewayFirewallRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFirewallRule.

func (*ApplicationGatewayFirewallRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayFirewallRule.

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.

func (*ApplicationGatewayFirewallRuleGroup) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ApplicationGatewayFirewallRuleSet) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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"`

	// Tier of an application gateway that support the rule set.
	Tiers []*ApplicationGatewayTierTypes `json:"tiers,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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFirewallRuleSetPropertiesFormat.

func (*ApplicationGatewayFirewallRuleSetPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayFrontendIPConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFrontendIPConfiguration.

func (*ApplicationGatewayFrontendIPConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayFrontendIPConfiguration.

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.

func (ApplicationGatewayFrontendIPConfigurationPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFrontendIPConfigurationPropertiesFormat.

func (*ApplicationGatewayFrontendIPConfigurationPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayFrontendIPConfigurationPropertiesFormat.

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.

func (ApplicationGatewayFrontendPort) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFrontendPort.

func (*ApplicationGatewayFrontendPort) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayFrontendPort.

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.

func (ApplicationGatewayFrontendPortPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayFrontendPortPropertiesFormat.

func (*ApplicationGatewayFrontendPortPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayFrontendPortPropertiesFormat.

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.

func (ApplicationGatewayGlobalConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayGlobalConfiguration.

func (*ApplicationGatewayGlobalConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayGlobalConfiguration.

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.

func (ApplicationGatewayHTTPListener) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayHTTPListener.

func (*ApplicationGatewayHTTPListener) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayHTTPListener.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayHTTPListenerPropertiesFormat.

func (*ApplicationGatewayHTTPListenerPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayHeaderConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayHeaderConfiguration.

func (*ApplicationGatewayHeaderConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayHeaderConfiguration.

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.

func (ApplicationGatewayIPConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayIPConfiguration.

func (*ApplicationGatewayIPConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayIPConfiguration.

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.

func (ApplicationGatewayIPConfigurationPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayIPConfigurationPropertiesFormat.

func (*ApplicationGatewayIPConfigurationPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayIPConfigurationPropertiesFormat.

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.

func (*ApplicationGatewayListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayListResult.

type ApplicationGatewayListener

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

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

	// Properties of the application gateway listener.
	Properties *ApplicationGatewayListenerPropertiesFormat `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"`
}

ApplicationGatewayListener - Listener of an application gateway.

func (ApplicationGatewayListener) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayListener.

func (*ApplicationGatewayListener) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayListener.

type ApplicationGatewayListenerPropertiesFormat

type ApplicationGatewayListenerPropertiesFormat struct {
	// 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"`

	// Protocol of the listener.
	Protocol *ApplicationGatewayProtocol `json:"protocol,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 listener resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ApplicationGatewayListenerPropertiesFormat - Properties of listener of an application gateway.

func (ApplicationGatewayListenerPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayListenerPropertiesFormat.

func (*ApplicationGatewayListenerPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayListenerPropertiesFormat.

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.

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.

func (ApplicationGatewayLoadDistributionPolicy) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayLoadDistributionPolicy.

func (*ApplicationGatewayLoadDistributionPolicy) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayLoadDistributionPolicy.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayLoadDistributionPolicyPropertiesFormat.

func (*ApplicationGatewayLoadDistributionPolicyPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayLoadDistributionTarget) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayLoadDistributionTarget.

func (*ApplicationGatewayLoadDistributionTarget) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayLoadDistributionTarget.

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

func (ApplicationGatewayLoadDistributionTargetPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayLoadDistributionTargetPropertiesFormat.

func (*ApplicationGatewayLoadDistributionTargetPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayLoadDistributionTargetPropertiesFormat.

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.

func (ApplicationGatewayOnDemandProbe) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayOnDemandProbe.

func (*ApplicationGatewayOnDemandProbe) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayOnDemandProbe.

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.

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.

func (ApplicationGatewayPathRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPathRule.

func (*ApplicationGatewayPathRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayPathRule.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPathRulePropertiesFormat.

func (*ApplicationGatewayPathRulePropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayPrivateEndpointConnection) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateEndpointConnection.

func (*ApplicationGatewayPrivateEndpointConnection) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayPrivateEndpointConnection.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateEndpointConnectionListResult.

func (*ApplicationGatewayPrivateEndpointConnectionListResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayPrivateEndpointConnectionProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateEndpointConnectionProperties.

func (*ApplicationGatewayPrivateEndpointConnectionProperties) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayPrivateEndpointConnectionProperties.

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, error)

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

BeginDelete - Deletes the specified private endpoint connection on application gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewayPrivateEndpointConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "appgw", "connection1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ApplicationGatewayPrivateEndpointConnectionsClient) BeginUpdate

BeginUpdate - Updates the specified private endpoint connection on application gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewayPrivateEndpointConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdate(ctx, "rg1", "appgw", "connection1", armnetwork.ApplicationGatewayPrivateEndpointConnection{
	Name: to.Ptr("connection1"),
	Properties: &armnetwork.ApplicationGatewayPrivateEndpointConnectionProperties{
		PrivateEndpoint: &armnetwork.PrivateEndpoint{
			ID: to.Ptr("/subscriptions/subId2/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe"),
		},
		PrivateLinkServiceConnectionState: &armnetwork.PrivateLinkServiceConnectionState{
			Description: to.Ptr("approved it for some reason."),
			Status:      to.Ptr("Approved"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewayPrivateEndpointConnectionsClient) Get

Get - Gets the specified private endpoint connection on application gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewayPrivateEndpointConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "appgw", "connection1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewayPrivateEndpointConnectionsClient) NewListPager

NewListPager - Lists all private endpoint connections on an application gateway. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewayPrivateEndpointConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "appgw", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ApplicationGatewayPrivateEndpointConnectionsClientBeginDeleteOptions

type ApplicationGatewayPrivateEndpointConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

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

type ApplicationGatewayPrivateEndpointConnectionsClientBeginUpdateOptions

type ApplicationGatewayPrivateEndpointConnectionsClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

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

type ApplicationGatewayPrivateEndpointConnectionsClientDeleteResponse

type ApplicationGatewayPrivateEndpointConnectionsClientDeleteResponse struct {
}

ApplicationGatewayPrivateEndpointConnectionsClientDeleteResponse contains the response from method ApplicationGatewayPrivateEndpointConnectionsClient.Delete.

type ApplicationGatewayPrivateEndpointConnectionsClientGetOptions

type ApplicationGatewayPrivateEndpointConnectionsClientGetOptions struct {
}

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

type ApplicationGatewayPrivateEndpointConnectionsClientGetResponse

type ApplicationGatewayPrivateEndpointConnectionsClientGetResponse struct {
	ApplicationGatewayPrivateEndpointConnection
}

ApplicationGatewayPrivateEndpointConnectionsClientGetResponse contains the response from method ApplicationGatewayPrivateEndpointConnectionsClient.Get.

type ApplicationGatewayPrivateEndpointConnectionsClientListOptions

type ApplicationGatewayPrivateEndpointConnectionsClientListOptions struct {
}

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

type ApplicationGatewayPrivateEndpointConnectionsClientListResponse

type ApplicationGatewayPrivateEndpointConnectionsClientListResponse struct {
	ApplicationGatewayPrivateEndpointConnectionListResult
}

ApplicationGatewayPrivateEndpointConnectionsClientListResponse contains the response from method ApplicationGatewayPrivateEndpointConnectionsClient.List.

type ApplicationGatewayPrivateEndpointConnectionsClientUpdateResponse

type ApplicationGatewayPrivateEndpointConnectionsClientUpdateResponse struct {
	ApplicationGatewayPrivateEndpointConnection
}

ApplicationGatewayPrivateEndpointConnectionsClientUpdateResponse contains the response 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.

func (ApplicationGatewayPrivateLinkConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateLinkConfiguration.

func (*ApplicationGatewayPrivateLinkConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayPrivateLinkConfiguration.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateLinkConfigurationProperties.

func (*ApplicationGatewayPrivateLinkConfigurationProperties) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayPrivateLinkIPConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateLinkIPConfiguration.

func (*ApplicationGatewayPrivateLinkIPConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayPrivateLinkIPConfiguration.

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.

func (ApplicationGatewayPrivateLinkIPConfigurationProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateLinkIPConfigurationProperties.

func (*ApplicationGatewayPrivateLinkIPConfigurationProperties) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayPrivateLinkIPConfigurationProperties.

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.

func (ApplicationGatewayPrivateLinkResource) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateLinkResource.

func (*ApplicationGatewayPrivateLinkResource) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayPrivateLinkResource.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateLinkResourceListResult.

func (*ApplicationGatewayPrivateLinkResourceListResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayPrivateLinkResourceProperties.

func (*ApplicationGatewayPrivateLinkResourceProperties) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) NewListPager

NewListPager - Lists all private link resources on an application gateway. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayPrivateLinkResourceList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewayPrivateLinkResourcesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "appgw", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ApplicationGatewayPrivateLinkResourcesClientListOptions

type ApplicationGatewayPrivateLinkResourcesClientListOptions struct {
}

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

type ApplicationGatewayPrivateLinkResourcesClientListResponse

type ApplicationGatewayPrivateLinkResourcesClientListResponse struct {
	ApplicationGatewayPrivateLinkResourceListResult
}

ApplicationGatewayPrivateLinkResourcesClientListResponse contains the response 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.

func (ApplicationGatewayProbe) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayProbe.

func (*ApplicationGatewayProbe) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayProbe.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayProbeHealthResponseMatch.

func (*ApplicationGatewayProbeHealthResponseMatch) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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"`

	// Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false.
	PickHostNameFromBackendSettings *bool `json:"pickHostNameFromBackendSettings,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.

func (ApplicationGatewayProbePropertiesFormat) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayProbePropertiesFormat.

func (*ApplicationGatewayProbePropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayProbePropertiesFormat.

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

	// Backend 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]
	// .
	BackendSettingsCollection []*ApplicationGatewayBackendSettings `json:"backendSettingsCollection,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"`

	// 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].
	Listeners []*ApplicationGatewayListener `json:"listeners,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"`

	// Routing rules of the application gateway resource.
	RoutingRules []*ApplicationGatewayRoutingRule `json:"routingRules,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.

func (*ApplicationGatewayPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayPropertiesFormat.

type ApplicationGatewayProtocol

type ApplicationGatewayProtocol string

ApplicationGatewayProtocol - Application Gateway protocol.

const (
	ApplicationGatewayProtocolHTTP  ApplicationGatewayProtocol = "Http"
	ApplicationGatewayProtocolHTTPS ApplicationGatewayProtocol = "Https"
	ApplicationGatewayProtocolTCP   ApplicationGatewayProtocol = "Tcp"
	ApplicationGatewayProtocolTLS   ApplicationGatewayProtocol = "Tls"
)

func PossibleApplicationGatewayProtocolValues

func PossibleApplicationGatewayProtocolValues() []ApplicationGatewayProtocol

PossibleApplicationGatewayProtocolValues returns the possible values for the ApplicationGatewayProtocol const type.

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.

func (ApplicationGatewayRedirectConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRedirectConfiguration.

func (*ApplicationGatewayRedirectConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayRedirectConfiguration.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRedirectConfigurationPropertiesFormat.

func (*ApplicationGatewayRedirectConfigurationPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (ApplicationGatewayRequestRoutingRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRequestRoutingRule.

func (*ApplicationGatewayRequestRoutingRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayRequestRoutingRule.

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.

func (ApplicationGatewayRequestRoutingRulePropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRequestRoutingRulePropertiesFormat.

func (*ApplicationGatewayRequestRoutingRulePropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayRequestRoutingRulePropertiesFormat.

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.

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.

func (*ApplicationGatewayRewriteRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ApplicationGatewayRewriteRuleActionSet) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewayRewriteRuleCondition) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRewriteRuleCondition.

func (*ApplicationGatewayRewriteRuleCondition) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayRewriteRuleCondition.

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.

func (ApplicationGatewayRewriteRuleSet) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRewriteRuleSet.

func (*ApplicationGatewayRewriteRuleSet) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayRewriteRuleSet.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRewriteRuleSetPropertiesFormat.

func (*ApplicationGatewayRewriteRuleSetPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayRewriteRuleSetPropertiesFormat.

type ApplicationGatewayRoutingRule

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

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

	// Properties of the application gateway routing rule.
	Properties *ApplicationGatewayRoutingRulePropertiesFormat `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"`
}

ApplicationGatewayRoutingRule - Routing rule of an application gateway.

func (ApplicationGatewayRoutingRule) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRoutingRule.

func (*ApplicationGatewayRoutingRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayRoutingRule.

type ApplicationGatewayRoutingRulePropertiesFormat

type ApplicationGatewayRoutingRulePropertiesFormat struct {
	// REQUIRED; Priority of the routing rule.
	Priority *int32 `json:"priority,omitempty"`

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

	// Backend settings resource of the application gateway.
	BackendSettings *SubResource `json:"backendSettings,omitempty"`

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

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

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

ApplicationGatewayRoutingRulePropertiesFormat - Properties of routing rule of the application gateway.

func (ApplicationGatewayRoutingRulePropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayRoutingRulePropertiesFormat.

func (*ApplicationGatewayRoutingRulePropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayRoutingRulePropertiesFormat.

type ApplicationGatewayRuleSetStatusOptions

type ApplicationGatewayRuleSetStatusOptions string

ApplicationGatewayRuleSetStatusOptions - The rule set status

const (
	ApplicationGatewayRuleSetStatusOptionsDeprecated ApplicationGatewayRuleSetStatusOptions = "Deprecated"
	ApplicationGatewayRuleSetStatusOptionsGA         ApplicationGatewayRuleSetStatusOptions = "GA"
	ApplicationGatewayRuleSetStatusOptionsPreview    ApplicationGatewayRuleSetStatusOptions = "Preview"
	ApplicationGatewayRuleSetStatusOptionsSupported  ApplicationGatewayRuleSetStatusOptions = "Supported"
)

func PossibleApplicationGatewayRuleSetStatusOptionsValues

func PossibleApplicationGatewayRuleSetStatusOptionsValues() []ApplicationGatewayRuleSetStatusOptions

PossibleApplicationGatewayRuleSetStatusOptionsValues returns the possible values for the ApplicationGatewayRuleSetStatusOptions const type.

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.

func (ApplicationGatewaySKU) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewaySKU.

func (*ApplicationGatewaySKU) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewaySKU.

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.

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.

func (ApplicationGatewaySSLCertificate) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewaySSLCertificate.

func (*ApplicationGatewaySSLCertificate) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewaySSLCertificate.

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.

func (ApplicationGatewaySSLCertificatePropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewaySSLCertificatePropertiesFormat.

func (*ApplicationGatewaySSLCertificatePropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewaySSLCertificatePropertiesFormat.

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.

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.

func (*ApplicationGatewaySSLPolicy) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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"
	ApplicationGatewaySSLPolicyNameAppGwSSLPolicy20220101  ApplicationGatewaySSLPolicyName = "AppGwSslPolicy20220101"
	ApplicationGatewaySSLPolicyNameAppGwSSLPolicy20220101S ApplicationGatewaySSLPolicyName = "AppGwSslPolicy20220101S"
)

func PossibleApplicationGatewaySSLPolicyNameValues

func PossibleApplicationGatewaySSLPolicyNameValues() []ApplicationGatewaySSLPolicyName

PossibleApplicationGatewaySSLPolicyNameValues returns the possible values for the ApplicationGatewaySSLPolicyName const type.

type ApplicationGatewaySSLPolicyType

type ApplicationGatewaySSLPolicyType string

ApplicationGatewaySSLPolicyType - Type of Ssl Policy.

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

func PossibleApplicationGatewaySSLPolicyTypeValues

func PossibleApplicationGatewaySSLPolicyTypeValues() []ApplicationGatewaySSLPolicyType

PossibleApplicationGatewaySSLPolicyTypeValues returns the possible values for the ApplicationGatewaySSLPolicyType const type.

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.

func (ApplicationGatewaySSLPredefinedPolicy) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewaySSLPredefinedPolicy.

func (*ApplicationGatewaySSLPredefinedPolicy) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewaySSLPredefinedPolicy.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewaySSLPredefinedPolicyPropertiesFormat.

func (*ApplicationGatewaySSLPredefinedPolicyPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationGatewaySSLProfile) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewaySSLProfile.

func (*ApplicationGatewaySSLProfile) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewaySSLProfile.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewaySSLProfilePropertiesFormat.

func (*ApplicationGatewaySSLProfilePropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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"
	ApplicationGatewaySSLProtocolTLSv13 ApplicationGatewaySSLProtocol = "TLSv1_3"
)

func PossibleApplicationGatewaySSLProtocolValues

func PossibleApplicationGatewaySSLProtocolValues() []ApplicationGatewaySSLProtocol

PossibleApplicationGatewaySSLProtocolValues returns the possible values for the ApplicationGatewaySSLProtocol const type.

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.

type ApplicationGatewayTierTypes

type ApplicationGatewayTierTypes string
const (
	ApplicationGatewayTierTypesStandard   ApplicationGatewayTierTypes = "Standard"
	ApplicationGatewayTierTypesStandardV2 ApplicationGatewayTierTypes = "Standard_v2"
	ApplicationGatewayTierTypesWAF        ApplicationGatewayTierTypes = "WAF"
	ApplicationGatewayTierTypesWAFV2      ApplicationGatewayTierTypes = "WAF_v2"
)

func PossibleApplicationGatewayTierTypesValues

func PossibleApplicationGatewayTierTypesValues() []ApplicationGatewayTierTypes

PossibleApplicationGatewayTierTypesValues returns the possible values for the ApplicationGatewayTierTypes const type.

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.

func (ApplicationGatewayTrustedClientCertificate) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayTrustedClientCertificate.

func (*ApplicationGatewayTrustedClientCertificate) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayTrustedClientCertificate.

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.

func (ApplicationGatewayTrustedClientCertificatePropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayTrustedClientCertificatePropertiesFormat.

func (*ApplicationGatewayTrustedClientCertificatePropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayTrustedClientCertificatePropertiesFormat.

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.

func (ApplicationGatewayTrustedRootCertificate) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayTrustedRootCertificate.

func (*ApplicationGatewayTrustedRootCertificate) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayTrustedRootCertificate.

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.

func (ApplicationGatewayTrustedRootCertificatePropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayTrustedRootCertificatePropertiesFormat.

func (*ApplicationGatewayTrustedRootCertificatePropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayTrustedRootCertificatePropertiesFormat.

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.

func (ApplicationGatewayURLConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayURLConfiguration.

func (*ApplicationGatewayURLConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayURLConfiguration.

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.

func (ApplicationGatewayURLPathMap) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayURLPathMap.

func (*ApplicationGatewayURLPathMap) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayURLPathMap.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayURLPathMapPropertiesFormat.

func (*ApplicationGatewayURLPathMapPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayURLPathMapPropertiesFormat.

type ApplicationGatewayWafDynamicManifestPropertiesResult

type ApplicationGatewayWafDynamicManifestPropertiesResult struct {
	// The available rulesets.
	AvailableRuleSets []*ApplicationGatewayFirewallManifestRuleSet `json:"availableRuleSets,omitempty"`

	// The default ruleset.
	DefaultRuleSet *DefaultRuleSetPropertyFormat `json:"defaultRuleSet,omitempty"`
}

ApplicationGatewayWafDynamicManifestPropertiesResult - Properties of ApplicationGatewayWafDynamicManifest.

func (ApplicationGatewayWafDynamicManifestPropertiesResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayWafDynamicManifestPropertiesResult.

func (*ApplicationGatewayWafDynamicManifestPropertiesResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayWafDynamicManifestPropertiesResult.

type ApplicationGatewayWafDynamicManifestResult

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

	// Properties of the ApplicationGatewayWafDynamicManifest .
	Properties *ApplicationGatewayWafDynamicManifestPropertiesResult `json:"properties,omitempty"`

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

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

ApplicationGatewayWafDynamicManifestResult - Response for ApplicationGatewayWafDynamicManifest API service call.

func (ApplicationGatewayWafDynamicManifestResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayWafDynamicManifestResult.

func (*ApplicationGatewayWafDynamicManifestResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayWafDynamicManifestResult.

type ApplicationGatewayWafDynamicManifestResultList

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

	// The list of application gateway waf manifest.
	Value []*ApplicationGatewayWafDynamicManifestResult `json:"value,omitempty"`
}

ApplicationGatewayWafDynamicManifestResultList - Response for ApplicationGatewayWafDynamicManifests API service call.

func (ApplicationGatewayWafDynamicManifestResultList) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayWafDynamicManifestResultList.

func (*ApplicationGatewayWafDynamicManifestResultList) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGatewayWafDynamicManifestResultList.

type ApplicationGatewayWafDynamicManifestsClient

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

ApplicationGatewayWafDynamicManifestsClient contains the methods for the ApplicationGatewayWafDynamicManifests group. Don't use this type directly, use NewApplicationGatewayWafDynamicManifestsClient() instead.

func NewApplicationGatewayWafDynamicManifestsClient

func NewApplicationGatewayWafDynamicManifestsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ApplicationGatewayWafDynamicManifestsClient, error)

NewApplicationGatewayWafDynamicManifestsClient creates a new instance of ApplicationGatewayWafDynamicManifestsClient 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 (*ApplicationGatewayWafDynamicManifestsClient) NewGetPager

NewGetPager - Gets the regional application gateway waf manifest. Generated from API version 2022-05-01 location - The region where the nrp are located at. options - ApplicationGatewayWafDynamicManifestsClientGetOptions contains the optional parameters for the ApplicationGatewayWafDynamicManifestsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/GetApplicationGatewayWafDynamicManifests.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewayWafDynamicManifestsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewGetPager("westus", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ApplicationGatewayWafDynamicManifestsClientGetOptions

type ApplicationGatewayWafDynamicManifestsClientGetOptions struct {
}

ApplicationGatewayWafDynamicManifestsClientGetOptions contains the optional parameters for the ApplicationGatewayWafDynamicManifestsClient.Get method.

type ApplicationGatewayWafDynamicManifestsClientGetResponse

type ApplicationGatewayWafDynamicManifestsClientGetResponse struct {
	ApplicationGatewayWafDynamicManifestResultList
}

ApplicationGatewayWafDynamicManifestsClientGetResponse contains the response from method ApplicationGatewayWafDynamicManifestsClient.Get.

type ApplicationGatewayWafDynamicManifestsDefaultClient

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

ApplicationGatewayWafDynamicManifestsDefaultClient contains the methods for the ApplicationGatewayWafDynamicManifestsDefault group. Don't use this type directly, use NewApplicationGatewayWafDynamicManifestsDefaultClient() instead.

func NewApplicationGatewayWafDynamicManifestsDefaultClient

func NewApplicationGatewayWafDynamicManifestsDefaultClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ApplicationGatewayWafDynamicManifestsDefaultClient, error)

NewApplicationGatewayWafDynamicManifestsDefaultClient creates a new instance of ApplicationGatewayWafDynamicManifestsDefaultClient 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 (*ApplicationGatewayWafDynamicManifestsDefaultClient) Get

Get - Gets the regional application gateway waf manifest. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 location - The region where the nrp are located at. options - ApplicationGatewayWafDynamicManifestsDefaultClientGetOptions contains the optional parameters for the ApplicationGatewayWafDynamicManifestsDefaultClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewayWafDynamicManifestsDefaultClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "westus", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ApplicationGatewayWafDynamicManifestsDefaultClientGetOptions

type ApplicationGatewayWafDynamicManifestsDefaultClientGetOptions struct {
}

ApplicationGatewayWafDynamicManifestsDefaultClientGetOptions contains the optional parameters for the ApplicationGatewayWafDynamicManifestsDefaultClient.Get method.

type ApplicationGatewayWafDynamicManifestsDefaultClientGetResponse

type ApplicationGatewayWafDynamicManifestsDefaultClientGetResponse struct {
	ApplicationGatewayWafDynamicManifestResult
}

ApplicationGatewayWafDynamicManifestsDefaultClientGetResponse contains the response from method ApplicationGatewayWafDynamicManifestsDefaultClient.Get.

type ApplicationGatewayWafRuleActionTypes

type ApplicationGatewayWafRuleActionTypes string

ApplicationGatewayWafRuleActionTypes - The string representation of the web application firewall rule action.

const (
	ApplicationGatewayWafRuleActionTypesAllow          ApplicationGatewayWafRuleActionTypes = "Allow"
	ApplicationGatewayWafRuleActionTypesAnomalyScoring ApplicationGatewayWafRuleActionTypes = "AnomalyScoring"
	ApplicationGatewayWafRuleActionTypesBlock          ApplicationGatewayWafRuleActionTypes = "Block"
	ApplicationGatewayWafRuleActionTypesLog            ApplicationGatewayWafRuleActionTypes = "Log"
	ApplicationGatewayWafRuleActionTypesNone           ApplicationGatewayWafRuleActionTypes = "None"
)

func PossibleApplicationGatewayWafRuleActionTypesValues

func PossibleApplicationGatewayWafRuleActionTypesValues() []ApplicationGatewayWafRuleActionTypes

PossibleApplicationGatewayWafRuleActionTypesValues returns the possible values for the ApplicationGatewayWafRuleActionTypes const type.

type ApplicationGatewayWafRuleStateTypes

type ApplicationGatewayWafRuleStateTypes string

ApplicationGatewayWafRuleStateTypes - The string representation of the web application firewall rule state.

const (
	ApplicationGatewayWafRuleStateTypesDisabled ApplicationGatewayWafRuleStateTypes = "Disabled"
	ApplicationGatewayWafRuleStateTypesEnabled  ApplicationGatewayWafRuleStateTypes = "Enabled"
)

func PossibleApplicationGatewayWafRuleStateTypesValues

func PossibleApplicationGatewayWafRuleStateTypesValues() []ApplicationGatewayWafRuleStateTypes

PossibleApplicationGatewayWafRuleStateTypesValues returns the possible values for the ApplicationGatewayWafRuleStateTypes const type.

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGatewayWebApplicationFirewallConfiguration.

func (*ApplicationGatewayWebApplicationFirewallConfiguration) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

BeginBackendHealth - Gets the backend health of the specified application gateway in a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayBackendHealthGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginBackendHealth(ctx, "appgw", "appgw", &armnetwork.ApplicationGatewaysClientBeginBackendHealthOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewaysClient) BeginBackendHealthOnDemand

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayBackendHealthTest.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginBackendHealthOnDemand(ctx, "rg1", "appgw", armnetwork.ApplicationGatewayOnDemandProbe{
	Path: to.Ptr("/"),
	BackendAddressPool: &armnetwork.SubResource{
		ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool"),
	},
	BackendHTTPSettings: &armnetwork.SubResource{
		ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings"),
	},
	PickHostNameFromBackendHTTPSettings: to.Ptr(true),
	Timeout:                             to.Ptr[int32](30),
	Protocol:                            to.Ptr(armnetwork.ApplicationGatewayProtocolHTTP),
}, &armnetwork.ApplicationGatewaysClientBeginBackendHealthOnDemandOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewaysClient) BeginCreateOrUpdate

BeginCreateOrUpdate - Creates or updates the specified application gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "appgw", armnetwork.ApplicationGateway{
	Location: to.Ptr("eastus"),
	Identity: &armnetwork.ManagedServiceIdentity{
		Type: to.Ptr(armnetwork.ResourceIdentityTypeUserAssigned),
		UserAssignedIdentities: map[string]*armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
			"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {},
		},
	},
	Properties: &armnetwork.ApplicationGatewayPropertiesFormat{
		BackendAddressPools: []*armnetwork.ApplicationGatewayBackendAddressPool{
			{
				Name: to.Ptr("appgwpool"),
				Properties: &armnetwork.ApplicationGatewayBackendAddressPoolPropertiesFormat{
					BackendAddresses: []*armnetwork.ApplicationGatewayBackendAddress{
						{
							IPAddress: to.Ptr("10.0.1.1"),
						},
						{
							IPAddress: to.Ptr("10.0.1.2"),
						}},
				},
			},
			{
				ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1"),
				Name: to.Ptr("appgwpool1"),
				Properties: &armnetwork.ApplicationGatewayBackendAddressPoolPropertiesFormat{
					BackendAddresses: []*armnetwork.ApplicationGatewayBackendAddress{
						{},
						{}},
				},
			}},
		BackendHTTPSettingsCollection: []*armnetwork.ApplicationGatewayBackendHTTPSettings{
			{
				Name: to.Ptr("appgwbhs"),
				Properties: &armnetwork.ApplicationGatewayBackendHTTPSettingsPropertiesFormat{
					CookieBasedAffinity: to.Ptr(armnetwork.ApplicationGatewayCookieBasedAffinityDisabled),
					Port:                to.Ptr[int32](80),
					RequestTimeout:      to.Ptr[int32](30),
					Protocol:            to.Ptr(armnetwork.ApplicationGatewayProtocolHTTP),
				},
			}},
		FrontendIPConfigurations: []*armnetwork.ApplicationGatewayFrontendIPConfiguration{
			{
				Name: to.Ptr("appgwfip"),
				Properties: &armnetwork.ApplicationGatewayFrontendIPConfigurationPropertiesFormat{
					PublicIPAddress: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip"),
					},
				},
			}},
		FrontendPorts: []*armnetwork.ApplicationGatewayFrontendPort{
			{
				Name: to.Ptr("appgwfp"),
				Properties: &armnetwork.ApplicationGatewayFrontendPortPropertiesFormat{
					Port: to.Ptr[int32](443),
				},
			},
			{
				Name: to.Ptr("appgwfp80"),
				Properties: &armnetwork.ApplicationGatewayFrontendPortPropertiesFormat{
					Port: to.Ptr[int32](80),
				},
			}},
		GatewayIPConfigurations: []*armnetwork.ApplicationGatewayIPConfiguration{
			{
				Name: to.Ptr("appgwipc"),
				Properties: &armnetwork.ApplicationGatewayIPConfigurationPropertiesFormat{
					Subnet: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet"),
					},
				},
			}},
		GlobalConfiguration: &armnetwork.ApplicationGatewayGlobalConfiguration{
			EnableRequestBuffering:  to.Ptr(true),
			EnableResponseBuffering: to.Ptr(true),
		},
		HTTPListeners: []*armnetwork.ApplicationGatewayHTTPListener{
			{
				Name: to.Ptr("appgwhl"),
				Properties: &armnetwork.ApplicationGatewayHTTPListenerPropertiesFormat{
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"),
					},
					FrontendPort: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"),
					},
					RequireServerNameIndication: to.Ptr(false),
					SSLCertificate: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"),
					},
					SSLProfile: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1"),
					},
					Protocol: to.Ptr(armnetwork.ApplicationGatewayProtocolHTTPS),
				},
			},
			{
				Name: to.Ptr("appgwhttplistener"),
				Properties: &armnetwork.ApplicationGatewayHTTPListenerPropertiesFormat{
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"),
					},
					FrontendPort: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"),
					},
					Protocol: to.Ptr(armnetwork.ApplicationGatewayProtocolHTTP),
				},
			}},
		LoadDistributionPolicies: []*armnetwork.ApplicationGatewayLoadDistributionPolicy{
			{
				Name: to.Ptr("ldp1"),
				Properties: &armnetwork.ApplicationGatewayLoadDistributionPolicyPropertiesFormat{
					LoadDistributionAlgorithm: to.Ptr(armnetwork.ApplicationGatewayLoadDistributionAlgorithmRoundRobin),
					LoadDistributionTargets: []*armnetwork.ApplicationGatewayLoadDistributionTarget{
						{
							Name: to.Ptr("ld11"),
							Properties: &armnetwork.ApplicationGatewayLoadDistributionTargetPropertiesFormat{
								BackendAddressPool: &armnetwork.SubResource{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"),
								},
								WeightPerServer: to.Ptr[int32](40),
							},
						},
						{
							Name: to.Ptr("ld11"),
							Properties: &armnetwork.ApplicationGatewayLoadDistributionTargetPropertiesFormat{
								BackendAddressPool: &armnetwork.SubResource{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1"),
								},
								WeightPerServer: to.Ptr[int32](60),
							},
						}},
				},
			}},
		RequestRoutingRules: []*armnetwork.ApplicationGatewayRequestRoutingRule{
			{
				Name: to.Ptr("appgwrule"),
				Properties: &armnetwork.ApplicationGatewayRequestRoutingRulePropertiesFormat{
					BackendAddressPool: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"),
					},
					BackendHTTPSettings: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"),
					},
					HTTPListener: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"),
					},
					LoadDistributionPolicy: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"),
					},
					Priority: to.Ptr[int32](10),
					RewriteRuleSet: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"),
					},
					RuleType: to.Ptr(armnetwork.ApplicationGatewayRequestRoutingRuleTypeBasic),
				},
			},
			{
				Name: to.Ptr("appgwPathBasedRule"),
				Properties: &armnetwork.ApplicationGatewayRequestRoutingRulePropertiesFormat{
					HTTPListener: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener"),
					},
					Priority: to.Ptr[int32](20),
					RuleType: to.Ptr(armnetwork.ApplicationGatewayRequestRoutingRuleTypePathBasedRouting),
					URLPathMap: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1"),
					},
				},
			}},
		RewriteRuleSets: []*armnetwork.ApplicationGatewayRewriteRuleSet{
			{
				Name: to.Ptr("rewriteRuleSet1"),
				Properties: &armnetwork.ApplicationGatewayRewriteRuleSetPropertiesFormat{
					RewriteRules: []*armnetwork.ApplicationGatewayRewriteRule{
						{
							Name: to.Ptr("Set X-Forwarded-For"),
							ActionSet: &armnetwork.ApplicationGatewayRewriteRuleActionSet{
								RequestHeaderConfigurations: []*armnetwork.ApplicationGatewayHeaderConfiguration{
									{
										HeaderName:  to.Ptr("X-Forwarded-For"),
										HeaderValue: to.Ptr("{var_add_x_forwarded_for_proxy}"),
									}},
								ResponseHeaderConfigurations: []*armnetwork.ApplicationGatewayHeaderConfiguration{
									{
										HeaderName:  to.Ptr("Strict-Transport-Security"),
										HeaderValue: to.Ptr("max-age=31536000"),
									}},
								URLConfiguration: &armnetwork.ApplicationGatewayURLConfiguration{
									ModifiedPath: to.Ptr("/abc"),
								},
							},
							Conditions: []*armnetwork.ApplicationGatewayRewriteRuleCondition{
								{
									IgnoreCase: to.Ptr(true),
									Negate:     to.Ptr(false),
									Pattern:    to.Ptr("^Bearer"),
									Variable:   to.Ptr("http_req_Authorization"),
								}},
							RuleSequence: to.Ptr[int32](102),
						}},
				},
			}},
		SKU: &armnetwork.ApplicationGatewaySKU{
			Name:     to.Ptr(armnetwork.ApplicationGatewaySKUNameStandardV2),
			Capacity: to.Ptr[int32](3),
			Tier:     to.Ptr(armnetwork.ApplicationGatewayTierStandardV2),
		},
		SSLCertificates: []*armnetwork.ApplicationGatewaySSLCertificate{
			{
				Name: to.Ptr("sslcert"),
				Properties: &armnetwork.ApplicationGatewaySSLCertificatePropertiesFormat{
					Data:     to.Ptr("****"),
					Password: to.Ptr("****"),
				},
			},
			{
				Name: to.Ptr("sslcert2"),
				Properties: &armnetwork.ApplicationGatewaySSLCertificatePropertiesFormat{
					KeyVaultSecretID: to.Ptr("https://kv/secret"),
				},
			}},
		SSLProfiles: []*armnetwork.ApplicationGatewaySSLProfile{
			{
				Name: to.Ptr("sslProfile1"),
				Properties: &armnetwork.ApplicationGatewaySSLProfilePropertiesFormat{
					ClientAuthConfiguration: &armnetwork.ApplicationGatewayClientAuthConfiguration{
						VerifyClientCertIssuerDN: to.Ptr(true),
					},
					SSLPolicy: &armnetwork.ApplicationGatewaySSLPolicy{
						CipherSuites: []*armnetwork.ApplicationGatewaySSLCipherSuite{
							to.Ptr(armnetwork.ApplicationGatewaySSLCipherSuiteTLSECDHERSAWITHAES128CBCSHA256)},
						MinProtocolVersion: to.Ptr(armnetwork.ApplicationGatewaySSLProtocolTLSv11),
						PolicyType:         to.Ptr(armnetwork.ApplicationGatewaySSLPolicyTypeCustom),
					},
					TrustedClientCertificates: []*armnetwork.SubResource{
						{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert"),
						}},
				},
			}},
		TrustedClientCertificates: []*armnetwork.ApplicationGatewayTrustedClientCertificate{
			{
				Name: to.Ptr("clientcert"),
				Properties: &armnetwork.ApplicationGatewayTrustedClientCertificatePropertiesFormat{
					Data: to.Ptr("****"),
				},
			}},
		TrustedRootCertificates: []*armnetwork.ApplicationGatewayTrustedRootCertificate{
			{
				Name: to.Ptr("rootcert"),
				Properties: &armnetwork.ApplicationGatewayTrustedRootCertificatePropertiesFormat{
					Data: to.Ptr("****"),
				},
			},
			{
				Name: to.Ptr("rootcert1"),
				Properties: &armnetwork.ApplicationGatewayTrustedRootCertificatePropertiesFormat{
					KeyVaultSecretID: to.Ptr("https://kv/secret"),
				},
			}},
		URLPathMaps: []*armnetwork.ApplicationGatewayURLPathMap{
			{
				Name: to.Ptr("pathMap1"),
				Properties: &armnetwork.ApplicationGatewayURLPathMapPropertiesFormat{
					DefaultBackendAddressPool: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"),
					},
					DefaultBackendHTTPSettings: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"),
					},
					DefaultLoadDistributionPolicy: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"),
					},
					DefaultRewriteRuleSet: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"),
					},
					PathRules: []*armnetwork.ApplicationGatewayPathRule{
						{
							Name: to.Ptr("apiPaths"),
							Properties: &armnetwork.ApplicationGatewayPathRulePropertiesFormat{
								BackendAddressPool: &armnetwork.SubResource{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"),
								},
								BackendHTTPSettings: &armnetwork.SubResource{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"),
								},
								LoadDistributionPolicy: &armnetwork.SubResource{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"),
								},
								Paths: []*string{
									to.Ptr("/api"),
									to.Ptr("/v1/api")},
								RewriteRuleSet: &armnetwork.SubResource{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"),
								},
							},
						}},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewaysClient) BeginDelete

func (client *ApplicationGatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, applicationGatewayName string, options *ApplicationGatewaysClientBeginDeleteOptions) (*runtime.Poller[ApplicationGatewaysClientDeleteResponse], error)

BeginDelete - Deletes the specified application gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "appgw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ApplicationGatewaysClient) BeginStart

func (client *ApplicationGatewaysClient) BeginStart(ctx context.Context, resourceGroupName string, applicationGatewayName string, options *ApplicationGatewaysClientBeginStartOptions) (*runtime.Poller[ApplicationGatewaysClientStartResponse], error)

BeginStart - Starts the specified application gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayStart.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStart(ctx, "rg1", "appgw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ApplicationGatewaysClient) BeginStop

func (client *ApplicationGatewaysClient) BeginStop(ctx context.Context, resourceGroupName string, applicationGatewayName string, options *ApplicationGatewaysClientBeginStopOptions) (*runtime.Poller[ApplicationGatewaysClientStopResponse], error)

BeginStop - Stops the specified application gateway in a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayStop.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStop(ctx, "rg1", "appgw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "appgw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewaysClient) GetSSLPredefinedPolicy

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

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetSSLPredefinedPolicy(ctx, "AppGwSslPolicy20150501", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewaysClient) ListAvailableRequestHeaders

ListAvailableRequestHeaders - Lists all available request headers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 options - ApplicationGatewaysClientListAvailableRequestHeadersOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableRequestHeaders method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("72f988bf-86f1-41af-91ab-2d7cd0dddd4", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListAvailableRequestHeaders(ctx, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewaysClient) ListAvailableResponseHeaders

ListAvailableResponseHeaders - Lists all available response headers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 options - ApplicationGatewaysClientListAvailableResponseHeadersOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableResponseHeaders method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("72f988bf-86f1-41af-91ab-2d7cd0dddd4", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListAvailableResponseHeaders(ctx, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewaysClient) ListAvailableSSLOptions

ListAvailableSSLOptions - Lists available Ssl options for configuring Ssl policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 options - ApplicationGatewaysClientListAvailableSSLOptionsOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableSSLOptions method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayAvailableSslOptionsGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListAvailableSSLOptions(ctx, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewaysClient) ListAvailableServerVariables

ListAvailableServerVariables - Lists all available server variables. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 options - ApplicationGatewaysClientListAvailableServerVariablesOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableServerVariables method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayAvailableServerVariablesGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("72f988bf-86f1-41af-91ab-2d7cd0dddd4", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListAvailableServerVariables(ctx, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewaysClient) ListAvailableWafRuleSets

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

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListAvailableWafRuleSets(ctx, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationGatewaysClient) NewListAllPager

NewListAllPager - Gets all the application gateways in a subscription. Generated from API version 2022-05-01 options - ApplicationGatewaysClientListAllOptions contains the optional parameters for the ApplicationGatewaysClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ApplicationGatewaysClient) NewListAvailableSSLPredefinedPoliciesPager

NewListAvailableSSLPredefinedPoliciesPager - Lists all SSL predefined policies for configuring Ssl policy. Generated from API version 2022-05-01 options - ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesOptions contains the optional parameters for the ApplicationGatewaysClient.ListAvailableSSLPredefinedPolicies method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAvailableSSLPredefinedPoliciesPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ApplicationGatewaysClient) NewListPager

NewListPager - Lists all application gateways in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - ApplicationGatewaysClientListOptions contains the optional parameters for the ApplicationGatewaysClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationGatewayUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "AppGw", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ApplicationGatewaysClientBackendHealthOnDemandResponse

type ApplicationGatewaysClientBackendHealthOnDemandResponse struct {
	ApplicationGatewayBackendHealthOnDemand
}

ApplicationGatewaysClientBackendHealthOnDemandResponse contains the response from method ApplicationGatewaysClient.BackendHealthOnDemand.

type ApplicationGatewaysClientBackendHealthResponse

type ApplicationGatewaysClientBackendHealthResponse struct {
	ApplicationGatewayBackendHealth
}

ApplicationGatewaysClientBackendHealthResponse contains the response from method ApplicationGatewaysClient.BackendHealth.

type ApplicationGatewaysClientBeginBackendHealthOnDemandOptions

type ApplicationGatewaysClientBeginBackendHealthOnDemandOptions struct {
	// Expands BackendAddressPool and BackendHttpSettings referenced in backend health.
	Expand *string
	// Resumes the LRO from the provided token.
	ResumeToken string
}

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

type ApplicationGatewaysClientBeginBackendHealthOptions

type ApplicationGatewaysClientBeginBackendHealthOptions struct {
	// Expands BackendAddressPool and BackendHttpSettings referenced in backend health.
	Expand *string
	// Resumes the LRO from the provided token.
	ResumeToken string
}

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

type ApplicationGatewaysClientBeginCreateOrUpdateOptions

type ApplicationGatewaysClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

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

type ApplicationGatewaysClientBeginDeleteOptions

type ApplicationGatewaysClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

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

type ApplicationGatewaysClientBeginStartOptions

type ApplicationGatewaysClientBeginStartOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

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

type ApplicationGatewaysClientBeginStopOptions

type ApplicationGatewaysClientBeginStopOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

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

type ApplicationGatewaysClientCreateOrUpdateResponse

type ApplicationGatewaysClientCreateOrUpdateResponse struct {
	ApplicationGateway
}

ApplicationGatewaysClientCreateOrUpdateResponse contains the response from method ApplicationGatewaysClient.CreateOrUpdate.

type ApplicationGatewaysClientDeleteResponse

type ApplicationGatewaysClientDeleteResponse struct {
}

ApplicationGatewaysClientDeleteResponse contains the response from method ApplicationGatewaysClient.Delete.

type ApplicationGatewaysClientGetOptions

type ApplicationGatewaysClientGetOptions struct {
}

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

type ApplicationGatewaysClientGetResponse

type ApplicationGatewaysClientGetResponse struct {
	ApplicationGateway
}

ApplicationGatewaysClientGetResponse contains the response from method ApplicationGatewaysClient.Get.

type ApplicationGatewaysClientGetSSLPredefinedPolicyOptions

type ApplicationGatewaysClientGetSSLPredefinedPolicyOptions struct {
}

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

type ApplicationGatewaysClientGetSSLPredefinedPolicyResponse

type ApplicationGatewaysClientGetSSLPredefinedPolicyResponse struct {
	ApplicationGatewaySSLPredefinedPolicy
}

ApplicationGatewaysClientGetSSLPredefinedPolicyResponse contains the response from method ApplicationGatewaysClient.GetSSLPredefinedPolicy.

type ApplicationGatewaysClientListAllOptions

type ApplicationGatewaysClientListAllOptions struct {
}

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

type ApplicationGatewaysClientListAllResponse

type ApplicationGatewaysClientListAllResponse struct {
	ApplicationGatewayListResult
}

ApplicationGatewaysClientListAllResponse contains the response from method ApplicationGatewaysClient.ListAll.

type ApplicationGatewaysClientListAvailableRequestHeadersOptions

type ApplicationGatewaysClientListAvailableRequestHeadersOptions struct {
}

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

type ApplicationGatewaysClientListAvailableRequestHeadersResponse

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

ApplicationGatewaysClientListAvailableRequestHeadersResponse contains the response from method ApplicationGatewaysClient.ListAvailableRequestHeaders.

type ApplicationGatewaysClientListAvailableResponseHeadersOptions

type ApplicationGatewaysClientListAvailableResponseHeadersOptions struct {
}

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

type ApplicationGatewaysClientListAvailableResponseHeadersResponse

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

ApplicationGatewaysClientListAvailableResponseHeadersResponse contains the response from method ApplicationGatewaysClient.ListAvailableResponseHeaders.

type ApplicationGatewaysClientListAvailableSSLOptionsOptions

type ApplicationGatewaysClientListAvailableSSLOptionsOptions struct {
}

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

type ApplicationGatewaysClientListAvailableSSLOptionsResponse

type ApplicationGatewaysClientListAvailableSSLOptionsResponse struct {
	ApplicationGatewayAvailableSSLOptions
}

ApplicationGatewaysClientListAvailableSSLOptionsResponse contains the response from method ApplicationGatewaysClient.ListAvailableSSLOptions.

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesOptions

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesOptions struct {
}

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

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResponse

type ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResponse struct {
	ApplicationGatewayAvailableSSLPredefinedPolicies
}

ApplicationGatewaysClientListAvailableSSLPredefinedPoliciesResponse contains the response from method ApplicationGatewaysClient.ListAvailableSSLPredefinedPolicies.

type ApplicationGatewaysClientListAvailableServerVariablesOptions

type ApplicationGatewaysClientListAvailableServerVariablesOptions struct {
}

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

type ApplicationGatewaysClientListAvailableServerVariablesResponse

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

ApplicationGatewaysClientListAvailableServerVariablesResponse contains the response from method ApplicationGatewaysClient.ListAvailableServerVariables.

type ApplicationGatewaysClientListAvailableWafRuleSetsOptions

type ApplicationGatewaysClientListAvailableWafRuleSetsOptions struct {
}

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

type ApplicationGatewaysClientListAvailableWafRuleSetsResponse

type ApplicationGatewaysClientListAvailableWafRuleSetsResponse struct {
	ApplicationGatewayAvailableWafRuleSetsResult
}

ApplicationGatewaysClientListAvailableWafRuleSetsResponse contains the response from method ApplicationGatewaysClient.ListAvailableWafRuleSets.

type ApplicationGatewaysClientListOptions

type ApplicationGatewaysClientListOptions struct {
}

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

type ApplicationGatewaysClientListResponse

type ApplicationGatewaysClientListResponse struct {
	ApplicationGatewayListResult
}

ApplicationGatewaysClientListResponse contains the response from method ApplicationGatewaysClient.List.

type ApplicationGatewaysClientStartResponse

type ApplicationGatewaysClientStartResponse struct {
}

ApplicationGatewaysClientStartResponse contains the response from method ApplicationGatewaysClient.Start.

type ApplicationGatewaysClientStopResponse

type ApplicationGatewaysClientStopResponse struct {
}

ApplicationGatewaysClientStopResponse contains the response from method ApplicationGatewaysClient.Stop.

type ApplicationGatewaysClientUpdateTagsOptions

type ApplicationGatewaysClientUpdateTagsOptions struct {
}

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

type ApplicationGatewaysClientUpdateTagsResponse

type ApplicationGatewaysClientUpdateTagsResponse struct {
	ApplicationGateway
}

ApplicationGatewaysClientUpdateTagsResponse contains the response 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

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.

func (*ApplicationSecurityGroup) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ApplicationSecurityGroupListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (ApplicationSecurityGroupPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ApplicationSecurityGroupPropertiesFormat.

func (*ApplicationSecurityGroupPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationSecurityGroupPropertiesFormat.

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, error)

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

BeginCreateOrUpdate - Creates or updates an application security group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationSecurityGroupCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-asg", armnetwork.ApplicationSecurityGroup{
	Location:   to.Ptr("westus"),
	Properties: &armnetwork.ApplicationSecurityGroupPropertiesFormat{},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationSecurityGroupsClient) BeginDelete

BeginDelete - Deletes the specified application security group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationSecurityGroupDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-asg", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ApplicationSecurityGroupsClient) Get

Get - Gets information about the specified application security group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationSecurityGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "test-asg", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ApplicationSecurityGroupsClient) NewListAllPager

NewListAllPager - Gets all application security groups in a subscription. Generated from API version 2022-05-01 options - ApplicationSecurityGroupsClientListAllOptions contains the optional parameters for the ApplicationSecurityGroupsClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationSecurityGroupListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ApplicationSecurityGroupsClient) NewListPager

NewListPager - Gets all the application security groups in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - ApplicationSecurityGroupsClientListOptions contains the optional parameters for the ApplicationSecurityGroupsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationSecurityGroupList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ApplicationSecurityGroupUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewApplicationSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-asg", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ApplicationSecurityGroupsClientBeginCreateOrUpdateOptions

type ApplicationSecurityGroupsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ApplicationSecurityGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the ApplicationSecurityGroupsClient.BeginCreateOrUpdate method.

type ApplicationSecurityGroupsClientBeginDeleteOptions

type ApplicationSecurityGroupsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ApplicationSecurityGroupsClientBeginDeleteOptions contains the optional parameters for the ApplicationSecurityGroupsClient.BeginDelete method.

type ApplicationSecurityGroupsClientCreateOrUpdateResponse

type ApplicationSecurityGroupsClientCreateOrUpdateResponse struct {
	ApplicationSecurityGroup
}

ApplicationSecurityGroupsClientCreateOrUpdateResponse contains the response from method ApplicationSecurityGroupsClient.CreateOrUpdate.

type ApplicationSecurityGroupsClientDeleteResponse

type ApplicationSecurityGroupsClientDeleteResponse struct {
}

ApplicationSecurityGroupsClientDeleteResponse contains the response from method ApplicationSecurityGroupsClient.Delete.

type ApplicationSecurityGroupsClientGetOptions

type ApplicationSecurityGroupsClientGetOptions struct {
}

ApplicationSecurityGroupsClientGetOptions contains the optional parameters for the ApplicationSecurityGroupsClient.Get method.

type ApplicationSecurityGroupsClientGetResponse

type ApplicationSecurityGroupsClientGetResponse struct {
	ApplicationSecurityGroup
}

ApplicationSecurityGroupsClientGetResponse contains the response from method ApplicationSecurityGroupsClient.Get.

type ApplicationSecurityGroupsClientListAllOptions

type ApplicationSecurityGroupsClientListAllOptions struct {
}

ApplicationSecurityGroupsClientListAllOptions contains the optional parameters for the ApplicationSecurityGroupsClient.ListAll method.

type ApplicationSecurityGroupsClientListAllResponse

type ApplicationSecurityGroupsClientListAllResponse struct {
	ApplicationSecurityGroupListResult
}

ApplicationSecurityGroupsClientListAllResponse contains the response from method ApplicationSecurityGroupsClient.ListAll.

type ApplicationSecurityGroupsClientListOptions

type ApplicationSecurityGroupsClientListOptions struct {
}

ApplicationSecurityGroupsClientListOptions contains the optional parameters for the ApplicationSecurityGroupsClient.List method.

type ApplicationSecurityGroupsClientListResponse

type ApplicationSecurityGroupsClientListResponse struct {
	ApplicationSecurityGroupListResult
}

ApplicationSecurityGroupsClientListResponse contains the response from method ApplicationSecurityGroupsClient.List.

type ApplicationSecurityGroupsClientUpdateTagsOptions

type ApplicationSecurityGroupsClientUpdateTagsOptions struct {
}

ApplicationSecurityGroupsClientUpdateTagsOptions contains the optional parameters for the ApplicationSecurityGroupsClient.UpdateTags method.

type ApplicationSecurityGroupsClientUpdateTagsResponse

type ApplicationSecurityGroupsClientUpdateTagsResponse struct {
	ApplicationSecurityGroup
}

ApplicationSecurityGroupsClientUpdateTagsResponse contains the response 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.

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.

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.

func (*AuthorizationListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (AuthorizationPropertiesFormat) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AuthorizationPropertiesFormat.

func (*AuthorizationPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizationPropertiesFormat.

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.

type AutoApprovedPrivateLinkService

type AutoApprovedPrivateLinkService struct {
	// The id of the private link service resource.
	PrivateLinkService *string `json:"privateLinkService,omitempty"`
}

AutoApprovedPrivateLinkService - The information of an AutoApprovedPrivateLinkService.

func (AutoApprovedPrivateLinkService) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AutoApprovedPrivateLinkService.

func (*AutoApprovedPrivateLinkService) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type 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.

func (*AutoApprovedPrivateLinkServicesResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AutoApprovedPrivateLinkServicesResult.

type AutoLearnPrivateRangesMode

type AutoLearnPrivateRangesMode string

AutoLearnPrivateRangesMode - The operation mode for automatically learning private ranges to not be SNAT

const (
	AutoLearnPrivateRangesModeDisabled AutoLearnPrivateRangesMode = "Disabled"
	AutoLearnPrivateRangesModeEnabled  AutoLearnPrivateRangesMode = "Enabled"
)

func PossibleAutoLearnPrivateRangesModeValues

func PossibleAutoLearnPrivateRangesModeValues() []AutoLearnPrivateRangesMode

PossibleAutoLearnPrivateRangesModeValues returns the possible values for the AutoLearnPrivateRangesMode const type.

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.

func (Availability) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type Availability.

func (*Availability) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type Availability.

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.

func (*AvailableDelegation) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) NewListPager

NewListPager - Gets all of the available subnet delegations for this subscription in this region. Generated from API version 2022-05-01 location - The location of the subnet. options - AvailableDelegationsClientListOptions contains the optional parameters for the AvailableDelegationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AvailableDelegationsSubscriptionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAvailableDelegationsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("westcentralus", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type AvailableDelegationsClientListOptions

type AvailableDelegationsClientListOptions struct {
}

AvailableDelegationsClientListOptions contains the optional parameters for the AvailableDelegationsClient.List method.

type AvailableDelegationsClientListResponse

type AvailableDelegationsClientListResponse struct {
	AvailableDelegationsResult
}

AvailableDelegationsClientListResponse contains the response 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.

func (*AvailableDelegationsResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) NewListPager

NewListPager - List what values of endpoint services are available for use. Generated from API version 2022-05-01 location - The location to check available endpoint services. options - AvailableEndpointServicesClientListOptions contains the optional parameters for the AvailableEndpointServicesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/EndpointServicesList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAvailableEndpointServicesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("westus", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type AvailableEndpointServicesClientListOptions

type AvailableEndpointServicesClientListOptions struct {
}

AvailableEndpointServicesClientListOptions contains the optional parameters for the AvailableEndpointServicesClient.List method.

type AvailableEndpointServicesClientListResponse

type AvailableEndpointServicesClientListResponse struct {
	EndpointServicesListResult
}

AvailableEndpointServicesClientListResponse contains the response 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.

func (AvailablePrivateEndpointType) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AvailablePrivateEndpointType.

func (*AvailablePrivateEndpointType) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type 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, error)

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) NewListByResourceGroupPager

NewListByResourceGroupPager - Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAvailablePrivateEndpointTypesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("regionName", "rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*AvailablePrivateEndpointTypesClient) NewListPager

NewListPager - Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region. Generated from API version 2022-05-01 location - The location of the domain name. options - AvailablePrivateEndpointTypesClientListOptions contains the optional parameters for the AvailablePrivateEndpointTypesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AvailablePrivateEndpointTypesGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAvailablePrivateEndpointTypesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("regionName", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type AvailablePrivateEndpointTypesClientListByResourceGroupOptions

type AvailablePrivateEndpointTypesClientListByResourceGroupOptions struct {
}

AvailablePrivateEndpointTypesClientListByResourceGroupOptions contains the optional parameters for the AvailablePrivateEndpointTypesClient.ListByResourceGroup method.

type AvailablePrivateEndpointTypesClientListByResourceGroupResponse

type AvailablePrivateEndpointTypesClientListByResourceGroupResponse struct {
	AvailablePrivateEndpointTypesResult
}

AvailablePrivateEndpointTypesClientListByResourceGroupResponse contains the response from method AvailablePrivateEndpointTypesClient.ListByResourceGroup.

type AvailablePrivateEndpointTypesClientListOptions

type AvailablePrivateEndpointTypesClientListOptions struct {
}

AvailablePrivateEndpointTypesClientListOptions contains the optional parameters for the AvailablePrivateEndpointTypesClient.List method.

type AvailablePrivateEndpointTypesClientListResponse

type AvailablePrivateEndpointTypesClientListResponse struct {
	AvailablePrivateEndpointTypesResult
}

AvailablePrivateEndpointTypesClientListResponse contains the response 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.

func (*AvailablePrivateEndpointTypesResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*AvailableProvidersList) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*AvailableProvidersListCity) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*AvailableProvidersListCountry) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*AvailableProvidersListParameters) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*AvailableProvidersListState) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) NewListPager

NewListPager - Gets all of the available subnet delegations for this resource group in this region. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AvailableDelegationsResourceGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAvailableResourceGroupDelegationsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("westcentralus", "rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type AvailableResourceGroupDelegationsClientListOptions

type AvailableResourceGroupDelegationsClientListOptions struct {
}

AvailableResourceGroupDelegationsClientListOptions contains the optional parameters for the AvailableResourceGroupDelegationsClient.List method.

type AvailableResourceGroupDelegationsClientListResponse

type AvailableResourceGroupDelegationsClientListResponse struct {
	AvailableDelegationsResult
}

AvailableResourceGroupDelegationsClientListResponse contains the response 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.

func (AvailableServiceAlias) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AvailableServiceAlias.

func (*AvailableServiceAlias) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableServiceAlias.

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, error)

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) NewListByResourceGroupPager

NewListByResourceGroupPager - Gets all available service aliases for this resource group in this region. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. location - The location. options - AvailableServiceAliasesClientListByResourceGroupOptions contains the optional parameters for the AvailableServiceAliasesClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AvailableServiceAliasesListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAvailableServiceAliasesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", "westcentralus", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*AvailableServiceAliasesClient) NewListPager

NewListPager - Gets all available service aliases for this subscription in this region. Generated from API version 2022-05-01 location - The location. options - AvailableServiceAliasesClientListOptions contains the optional parameters for the AvailableServiceAliasesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AvailableServiceAliasesList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAvailableServiceAliasesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("westcentralus", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type AvailableServiceAliasesClientListByResourceGroupOptions

type AvailableServiceAliasesClientListByResourceGroupOptions struct {
}

AvailableServiceAliasesClientListByResourceGroupOptions contains the optional parameters for the AvailableServiceAliasesClient.ListByResourceGroup method.

type AvailableServiceAliasesClientListByResourceGroupResponse

type AvailableServiceAliasesClientListByResourceGroupResponse struct {
	AvailableServiceAliasesResult
}

AvailableServiceAliasesClientListByResourceGroupResponse contains the response from method AvailableServiceAliasesClient.ListByResourceGroup.

type AvailableServiceAliasesClientListOptions

type AvailableServiceAliasesClientListOptions struct {
}

AvailableServiceAliasesClientListOptions contains the optional parameters for the AvailableServiceAliasesClient.List method.

type AvailableServiceAliasesClientListResponse

type AvailableServiceAliasesClientListResponse struct {
	AvailableServiceAliasesResult
}

AvailableServiceAliasesClientListResponse contains the response 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.

func (*AvailableServiceAliasesResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (AzureAsyncOperationResult) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureAsyncOperationResult.

func (*AzureAsyncOperationResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureAsyncOperationResult.

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.

func (*AzureFirewall) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*AzureFirewallApplicationRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (AzureFirewallApplicationRuleCollection) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallApplicationRuleCollection.

func (*AzureFirewallApplicationRuleCollection) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallApplicationRuleCollection.

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallApplicationRuleCollectionPropertiesFormat.

func (*AzureFirewallApplicationRuleCollectionPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (AzureFirewallApplicationRuleProtocol) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallApplicationRuleProtocol.

func (*AzureFirewallApplicationRuleProtocol) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallApplicationRuleProtocol.

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.

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.

func (*AzureFirewallFqdnTag) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*AzureFirewallFqdnTagListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (AzureFirewallFqdnTagPropertiesFormat) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallFqdnTagPropertiesFormat.

func (*AzureFirewallFqdnTagPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallFqdnTagPropertiesFormat.

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, error)

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) NewListAllPager

NewListAllPager - Gets all the Azure Firewall FQDN Tags in a subscription. Generated from API version 2022-05-01 options - AzureFirewallFqdnTagsClientListAllOptions contains the optional parameters for the AzureFirewallFqdnTagsClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallFqdnTagsListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallFqdnTagsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type AzureFirewallFqdnTagsClientListAllOptions

type AzureFirewallFqdnTagsClientListAllOptions struct {
}

AzureFirewallFqdnTagsClientListAllOptions contains the optional parameters for the AzureFirewallFqdnTagsClient.ListAll method.

type AzureFirewallFqdnTagsClientListAllResponse

type AzureFirewallFqdnTagsClientListAllResponse struct {
	AzureFirewallFqdnTagListResult
}

AzureFirewallFqdnTagsClientListAllResponse contains the response 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.

func (AzureFirewallIPConfiguration) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallIPConfiguration.

func (*AzureFirewallIPConfiguration) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallIPConfiguration.

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.

func (AzureFirewallIPConfigurationPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureFirewallIPConfigurationPropertiesFormat.

func (*AzureFirewallIPConfigurationPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallIPConfigurationPropertiesFormat.

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.

func (AzureFirewallIPGroups) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallIPGroups.

func (*AzureFirewallIPGroups) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallIPGroups.

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.

func (*AzureFirewallListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallListResult.

type AzureFirewallNatRCAction

type AzureFirewallNatRCAction struct {
	// The type of action.
	Type *AzureFirewallNatRCActionType `json:"type,omitempty"`
}

AzureFirewallNatRCAction - AzureFirewall NAT Rule Collection Action.

func (AzureFirewallNatRCAction) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallNatRCAction.

func (*AzureFirewallNatRCAction) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallNatRCAction.

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.

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.

func (*AzureFirewallNatRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (AzureFirewallNatRuleCollection) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallNatRuleCollection.

func (*AzureFirewallNatRuleCollection) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallNatRuleCollection.

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallNatRuleCollectionProperties.

func (*AzureFirewallNatRuleCollectionProperties) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*AzureFirewallNetworkRule) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (AzureFirewallNetworkRuleCollection) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallNetworkRuleCollection.

func (*AzureFirewallNetworkRuleCollection) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallNetworkRuleCollection.

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallNetworkRuleCollectionPropertiesFormat.

func (*AzureFirewallNetworkRuleCollectionPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (*AzureFirewallPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (AzureFirewallPublicIPAddress) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallPublicIPAddress.

func (*AzureFirewallPublicIPAddress) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallPublicIPAddress.

type AzureFirewallRCAction

type AzureFirewallRCAction struct {
	// The type of action.
	Type *AzureFirewallRCActionType `json:"type,omitempty"`
}

AzureFirewallRCAction - Properties of the AzureFirewallRCAction.

func (AzureFirewallRCAction) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallRCAction.

func (*AzureFirewallRCAction) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type 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.

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.

func (AzureFirewallSKU) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureFirewallSKU.

func (*AzureFirewallSKU) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureFirewallSKU.

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.

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.

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.

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, error)

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) (*runtime.Poller[AzureFirewallsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates the specified Azure Firewall. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateAzureFirewall)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "azurefirewall", armnetwork.AzureFirewall{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.AzureFirewallPropertiesFormat{
		ApplicationRuleCollections: []*armnetwork.AzureFirewallApplicationRuleCollection{
			{
				Name: to.Ptr("apprulecoll"),
				Properties: &armnetwork.AzureFirewallApplicationRuleCollectionPropertiesFormat{
					Action: &armnetwork.AzureFirewallRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallRCActionTypeDeny),
					},
					Priority: to.Ptr[int32](110),
					Rules: []*armnetwork.AzureFirewallApplicationRule{
						{
							Name:        to.Ptr("rule1"),
							Description: to.Ptr("Deny inbound rule"),
							Protocols: []*armnetwork.AzureFirewallApplicationRuleProtocol{
								{
									Port:         to.Ptr[int32](443),
									ProtocolType: to.Ptr(armnetwork.AzureFirewallApplicationRuleProtocolTypeHTTPS),
								}},
							SourceAddresses: []*string{
								to.Ptr("216.58.216.164"),
								to.Ptr("10.0.0.0/24")},
							TargetFqdns: []*string{
								to.Ptr("www.test.com")},
						}},
				},
			}},
		IPConfigurations: []*armnetwork.AzureFirewallIPConfiguration{
			{
				Name: to.Ptr("azureFirewallIpConfiguration"),
				Properties: &armnetwork.AzureFirewallIPConfigurationPropertiesFormat{
					PublicIPAddress: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"),
					},
					Subnet: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet"),
					},
				},
			}},
		NatRuleCollections: []*armnetwork.AzureFirewallNatRuleCollection{
			{
				Name: to.Ptr("natrulecoll"),
				Properties: &armnetwork.AzureFirewallNatRuleCollectionProperties{
					Action: &armnetwork.AzureFirewallNatRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallNatRCActionTypeDnat),
					},
					Priority: to.Ptr[int32](112),
					Rules: []*armnetwork.AzureFirewallNatRule{
						{
							Name:        to.Ptr("DNAT-HTTPS-traffic"),
							Description: to.Ptr("D-NAT all outbound web traffic for inspection"),
							DestinationAddresses: []*string{
								to.Ptr("1.2.3.4")},
							DestinationPorts: []*string{
								to.Ptr("443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("*")},
							TranslatedAddress: to.Ptr("1.2.3.5"),
							TranslatedPort:    to.Ptr("8443"),
						},
						{
							Name:        to.Ptr("DNAT-HTTP-traffic-With-FQDN"),
							Description: to.Ptr("D-NAT all inbound web traffic for inspection"),
							DestinationAddresses: []*string{
								to.Ptr("1.2.3.4")},
							DestinationPorts: []*string{
								to.Ptr("80")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("*")},
							TranslatedFqdn: to.Ptr("internalhttpserver"),
							TranslatedPort: to.Ptr("880"),
						}},
				},
			}},
		NetworkRuleCollections: []*armnetwork.AzureFirewallNetworkRuleCollection{
			{
				Name: to.Ptr("netrulecoll"),
				Properties: &armnetwork.AzureFirewallNetworkRuleCollectionPropertiesFormat{
					Action: &armnetwork.AzureFirewallRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallRCActionTypeDeny),
					},
					Priority: to.Ptr[int32](112),
					Rules: []*armnetwork.AzureFirewallNetworkRule{
						{
							Name:        to.Ptr("L4-traffic"),
							Description: to.Ptr("Block traffic based on source IPs and ports"),
							DestinationAddresses: []*string{
								to.Ptr("*")},
							DestinationPorts: []*string{
								to.Ptr("443-444"),
								to.Ptr("8443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("192.168.1.1-192.168.1.12"),
								to.Ptr("10.1.4.12-10.1.4.255")},
						},
						{
							Name:        to.Ptr("L4-traffic-with-FQDN"),
							Description: to.Ptr("Block traffic based on source IPs and ports to amazon"),
							DestinationFqdns: []*string{
								to.Ptr("www.amazon.com")},
							DestinationPorts: []*string{
								to.Ptr("443-444"),
								to.Ptr("8443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("10.2.4.12-10.2.4.255")},
						}},
				},
			}},
		SKU: &armnetwork.AzureFirewallSKU{
			Name: to.Ptr(armnetwork.AzureFirewallSKUNameAZFWVnet),
			Tier: to.Ptr(armnetwork.AzureFirewallSKUTierStandard),
		},
		ThreatIntelMode: to.Ptr(armnetwork.AzureFirewallThreatIntelModeAlert),
	},
	Zones: []*string{},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateAzureFirewallInVirtualHub)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallPutInHub.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "azurefirewall", armnetwork.AzureFirewall{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.AzureFirewallPropertiesFormat{
		FirewallPolicy: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/policy1"),
		},
		HubIPAddresses: &armnetwork.HubIPAddresses{
			PublicIPs: &armnetwork.HubPublicIPAddresses{
				Addresses: []*armnetwork.AzureFirewallPublicIPAddress{},
				Count:     to.Ptr[int32](1),
			},
		},
		SKU: &armnetwork.AzureFirewallSKU{
			Name: to.Ptr(armnetwork.AzureFirewallSKUNameAZFWHub),
			Tier: to.Ptr(armnetwork.AzureFirewallSKUTierStandard),
		},
		ThreatIntelMode: to.Ptr(armnetwork.AzureFirewallThreatIntelModeAlert),
		VirtualHub: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1"),
		},
	},
	Zones: []*string{},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateAzureFirewallWithAdditionalProperties)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallPutWithAdditionalProperties.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "azurefirewall", armnetwork.AzureFirewall{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.AzureFirewallPropertiesFormat{
		AdditionalProperties: map[string]*string{
			"key1": to.Ptr("value1"),
			"key2": to.Ptr("value2"),
		},
		ApplicationRuleCollections: []*armnetwork.AzureFirewallApplicationRuleCollection{
			{
				Name: to.Ptr("apprulecoll"),
				Properties: &armnetwork.AzureFirewallApplicationRuleCollectionPropertiesFormat{
					Action: &armnetwork.AzureFirewallRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallRCActionTypeDeny),
					},
					Priority: to.Ptr[int32](110),
					Rules: []*armnetwork.AzureFirewallApplicationRule{
						{
							Name:        to.Ptr("rule1"),
							Description: to.Ptr("Deny inbound rule"),
							Protocols: []*armnetwork.AzureFirewallApplicationRuleProtocol{
								{
									Port:         to.Ptr[int32](443),
									ProtocolType: to.Ptr(armnetwork.AzureFirewallApplicationRuleProtocolTypeHTTPS),
								}},
							SourceAddresses: []*string{
								to.Ptr("216.58.216.164"),
								to.Ptr("10.0.0.0/24")},
							TargetFqdns: []*string{
								to.Ptr("www.test.com")},
						}},
				},
			}},
		IPConfigurations: []*armnetwork.AzureFirewallIPConfiguration{
			{
				Name: to.Ptr("azureFirewallIpConfiguration"),
				Properties: &armnetwork.AzureFirewallIPConfigurationPropertiesFormat{
					PublicIPAddress: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"),
					},
					Subnet: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet"),
					},
				},
			}},
		IPGroups: []*armnetwork.AzureFirewallIPGroups{},
		NatRuleCollections: []*armnetwork.AzureFirewallNatRuleCollection{
			{
				Name: to.Ptr("natrulecoll"),
				Properties: &armnetwork.AzureFirewallNatRuleCollectionProperties{
					Action: &armnetwork.AzureFirewallNatRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallNatRCActionTypeDnat),
					},
					Priority: to.Ptr[int32](112),
					Rules: []*armnetwork.AzureFirewallNatRule{
						{
							Name:        to.Ptr("DNAT-HTTPS-traffic"),
							Description: to.Ptr("D-NAT all outbound web traffic for inspection"),
							DestinationAddresses: []*string{
								to.Ptr("1.2.3.4")},
							DestinationPorts: []*string{
								to.Ptr("443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("*")},
							TranslatedAddress: to.Ptr("1.2.3.5"),
							TranslatedPort:    to.Ptr("8443"),
						},
						{
							Name:        to.Ptr("DNAT-HTTP-traffic-With-FQDN"),
							Description: to.Ptr("D-NAT all inbound web traffic for inspection"),
							DestinationAddresses: []*string{
								to.Ptr("1.2.3.4")},
							DestinationPorts: []*string{
								to.Ptr("80")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("*")},
							TranslatedFqdn: to.Ptr("internalhttpserver"),
							TranslatedPort: to.Ptr("880"),
						}},
				},
			}},
		NetworkRuleCollections: []*armnetwork.AzureFirewallNetworkRuleCollection{
			{
				Name: to.Ptr("netrulecoll"),
				Properties: &armnetwork.AzureFirewallNetworkRuleCollectionPropertiesFormat{
					Action: &armnetwork.AzureFirewallRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallRCActionTypeDeny),
					},
					Priority: to.Ptr[int32](112),
					Rules: []*armnetwork.AzureFirewallNetworkRule{
						{
							Name:        to.Ptr("L4-traffic"),
							Description: to.Ptr("Block traffic based on source IPs and ports"),
							DestinationAddresses: []*string{
								to.Ptr("*")},
							DestinationPorts: []*string{
								to.Ptr("443-444"),
								to.Ptr("8443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("192.168.1.1-192.168.1.12"),
								to.Ptr("10.1.4.12-10.1.4.255")},
						},
						{
							Name:        to.Ptr("L4-traffic-with-FQDN"),
							Description: to.Ptr("Block traffic based on source IPs and ports to amazon"),
							DestinationFqdns: []*string{
								to.Ptr("www.amazon.com")},
							DestinationPorts: []*string{
								to.Ptr("443-444"),
								to.Ptr("8443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("10.2.4.12-10.2.4.255")},
						}},
				},
			}},
		SKU: &armnetwork.AzureFirewallSKU{
			Name: to.Ptr(armnetwork.AzureFirewallSKUNameAZFWVnet),
			Tier: to.Ptr(armnetwork.AzureFirewallSKUTierStandard),
		},
		ThreatIntelMode: to.Ptr(armnetwork.AzureFirewallThreatIntelModeAlert),
	},
	Zones: []*string{},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateAzureFirewallWithIpGroups)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallPutWithIpGroups.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "azurefirewall", armnetwork.AzureFirewall{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.AzureFirewallPropertiesFormat{
		ApplicationRuleCollections: []*armnetwork.AzureFirewallApplicationRuleCollection{
			{
				Name: to.Ptr("apprulecoll"),
				Properties: &armnetwork.AzureFirewallApplicationRuleCollectionPropertiesFormat{
					Action: &armnetwork.AzureFirewallRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallRCActionTypeDeny),
					},
					Priority: to.Ptr[int32](110),
					Rules: []*armnetwork.AzureFirewallApplicationRule{
						{
							Name:        to.Ptr("rule1"),
							Description: to.Ptr("Deny inbound rule"),
							Protocols: []*armnetwork.AzureFirewallApplicationRuleProtocol{
								{
									Port:         to.Ptr[int32](443),
									ProtocolType: to.Ptr(armnetwork.AzureFirewallApplicationRuleProtocolTypeHTTPS),
								}},
							SourceAddresses: []*string{
								to.Ptr("216.58.216.164"),
								to.Ptr("10.0.0.0/24")},
							TargetFqdns: []*string{
								to.Ptr("www.test.com")},
						}},
				},
			}},
		IPConfigurations: []*armnetwork.AzureFirewallIPConfiguration{
			{
				Name: to.Ptr("azureFirewallIpConfiguration"),
				Properties: &armnetwork.AzureFirewallIPConfigurationPropertiesFormat{
					PublicIPAddress: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"),
					},
					Subnet: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet"),
					},
				},
			}},
		NatRuleCollections: []*armnetwork.AzureFirewallNatRuleCollection{
			{
				Name: to.Ptr("natrulecoll"),
				Properties: &armnetwork.AzureFirewallNatRuleCollectionProperties{
					Action: &armnetwork.AzureFirewallNatRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallNatRCActionTypeDnat),
					},
					Priority: to.Ptr[int32](112),
					Rules: []*armnetwork.AzureFirewallNatRule{
						{
							Name:        to.Ptr("DNAT-HTTPS-traffic"),
							Description: to.Ptr("D-NAT all outbound web traffic for inspection"),
							DestinationAddresses: []*string{
								to.Ptr("1.2.3.4")},
							DestinationPorts: []*string{
								to.Ptr("443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("*")},
							TranslatedAddress: to.Ptr("1.2.3.5"),
							TranslatedPort:    to.Ptr("8443"),
						},
						{
							Name:        to.Ptr("DNAT-HTTP-traffic-With-FQDN"),
							Description: to.Ptr("D-NAT all inbound web traffic for inspection"),
							DestinationAddresses: []*string{
								to.Ptr("1.2.3.4")},
							DestinationPorts: []*string{
								to.Ptr("80")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("*")},
							TranslatedFqdn: to.Ptr("internalhttpserver"),
							TranslatedPort: to.Ptr("880"),
						}},
				},
			}},
		NetworkRuleCollections: []*armnetwork.AzureFirewallNetworkRuleCollection{
			{
				Name: to.Ptr("netrulecoll"),
				Properties: &armnetwork.AzureFirewallNetworkRuleCollectionPropertiesFormat{
					Action: &armnetwork.AzureFirewallRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallRCActionTypeDeny),
					},
					Priority: to.Ptr[int32](112),
					Rules: []*armnetwork.AzureFirewallNetworkRule{
						{
							Name:        to.Ptr("L4-traffic"),
							Description: to.Ptr("Block traffic based on source IPs and ports"),
							DestinationAddresses: []*string{
								to.Ptr("*")},
							DestinationPorts: []*string{
								to.Ptr("443-444"),
								to.Ptr("8443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("192.168.1.1-192.168.1.12"),
								to.Ptr("10.1.4.12-10.1.4.255")},
						},
						{
							Name:        to.Ptr("L4-traffic-with-FQDN"),
							Description: to.Ptr("Block traffic based on source IPs and ports to amazon"),
							DestinationFqdns: []*string{
								to.Ptr("www.amazon.com")},
							DestinationPorts: []*string{
								to.Ptr("443-444"),
								to.Ptr("8443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("10.2.4.12-10.2.4.255")},
						}},
				},
			}},
		SKU: &armnetwork.AzureFirewallSKU{
			Name: to.Ptr(armnetwork.AzureFirewallSKUNameAZFWVnet),
			Tier: to.Ptr(armnetwork.AzureFirewallSKUTierStandard),
		},
		ThreatIntelMode: to.Ptr(armnetwork.AzureFirewallThreatIntelModeAlert),
	},
	Zones: []*string{},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateAzureFirewallWithManagementSubnet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallPutWithMgmtSubnet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "azurefirewall", armnetwork.AzureFirewall{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.AzureFirewallPropertiesFormat{
		ApplicationRuleCollections: []*armnetwork.AzureFirewallApplicationRuleCollection{
			{
				Name: to.Ptr("apprulecoll"),
				Properties: &armnetwork.AzureFirewallApplicationRuleCollectionPropertiesFormat{
					Action: &armnetwork.AzureFirewallRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallRCActionTypeDeny),
					},
					Priority: to.Ptr[int32](110),
					Rules: []*armnetwork.AzureFirewallApplicationRule{
						{
							Name:        to.Ptr("rule1"),
							Description: to.Ptr("Deny inbound rule"),
							Protocols: []*armnetwork.AzureFirewallApplicationRuleProtocol{
								{
									Port:         to.Ptr[int32](443),
									ProtocolType: to.Ptr(armnetwork.AzureFirewallApplicationRuleProtocolTypeHTTPS),
								}},
							SourceAddresses: []*string{
								to.Ptr("216.58.216.164"),
								to.Ptr("10.0.0.0/24")},
							TargetFqdns: []*string{
								to.Ptr("www.test.com")},
						}},
				},
			}},
		IPConfigurations: []*armnetwork.AzureFirewallIPConfiguration{
			{
				Name: to.Ptr("azureFirewallIpConfiguration"),
				Properties: &armnetwork.AzureFirewallIPConfigurationPropertiesFormat{
					PublicIPAddress: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"),
					},
					Subnet: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet"),
					},
				},
			}},
		ManagementIPConfiguration: &armnetwork.AzureFirewallIPConfiguration{
			Name: to.Ptr("azureFirewallMgmtIpConfiguration"),
			Properties: &armnetwork.AzureFirewallIPConfigurationPropertiesFormat{
				PublicIPAddress: &armnetwork.SubResource{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName"),
				},
				Subnet: &armnetwork.SubResource{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet"),
				},
			},
		},
		NatRuleCollections: []*armnetwork.AzureFirewallNatRuleCollection{
			{
				Name: to.Ptr("natrulecoll"),
				Properties: &armnetwork.AzureFirewallNatRuleCollectionProperties{
					Action: &armnetwork.AzureFirewallNatRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallNatRCActionTypeDnat),
					},
					Priority: to.Ptr[int32](112),
					Rules: []*armnetwork.AzureFirewallNatRule{
						{
							Name:        to.Ptr("DNAT-HTTPS-traffic"),
							Description: to.Ptr("D-NAT all outbound web traffic for inspection"),
							DestinationAddresses: []*string{
								to.Ptr("1.2.3.4")},
							DestinationPorts: []*string{
								to.Ptr("443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("*")},
							TranslatedAddress: to.Ptr("1.2.3.5"),
							TranslatedPort:    to.Ptr("8443"),
						},
						{
							Name:        to.Ptr("DNAT-HTTP-traffic-With-FQDN"),
							Description: to.Ptr("D-NAT all inbound web traffic for inspection"),
							DestinationAddresses: []*string{
								to.Ptr("1.2.3.4")},
							DestinationPorts: []*string{
								to.Ptr("80")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("*")},
							TranslatedFqdn: to.Ptr("internalhttpserver"),
							TranslatedPort: to.Ptr("880"),
						}},
				},
			}},
		NetworkRuleCollections: []*armnetwork.AzureFirewallNetworkRuleCollection{
			{
				Name: to.Ptr("netrulecoll"),
				Properties: &armnetwork.AzureFirewallNetworkRuleCollectionPropertiesFormat{
					Action: &armnetwork.AzureFirewallRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallRCActionTypeDeny),
					},
					Priority: to.Ptr[int32](112),
					Rules: []*armnetwork.AzureFirewallNetworkRule{
						{
							Name:        to.Ptr("L4-traffic"),
							Description: to.Ptr("Block traffic based on source IPs and ports"),
							DestinationAddresses: []*string{
								to.Ptr("*")},
							DestinationPorts: []*string{
								to.Ptr("443-444"),
								to.Ptr("8443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("192.168.1.1-192.168.1.12"),
								to.Ptr("10.1.4.12-10.1.4.255")},
						},
						{
							Name:        to.Ptr("L4-traffic-with-FQDN"),
							Description: to.Ptr("Block traffic based on source IPs and ports to amazon"),
							DestinationFqdns: []*string{
								to.Ptr("www.amazon.com")},
							DestinationPorts: []*string{
								to.Ptr("443-444"),
								to.Ptr("8443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("10.2.4.12-10.2.4.255")},
						}},
				},
			}},
		SKU: &armnetwork.AzureFirewallSKU{
			Name: to.Ptr(armnetwork.AzureFirewallSKUNameAZFWVnet),
			Tier: to.Ptr(armnetwork.AzureFirewallSKUTierStandard),
		},
		ThreatIntelMode: to.Ptr(armnetwork.AzureFirewallThreatIntelModeAlert),
	},
	Zones: []*string{},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateAzureFirewallWithZones)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallPutWithZones.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "azurefirewall", armnetwork.AzureFirewall{
	Location: to.Ptr("West US 2"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.AzureFirewallPropertiesFormat{
		ApplicationRuleCollections: []*armnetwork.AzureFirewallApplicationRuleCollection{
			{
				Name: to.Ptr("apprulecoll"),
				Properties: &armnetwork.AzureFirewallApplicationRuleCollectionPropertiesFormat{
					Action: &armnetwork.AzureFirewallRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallRCActionTypeDeny),
					},
					Priority: to.Ptr[int32](110),
					Rules: []*armnetwork.AzureFirewallApplicationRule{
						{
							Name:        to.Ptr("rule1"),
							Description: to.Ptr("Deny inbound rule"),
							Protocols: []*armnetwork.AzureFirewallApplicationRuleProtocol{
								{
									Port:         to.Ptr[int32](443),
									ProtocolType: to.Ptr(armnetwork.AzureFirewallApplicationRuleProtocolTypeHTTPS),
								}},
							SourceAddresses: []*string{
								to.Ptr("216.58.216.164"),
								to.Ptr("10.0.0.0/24")},
							TargetFqdns: []*string{
								to.Ptr("www.test.com")},
						}},
				},
			}},
		IPConfigurations: []*armnetwork.AzureFirewallIPConfiguration{
			{
				Name: to.Ptr("azureFirewallIpConfiguration"),
				Properties: &armnetwork.AzureFirewallIPConfigurationPropertiesFormat{
					PublicIPAddress: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"),
					},
					Subnet: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet"),
					},
				},
			}},
		NatRuleCollections: []*armnetwork.AzureFirewallNatRuleCollection{
			{
				Name: to.Ptr("natrulecoll"),
				Properties: &armnetwork.AzureFirewallNatRuleCollectionProperties{
					Action: &armnetwork.AzureFirewallNatRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallNatRCActionTypeDnat),
					},
					Priority: to.Ptr[int32](112),
					Rules: []*armnetwork.AzureFirewallNatRule{
						{
							Name:        to.Ptr("DNAT-HTTPS-traffic"),
							Description: to.Ptr("D-NAT all outbound web traffic for inspection"),
							DestinationAddresses: []*string{
								to.Ptr("1.2.3.4")},
							DestinationPorts: []*string{
								to.Ptr("443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("*")},
							TranslatedAddress: to.Ptr("1.2.3.5"),
							TranslatedPort:    to.Ptr("8443"),
						},
						{
							Name:        to.Ptr("DNAT-HTTP-traffic-With-FQDN"),
							Description: to.Ptr("D-NAT all inbound web traffic for inspection"),
							DestinationAddresses: []*string{
								to.Ptr("1.2.3.4")},
							DestinationPorts: []*string{
								to.Ptr("80")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("*")},
							TranslatedFqdn: to.Ptr("internalhttpserver"),
							TranslatedPort: to.Ptr("880"),
						}},
				},
			}},
		NetworkRuleCollections: []*armnetwork.AzureFirewallNetworkRuleCollection{
			{
				Name: to.Ptr("netrulecoll"),
				Properties: &armnetwork.AzureFirewallNetworkRuleCollectionPropertiesFormat{
					Action: &armnetwork.AzureFirewallRCAction{
						Type: to.Ptr(armnetwork.AzureFirewallRCActionTypeDeny),
					},
					Priority: to.Ptr[int32](112),
					Rules: []*armnetwork.AzureFirewallNetworkRule{
						{
							Name:        to.Ptr("L4-traffic"),
							Description: to.Ptr("Block traffic based on source IPs and ports"),
							DestinationAddresses: []*string{
								to.Ptr("*")},
							DestinationPorts: []*string{
								to.Ptr("443-444"),
								to.Ptr("8443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("192.168.1.1-192.168.1.12"),
								to.Ptr("10.1.4.12-10.1.4.255")},
						},
						{
							Name:        to.Ptr("L4-traffic-with-FQDN"),
							Description: to.Ptr("Block traffic based on source IPs and ports to amazon"),
							DestinationFqdns: []*string{
								to.Ptr("www.amazon.com")},
							DestinationPorts: []*string{
								to.Ptr("443-444"),
								to.Ptr("8443")},
							Protocols: []*armnetwork.AzureFirewallNetworkRuleProtocol{
								to.Ptr(armnetwork.AzureFirewallNetworkRuleProtocolTCP)},
							SourceAddresses: []*string{
								to.Ptr("10.2.4.12-10.2.4.255")},
						}},
				},
			}},
		SKU: &armnetwork.AzureFirewallSKU{
			Name: to.Ptr(armnetwork.AzureFirewallSKUNameAZFWVnet),
			Tier: to.Ptr(armnetwork.AzureFirewallSKUTierStandard),
		},
		ThreatIntelMode: to.Ptr(armnetwork.AzureFirewallThreatIntelModeAlert),
	},
	Zones: []*string{
		to.Ptr("1"),
		to.Ptr("2"),
		to.Ptr("3")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*AzureFirewallsClient) BeginDelete

func (client *AzureFirewallsClient) BeginDelete(ctx context.Context, resourceGroupName string, azureFirewallName string, options *AzureFirewallsClientBeginDeleteOptions) (*runtime.Poller[AzureFirewallsClientDeleteResponse], error)

BeginDelete - Deletes the specified Azure Firewall. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "azurefirewall", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*AzureFirewallsClient) BeginListLearnedPrefixes

func (client *AzureFirewallsClient) BeginListLearnedPrefixes(ctx context.Context, resourceGroupName string, azureFirewallName string, options *AzureFirewallsClientBeginListLearnedPrefixesOptions) (*runtime.Poller[AzureFirewallsClientListLearnedPrefixesResponse], error)

BeginListLearnedPrefixes - Retrieves a list of all IP prefixes that azure firewall has learned to not SNAT. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. azureFirewallName - The name of the azure firewall. options - AzureFirewallsClientBeginListLearnedPrefixesOptions contains the optional parameters for the AzureFirewallsClient.BeginListLearnedPrefixes method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallListLearnedIPPrefixes.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListLearnedPrefixes(ctx, "rg1", "azureFirewall1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*AzureFirewallsClient) BeginUpdateTags

func (client *AzureFirewallsClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, azureFirewallName string, parameters TagsObject, options *AzureFirewallsClientBeginUpdateTagsOptions) (*runtime.Poller[AzureFirewallsClientUpdateTagsResponse], error)

BeginUpdateTags - Updates tags of an Azure Firewall resource. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdateTags(ctx, "azfwtest", "fw1", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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 (GetAzureFirewall)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "azurefirewall", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetAzureFirewallWithAdditionalProperties)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallGetWithAdditionalProperties.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "azurefirewall", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetAzureFirewallWithIpGroups)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallGetWithIpGroups.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "azurefirewall", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetAzureFirewallWithManagementSubnet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallGetWithMgmtSubnet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "azurefirewall", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetAzureFirewallWithZones)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallGetWithZones.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "azurefirewall", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*AzureFirewallsClient) NewListAllPager

NewListAllPager - Gets all the Azure Firewalls in a subscription. Generated from API version 2022-05-01 options - AzureFirewallsClientListAllOptions contains the optional parameters for the AzureFirewallsClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*AzureFirewallsClient) NewListPager

NewListPager - Lists all Azure Firewalls in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - AzureFirewallsClientListOptions contains the optional parameters for the AzureFirewallsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureFirewallListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewAzureFirewallsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type AzureFirewallsClientBeginCreateOrUpdateOptions

type AzureFirewallsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AzureFirewallsClientBeginCreateOrUpdateOptions contains the optional parameters for the AzureFirewallsClient.BeginCreateOrUpdate method.

type AzureFirewallsClientBeginDeleteOptions

type AzureFirewallsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AzureFirewallsClientBeginDeleteOptions contains the optional parameters for the AzureFirewallsClient.BeginDelete method.

type AzureFirewallsClientBeginListLearnedPrefixesOptions

type AzureFirewallsClientBeginListLearnedPrefixesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AzureFirewallsClientBeginListLearnedPrefixesOptions contains the optional parameters for the AzureFirewallsClient.BeginListLearnedPrefixes method.

type AzureFirewallsClientBeginUpdateTagsOptions

type AzureFirewallsClientBeginUpdateTagsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AzureFirewallsClientBeginUpdateTagsOptions contains the optional parameters for the AzureFirewallsClient.BeginUpdateTags method.

type AzureFirewallsClientCreateOrUpdateResponse

type AzureFirewallsClientCreateOrUpdateResponse struct {
	AzureFirewall
}

AzureFirewallsClientCreateOrUpdateResponse contains the response from method AzureFirewallsClient.CreateOrUpdate.

type AzureFirewallsClientDeleteResponse

type AzureFirewallsClientDeleteResponse struct {
}

AzureFirewallsClientDeleteResponse contains the response from method AzureFirewallsClient.Delete.

type AzureFirewallsClientGetOptions

type AzureFirewallsClientGetOptions struct {
}

AzureFirewallsClientGetOptions contains the optional parameters for the AzureFirewallsClient.Get method.

type AzureFirewallsClientGetResponse

type AzureFirewallsClientGetResponse struct {
	AzureFirewall
}

AzureFirewallsClientGetResponse contains the response from method AzureFirewallsClient.Get.

type AzureFirewallsClientListAllOptions

type AzureFirewallsClientListAllOptions struct {
}

AzureFirewallsClientListAllOptions contains the optional parameters for the AzureFirewallsClient.ListAll method.

type AzureFirewallsClientListAllResponse

type AzureFirewallsClientListAllResponse struct {
	AzureFirewallListResult
}

AzureFirewallsClientListAllResponse contains the response from method AzureFirewallsClient.ListAll.

type AzureFirewallsClientListLearnedPrefixesResponse

type AzureFirewallsClientListLearnedPrefixesResponse struct {
	IPPrefixesList
}

AzureFirewallsClientListLearnedPrefixesResponse contains the response from method AzureFirewallsClient.ListLearnedPrefixes.

type AzureFirewallsClientListOptions

type AzureFirewallsClientListOptions struct {
}

AzureFirewallsClientListOptions contains the optional parameters for the AzureFirewallsClient.List method.

type AzureFirewallsClientListResponse

type AzureFirewallsClientListResponse struct {
	AzureFirewallListResult
}

AzureFirewallsClientListResponse contains the response from method AzureFirewallsClient.List.

type AzureFirewallsClientUpdateTagsResponse

type AzureFirewallsClientUpdateTagsResponse struct {
	AzureFirewall
}

AzureFirewallsClientUpdateTagsResponse contains the response 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.

func (*AzureReachabilityReport) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (*AzureReachabilityReportItem) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (AzureReachabilityReportLocation) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureReachabilityReportLocation.

func (*AzureReachabilityReportLocation) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureReachabilityReportLocation.

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.

func (AzureWebCategory) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureWebCategory.

func (*AzureWebCategory) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureWebCategory.

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.

func (*AzureWebCategoryListResult) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller 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.

func (AzureWebCategoryPropertiesFormat) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type AzureWebCategoryPropertiesFormat.

func (*AzureWebCategoryPropertiesFormat) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureWebCategoryPropertiesFormat.

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.

func (*BGPCommunity) UnmarshalJSON

func (b *BGPCommunity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BGPCommunity.

type BackendAddressInboundNatRulePortMappings

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

MarshalJSON implements the json.Marshaller interface for type BackendAddressInboundNatRulePortMappings.

func (*BackendAddressInboundNatRulePortMappings) UnmarshalJSON

func (b *BackendAddressInboundNatRulePortMappings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (BackendAddressPool) MarshalJSON

func (b BackendAddressPool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackendAddressPool.

func (*BackendAddressPool) UnmarshalJSON

func (b *BackendAddressPool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackendAddressPool.

type BackendAddressPoolPropertiesFormat

type BackendAddressPoolPropertiesFormat struct {
	// Amount of seconds Load Balancer waits for before sending RESET to client and backend address.
	DrainPeriodInSeconds *int32 `json:"drainPeriodInSeconds,omitempty"`

	// 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.

func (*BackendAddressPoolPropertiesFormat) UnmarshalJSON

func (b *BackendAddressPoolPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackendAddressPoolPropertiesFormat.

type BaseAdminRule

type BaseAdminRule struct {
	// REQUIRED; Whether the rule is custom or default.
	Kind *AdminRuleKind `json:"kind,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; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

BaseAdminRule - Network base admin rule.

func (*BaseAdminRule) GetBaseAdminRule

func (b *BaseAdminRule) GetBaseAdminRule() *BaseAdminRule

GetBaseAdminRule implements the BaseAdminRuleClassification interface for type BaseAdminRule.

func (BaseAdminRule) MarshalJSON

func (b BaseAdminRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BaseAdminRule.

func (*BaseAdminRule) UnmarshalJSON

func (b *BaseAdminRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BaseAdminRule.

type BaseAdminRuleClassification

type BaseAdminRuleClassification interface {
	// GetBaseAdminRule returns the BaseAdminRule content of the underlying type.
	GetBaseAdminRule() *BaseAdminRule
}

BaseAdminRuleClassification provides polymorphic access to related types. Call the interface's GetBaseAdminRule() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AdminRule, *BaseAdminRule, *DefaultAdminRule

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 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.

func (BastionActiveSession) MarshalJSON

func (b BastionActiveSession) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionActiveSession.

func (*BastionActiveSession) UnmarshalJSON

func (b *BastionActiveSession) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BastionActiveSession.

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.

func (*BastionActiveSessionListResult) UnmarshalJSON

func (b *BastionActiveSessionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (*BastionHost) UnmarshalJSON

func (b *BastionHost) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (BastionHostIPConfiguration) MarshalJSON

func (b BastionHostIPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionHostIPConfiguration.

func (*BastionHostIPConfiguration) UnmarshalJSON

func (b *BastionHostIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BastionHostIPConfiguration.

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.

func (BastionHostIPConfigurationPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type BastionHostIPConfigurationPropertiesFormat.

func (*BastionHostIPConfigurationPropertiesFormat) UnmarshalJSON

func (b *BastionHostIPConfigurationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BastionHostIPConfigurationPropertiesFormat.

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.

func (*BastionHostListResult) UnmarshalJSON

func (b *BastionHostListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*BastionHostPropertiesFormat) UnmarshalJSON

func (b *BastionHostPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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, error)

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) (*runtime.Poller[BastionHostsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates the specified Bastion Host. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/BastionHostPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewBastionHostsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "bastionhosttenant", armnetwork.BastionHost{
	Properties: &armnetwork.BastionHostPropertiesFormat{
		IPConfigurations: []*armnetwork.BastionHostIPConfiguration{
			{
				Name: to.Ptr("bastionHostIpConfiguration"),
				Properties: &armnetwork.BastionHostIPConfigurationPropertiesFormat{
					PublicIPAddress: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"),
					},
					Subnet: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"),
					},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BastionHostsClient) BeginDelete

func (client *BastionHostsClient) BeginDelete(ctx context.Context, resourceGroupName string, bastionHostName string, options *BastionHostsClientBeginDeleteOptions) (*runtime.Poller[BastionHostsClientDeleteResponse], error)

BeginDelete - Deletes the specified Bastion Host. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/BastionHostDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewBastionHostsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "bastionhosttenant", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*BastionHostsClient) BeginUpdateTags

func (client *BastionHostsClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, bastionHostName string, parameters TagsObject, options *BastionHostsClientBeginUpdateTagsOptions) (*runtime.Poller[BastionHostsClientUpdateTagsResponse], error)

BeginUpdateTags - Updates Tags for BastionHost resource If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/BastionHostPatch.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewBastionHostsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdateTags(ctx, "rg1", "bastionhosttenant", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/BastionHostGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewBastionHostsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "bastionhosttenant'", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*BastionHostsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all Bastion Hosts in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - BastionHostsClientListByResourceGroupOptions contains the optional parameters for the BastionHostsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/BastionHostListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewBastionHostsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*BastionHostsClient) NewListPager

NewListPager - Lists all Bastion Hosts in a subscription. Generated from API version 2022-05-01 options - BastionHostsClientListOptions contains the optional parameters for the BastionHostsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/BastionHostListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewBastionHostsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type BastionHostsClientBeginCreateOrUpdateOptions

type BastionHostsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BastionHostsClientBeginCreateOrUpdateOptions contains the optional parameters for the BastionHostsClient.BeginCreateOrUpdate method.

type BastionHostsClientBeginDeleteOptions

type BastionHostsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BastionHostsClientBeginDeleteOptions contains the optional parameters for the BastionHostsClient.BeginDelete method.

type BastionHostsClientBeginUpdateTagsOptions

type BastionHostsClientBeginUpdateTagsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

BastionHostsClientBeginUpdateTagsOptions contains the optional parameters for the BastionHostsClient.BeginUpdateTags method.

type BastionHostsClientCreateOrUpdateResponse

type BastionHostsClientCreateOrUpdateResponse struct {
	BastionHost
}

BastionHostsClientCreateOrUpdateResponse contains the response from method BastionHostsClient.CreateOrUpdate.

type BastionHostsClientDeleteResponse

type BastionHostsClientDeleteResponse struct {
}

BastionHostsClientDeleteResponse contains the response from method BastionHostsClient.Delete.

type BastionHostsClientGetOptions

type BastionHostsClientGetOptions struct {
}

BastionHostsClientGetOptions contains the optional parameters for the BastionHostsClient.Get method.

type BastionHostsClientGetResponse

type BastionHostsClientGetResponse struct {
	BastionHost
}

BastionHostsClientGetResponse contains the response from method BastionHostsClient.Get.

type BastionHostsClientListByResourceGroupOptions

type BastionHostsClientListByResourceGroupOptions struct {
}

BastionHostsClientListByResourceGroupOptions contains the optional parameters for the BastionHostsClient.ListByResourceGroup method.

type BastionHostsClientListByResourceGroupResponse

type BastionHostsClientListByResourceGroupResponse struct {
	BastionHostListResult
}

BastionHostsClientListByResourceGroupResponse contains the response from method BastionHostsClient.ListByResourceGroup.

type BastionHostsClientListOptions

type BastionHostsClientListOptions struct {
}

BastionHostsClientListOptions contains the optional parameters for the BastionHostsClient.List method.

type BastionHostsClientListResponse

type BastionHostsClientListResponse struct {
	BastionHostListResult
}

BastionHostsClientListResponse contains the response from method BastionHostsClient.List.

type BastionHostsClientUpdateTagsResponse

type BastionHostsClientUpdateTagsResponse struct {
	BastionHost
}

BastionHostsClientUpdateTagsResponse contains the response 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.

func (*BastionSessionDeleteResult) UnmarshalJSON

func (b *BastionSessionDeleteResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (BastionSessionState) MarshalJSON

func (b BastionSessionState) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionSessionState.

func (*BastionSessionState) UnmarshalJSON

func (b *BastionSessionState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BastionSessionState.

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.

func (BastionShareableLink) MarshalJSON

func (b BastionShareableLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BastionShareableLink.

func (*BastionShareableLink) UnmarshalJSON

func (b *BastionShareableLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BastionShareableLink.

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.

func (*BastionShareableLinkListRequest) UnmarshalJSON

func (b *BastionShareableLinkListRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*BastionShareableLinkListResult) UnmarshalJSON

func (b *BastionShareableLinkListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (BgpConnection) MarshalJSON

func (b BgpConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BgpConnection.

func (*BgpConnection) UnmarshalJSON

func (b *BgpConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BgpConnection.

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.

func (BgpConnectionProperties) MarshalJSON

func (b BgpConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BgpConnectionProperties.

func (*BgpConnectionProperties) UnmarshalJSON

func (b *BgpConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BgpConnectionProperties.

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.

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.

func (BgpPeerStatus) MarshalJSON

func (b BgpPeerStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BgpPeerStatus.

func (*BgpPeerStatus) UnmarshalJSON

func (b *BgpPeerStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BgpPeerStatus.

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.

func (*BgpPeerStatusListResult) UnmarshalJSON

func (b *BgpPeerStatusListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) NewListPager

NewListPager - Gets all the available bgp service communities. Generated from API version 2022-05-01 options - BgpServiceCommunitiesClientListOptions contains the optional parameters for the BgpServiceCommunitiesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceCommunityList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewBgpServiceCommunitiesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type BgpServiceCommunitiesClientListOptions

type BgpServiceCommunitiesClientListOptions struct {
}

BgpServiceCommunitiesClientListOptions contains the optional parameters for the BgpServiceCommunitiesClient.List method.

type BgpServiceCommunitiesClientListResponse

type BgpServiceCommunitiesClientListResponse struct {
	BgpServiceCommunityListResult
}

BgpServiceCommunitiesClientListResponse contains the response 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.

func (*BgpServiceCommunity) UnmarshalJSON

func (b *BgpServiceCommunity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*BgpServiceCommunityListResult) UnmarshalJSON

func (b *BgpServiceCommunityListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*BgpServiceCommunityPropertiesFormat) UnmarshalJSON

func (b *BgpServiceCommunityPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*BgpSettings) UnmarshalJSON

func (b *BgpSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (BreakOutCategoryPolicies) MarshalJSON

func (b BreakOutCategoryPolicies) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BreakOutCategoryPolicies.

func (*BreakOutCategoryPolicies) UnmarshalJSON

func (b *BreakOutCategoryPolicies) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BreakOutCategoryPolicies.

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.

func (CheckPrivateLinkServiceVisibilityRequest) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type CheckPrivateLinkServiceVisibilityRequest.

func (*CheckPrivateLinkServiceVisibilityRequest) UnmarshalJSON

func (c *CheckPrivateLinkServiceVisibilityRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckPrivateLinkServiceVisibilityRequest.

type ChildResource

type ChildResource struct {
	// 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"`
}

ChildResource - Proxy resource representation.

func (ChildResource) MarshalJSON

func (c ChildResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ChildResource.

func (*ChildResource) UnmarshalJSON

func (c *ChildResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ChildResource.

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.

type CommissionedState

type CommissionedState string

CommissionedState - The commissioned state of the Custom IP Prefix.

const (
	CommissionedStateCommissioned                    CommissionedState = "Commissioned"
	CommissionedStateCommissionedNoInternetAdvertise CommissionedState = "CommissionedNoInternetAdvertise"
	CommissionedStateCommissioning                   CommissionedState = "Commissioning"
	CommissionedStateDecommissioning                 CommissionedState = "Decommissioning"
	CommissionedStateDeprovisioned                   CommissionedState = "Deprovisioned"
	CommissionedStateDeprovisioning                  CommissionedState = "Deprovisioning"
	CommissionedStateProvisioned                     CommissionedState = "Provisioned"
	CommissionedStateProvisioning                    CommissionedState = "Provisioning"
)

func PossibleCommissionedStateValues

func PossibleCommissionedStateValues() []CommissionedState

PossibleCommissionedStateValues returns the possible values for the CommissionedState const type.

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

func (Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties.

func (*Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties.

type ConfigurationDiagnosticParameters

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

func (c ConfigurationDiagnosticParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationDiagnosticParameters.

func (*ConfigurationDiagnosticParameters) UnmarshalJSON

func (c *ConfigurationDiagnosticParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationDiagnosticParameters.

type ConfigurationDiagnosticProfile

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.

func (ConfigurationDiagnosticProfile) MarshalJSON

func (c ConfigurationDiagnosticProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationDiagnosticProfile.

func (*ConfigurationDiagnosticProfile) UnmarshalJSON

func (c *ConfigurationDiagnosticProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationDiagnosticProfile.

type ConfigurationDiagnosticResponse

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

func (c ConfigurationDiagnosticResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationDiagnosticResponse.

func (*ConfigurationDiagnosticResponse) UnmarshalJSON

func (c *ConfigurationDiagnosticResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationDiagnosticResponse.

type ConfigurationDiagnosticResult

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.

func (ConfigurationDiagnosticResult) MarshalJSON

func (c ConfigurationDiagnosticResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationDiagnosticResult.

func (*ConfigurationDiagnosticResult) UnmarshalJSON

func (c *ConfigurationDiagnosticResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationDiagnosticResult.

type ConfigurationGroup

type ConfigurationGroup struct {
	// Network group ID.
	ID *string `json:"id,omitempty"`

	// The network configuration group properties
	Properties *GroupProperties `json:"properties,omitempty"`
}

ConfigurationGroup - The network configuration group resource

func (ConfigurationGroup) MarshalJSON

func (c ConfigurationGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationGroup.

func (*ConfigurationGroup) UnmarshalJSON

func (c *ConfigurationGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationGroup.

type ConfigurationPolicyGroupsClient

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

ConfigurationPolicyGroupsClient contains the methods for the ConfigurationPolicyGroups group. Don't use this type directly, use NewConfigurationPolicyGroupsClient() instead.

func NewConfigurationPolicyGroupsClient

func NewConfigurationPolicyGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConfigurationPolicyGroupsClient, error)

NewConfigurationPolicyGroupsClient creates a new instance of ConfigurationPolicyGroupsClient 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 (*ConfigurationPolicyGroupsClient) BeginCreateOrUpdate

func (client *ConfigurationPolicyGroupsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, vpnServerConfigurationName string, configurationPolicyGroupName string, vpnServerConfigurationPolicyGroupParameters VPNServerConfigurationPolicyGroup, options *ConfigurationPolicyGroupsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ConfigurationPolicyGroupsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a ConfigurationPolicyGroup if it doesn't exist else updates the existing one. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the ConfigurationPolicyGroup. vpnServerConfigurationName - The name of the VpnServerConfiguration. configurationPolicyGroupName - The name of the ConfigurationPolicyGroup. vpnServerConfigurationPolicyGroupParameters - Parameters supplied to create or update a VpnServerConfiguration PolicyGroup. options - ConfigurationPolicyGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the ConfigurationPolicyGroupsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ConfigurationPolicyGroupPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConfigurationPolicyGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "vpnServerConfiguration1", "policyGroup1", armnetwork.VPNServerConfigurationPolicyGroup{
	Properties: &armnetwork.VPNServerConfigurationPolicyGroupProperties{
		IsDefault: to.Ptr(true),
		PolicyMembers: []*armnetwork.VPNServerConfigurationPolicyGroupMember{
			{
				Name:           to.Ptr("policy1"),
				AttributeType:  to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeRadiusAzureGroupID),
				AttributeValue: to.Ptr("6ad1bd08"),
			},
			{
				Name:           to.Ptr("policy2"),
				AttributeType:  to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeCertificateGroupID),
				AttributeValue: to.Ptr("red.com"),
			}},
		Priority: to.Ptr[int32](0),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ConfigurationPolicyGroupsClient) BeginDelete

func (client *ConfigurationPolicyGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, vpnServerConfigurationName string, configurationPolicyGroupName string, options *ConfigurationPolicyGroupsClientBeginDeleteOptions) (*runtime.Poller[ConfigurationPolicyGroupsClientDeleteResponse], error)

BeginDelete - Deletes a ConfigurationPolicyGroup. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the ConfigurationPolicyGroup. vpnServerConfigurationName - The name of the VpnServerConfiguration. configurationPolicyGroupName - The name of the ConfigurationPolicyGroup. options - ConfigurationPolicyGroupsClientBeginDeleteOptions contains the optional parameters for the ConfigurationPolicyGroupsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ConfigurationPolicyGroupDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConfigurationPolicyGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "vpnServerConfiguration1", "policyGroup1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ConfigurationPolicyGroupsClient) Get

func (client *ConfigurationPolicyGroupsClient) Get(ctx context.Context, resourceGroupName string, vpnServerConfigurationName string, configurationPolicyGroupName string, options *ConfigurationPolicyGroupsClientGetOptions) (ConfigurationPolicyGroupsClientGetResponse, error)

Get - Retrieves the details of a ConfigurationPolicyGroup. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the VpnServerConfiguration. vpnServerConfigurationName - The name of the VpnServerConfiguration. configurationPolicyGroupName - The name of the ConfigurationPolicyGroup being retrieved. options - ConfigurationPolicyGroupsClientGetOptions contains the optional parameters for the ConfigurationPolicyGroupsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ConfigurationPolicyGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConfigurationPolicyGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "vpnServerConfiguration1", "policyGroup1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ConfigurationPolicyGroupsClient) NewListByVPNServerConfigurationPager

NewListByVPNServerConfigurationPager - Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the VpnServerConfiguration. vpnServerConfigurationName - The name of the VpnServerConfiguration. options - ConfigurationPolicyGroupsClientListByVPNServerConfigurationOptions contains the optional parameters for the ConfigurationPolicyGroupsClient.ListByVPNServerConfiguration method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConfigurationPolicyGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByVPNServerConfigurationPager("rg1", "vpnServerConfiguration1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ConfigurationPolicyGroupsClientBeginCreateOrUpdateOptions

type ConfigurationPolicyGroupsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConfigurationPolicyGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the ConfigurationPolicyGroupsClient.BeginCreateOrUpdate method.

type ConfigurationPolicyGroupsClientBeginDeleteOptions

type ConfigurationPolicyGroupsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConfigurationPolicyGroupsClientBeginDeleteOptions contains the optional parameters for the ConfigurationPolicyGroupsClient.BeginDelete method.

type ConfigurationPolicyGroupsClientCreateOrUpdateResponse

type ConfigurationPolicyGroupsClientCreateOrUpdateResponse struct {
	VPNServerConfigurationPolicyGroup
}

ConfigurationPolicyGroupsClientCreateOrUpdateResponse contains the response from method ConfigurationPolicyGroupsClient.CreateOrUpdate.

type ConfigurationPolicyGroupsClientDeleteResponse

type ConfigurationPolicyGroupsClientDeleteResponse struct {
}

ConfigurationPolicyGroupsClientDeleteResponse contains the response from method ConfigurationPolicyGroupsClient.Delete.

type ConfigurationPolicyGroupsClientGetOptions

type ConfigurationPolicyGroupsClientGetOptions struct {
}

ConfigurationPolicyGroupsClientGetOptions contains the optional parameters for the ConfigurationPolicyGroupsClient.Get method.

type ConfigurationPolicyGroupsClientGetResponse

type ConfigurationPolicyGroupsClientGetResponse struct {
	VPNServerConfigurationPolicyGroup
}

ConfigurationPolicyGroupsClientGetResponse contains the response from method ConfigurationPolicyGroupsClient.Get.

type ConfigurationPolicyGroupsClientListByVPNServerConfigurationOptions

type ConfigurationPolicyGroupsClientListByVPNServerConfigurationOptions struct {
}

ConfigurationPolicyGroupsClientListByVPNServerConfigurationOptions contains the optional parameters for the ConfigurationPolicyGroupsClient.ListByVPNServerConfiguration method.

type ConfigurationPolicyGroupsClientListByVPNServerConfigurationResponse

type ConfigurationPolicyGroupsClientListByVPNServerConfigurationResponse struct {
	ListVPNServerConfigurationPolicyGroupsResult
}

ConfigurationPolicyGroupsClientListByVPNServerConfigurationResponse contains the response from method ConfigurationPolicyGroupsClient.ListByVPNServerConfiguration.

type ConfigurationType

type ConfigurationType string

ConfigurationType - Configuration Deployment Type.

const (
	ConfigurationTypeConnectivity  ConfigurationType = "Connectivity"
	ConfigurationTypeSecurityAdmin ConfigurationType = "SecurityAdmin"
)

func PossibleConfigurationTypeValues

func PossibleConfigurationTypeValues() []ConfigurationType

PossibleConfigurationTypeValues returns the possible values for the ConfigurationType const type.

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.

func (*ConnectionMonitor) UnmarshalJSON

func (c *ConnectionMonitor) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ConnectionMonitorDestination) MarshalJSON

func (c ConnectionMonitorDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorDestination.

func (*ConnectionMonitorDestination) UnmarshalJSON

func (c *ConnectionMonitorDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorDestination.

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.

func (ConnectionMonitorEndpoint) MarshalJSON

func (c ConnectionMonitorEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorEndpoint.

func (*ConnectionMonitorEndpoint) UnmarshalJSON

func (c *ConnectionMonitorEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorEndpoint.

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.

func (*ConnectionMonitorEndpointFilter) UnmarshalJSON

func (c *ConnectionMonitorEndpointFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ConnectionMonitorEndpointFilterItem) MarshalJSON

func (c ConnectionMonitorEndpointFilterItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorEndpointFilterItem.

func (*ConnectionMonitorEndpointFilterItem) UnmarshalJSON

func (c *ConnectionMonitorEndpointFilterItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorEndpointFilterItem.

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.

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.

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.

func (*ConnectionMonitorEndpointScope) UnmarshalJSON

func (c *ConnectionMonitorEndpointScope) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ConnectionMonitorEndpointScopeItem) MarshalJSON

func (c ConnectionMonitorEndpointScopeItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorEndpointScopeItem.

func (*ConnectionMonitorEndpointScopeItem) UnmarshalJSON

func (c *ConnectionMonitorEndpointScopeItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorEndpointScopeItem.

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.

func (*ConnectionMonitorHTTPConfiguration) UnmarshalJSON

func (c *ConnectionMonitorHTTPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ConnectionMonitorIcmpConfiguration) MarshalJSON

func (c ConnectionMonitorIcmpConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorIcmpConfiguration.

func (*ConnectionMonitorIcmpConfiguration) UnmarshalJSON

func (c *ConnectionMonitorIcmpConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorIcmpConfiguration.

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.

func (*ConnectionMonitorListResult) UnmarshalJSON

func (c *ConnectionMonitorListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ConnectionMonitorOutput) MarshalJSON

func (c ConnectionMonitorOutput) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorOutput.

func (*ConnectionMonitorOutput) UnmarshalJSON

func (c *ConnectionMonitorOutput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorOutput.

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.

func (*ConnectionMonitorParameters) UnmarshalJSON

func (c *ConnectionMonitorParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ConnectionMonitorQueryResult) UnmarshalJSON

func (c *ConnectionMonitorQueryResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ConnectionMonitorResult) UnmarshalJSON

func (c *ConnectionMonitorResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ConnectionMonitorSource) MarshalJSON

func (c ConnectionMonitorSource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorSource.

func (*ConnectionMonitorSource) UnmarshalJSON

func (c *ConnectionMonitorSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorSource.

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.

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.

func (ConnectionMonitorSuccessThreshold) MarshalJSON

func (c ConnectionMonitorSuccessThreshold) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorSuccessThreshold.

func (*ConnectionMonitorSuccessThreshold) UnmarshalJSON

func (c *ConnectionMonitorSuccessThreshold) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorSuccessThreshold.

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.

func (ConnectionMonitorTCPConfiguration) MarshalJSON

func (c ConnectionMonitorTCPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorTCPConfiguration.

func (*ConnectionMonitorTCPConfiguration) UnmarshalJSON

func (c *ConnectionMonitorTCPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorTCPConfiguration.

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.

func (ConnectionMonitorTestConfiguration) MarshalJSON

func (c ConnectionMonitorTestConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorTestConfiguration.

func (*ConnectionMonitorTestConfiguration) UnmarshalJSON

func (c *ConnectionMonitorTestConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorTestConfiguration.

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.

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.

func (*ConnectionMonitorTestGroup) UnmarshalJSON

func (c *ConnectionMonitorTestGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (ConnectionMonitorWorkspaceSettings) MarshalJSON

func (c ConnectionMonitorWorkspaceSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionMonitorWorkspaceSettings.

func (*ConnectionMonitorWorkspaceSettings) UnmarshalJSON

func (c *ConnectionMonitorWorkspaceSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionMonitorWorkspaceSettings.

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, error)

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) (*runtime.Poller[ConnectionMonitorsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a connection monitor. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateConnectionMonitorV1)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherConnectionMonitorCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectionMonitorsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "nw1", "cm1", armnetwork.ConnectionMonitor{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.ConnectionMonitorParameters{
		Endpoints: []*armnetwork.ConnectionMonitorEndpoint{
			{
				Name:       to.Ptr("source"),
				ResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1"),
			},
			{
				Name:    to.Ptr("destination"),
				Address: to.Ptr("bing.com"),
			}},
		TestConfigurations: []*armnetwork.ConnectionMonitorTestConfiguration{
			{
				Name: to.Ptr("tcp"),
				TCPConfiguration: &armnetwork.ConnectionMonitorTCPConfiguration{
					Port: to.Ptr[int32](80),
				},
				TestFrequencySec: to.Ptr[int32](60),
				Protocol:         to.Ptr(armnetwork.ConnectionMonitorTestConfigurationProtocolTCP),
			}},
		TestGroups: []*armnetwork.ConnectionMonitorTestGroup{
			{
				Name: to.Ptr("tg"),
				Destinations: []*string{
					to.Ptr("destination")},
				Sources: []*string{
					to.Ptr("source")},
				TestConfigurations: []*string{
					to.Ptr("tcp")},
			}},
	},
}, &armnetwork.ConnectionMonitorsClientBeginCreateOrUpdateOptions{Migrate: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateConnectionMonitorV2)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherConnectionMonitorV2Create.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectionMonitorsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "nw1", "cm1", armnetwork.ConnectionMonitor{
	Properties: &armnetwork.ConnectionMonitorParameters{
		Endpoints: []*armnetwork.ConnectionMonitorEndpoint{
			{
				Name:       to.Ptr("vm1"),
				ResourceID: to.Ptr("/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NwRgIrinaCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm1"),
			},
			{
				Name: to.Ptr("CanaryWorkspaceVamshi"),
				Filter: &armnetwork.ConnectionMonitorEndpointFilter{
					Type: to.Ptr(armnetwork.ConnectionMonitorEndpointFilterTypeInclude),
					Items: []*armnetwork.ConnectionMonitorEndpointFilterItem{
						{
							Type:    to.Ptr(armnetwork.ConnectionMonitorEndpointFilterItemTypeAgentAddress),
							Address: to.Ptr("npmuser"),
						}},
				},
				ResourceID: to.Ptr("/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/vasamudrRG/providers/Microsoft.OperationalInsights/workspaces/vasamudrWorkspace"),
			},
			{
				Name:    to.Ptr("bing"),
				Address: to.Ptr("bing.com"),
			},
			{
				Name:    to.Ptr("google"),
				Address: to.Ptr("google.com"),
			}},
		Outputs: []*armnetwork.ConnectionMonitorOutput{},
		TestConfigurations: []*armnetwork.ConnectionMonitorTestConfiguration{
			{
				Name: to.Ptr("testConfig1"),
				TCPConfiguration: &armnetwork.ConnectionMonitorTCPConfiguration{
					DisableTraceRoute: to.Ptr(false),
					Port:              to.Ptr[int32](80),
				},
				TestFrequencySec: to.Ptr[int32](60),
				Protocol:         to.Ptr(armnetwork.ConnectionMonitorTestConfigurationProtocolTCP),
			}},
		TestGroups: []*armnetwork.ConnectionMonitorTestGroup{
			{
				Name: to.Ptr("test1"),
				Destinations: []*string{
					to.Ptr("bing"),
					to.Ptr("google")},
				Disable: to.Ptr(false),
				Sources: []*string{
					to.Ptr("vm1"),
					to.Ptr("CanaryWorkspaceVamshi")},
				TestConfigurations: []*string{
					to.Ptr("testConfig1")},
			}},
	},
}, &armnetwork.ConnectionMonitorsClientBeginCreateOrUpdateOptions{Migrate: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ConnectionMonitorsClient) BeginDelete

func (client *ConnectionMonitorsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, options *ConnectionMonitorsClientBeginDeleteOptions) (*runtime.Poller[ConnectionMonitorsClientDeleteResponse], error)

BeginDelete - Deletes the specified connection monitor. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherConnectionMonitorDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectionMonitorsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "nw1", "cm1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ConnectionMonitorsClient) BeginQuery

func (client *ConnectionMonitorsClient) BeginQuery(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, options *ConnectionMonitorsClientBeginQueryOptions) (*runtime.Poller[ConnectionMonitorsClientQueryResponse], error)

BeginQuery - Query a snapshot of the most recent connection states. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherConnectionMonitorQuery.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectionMonitorsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginQuery(ctx, "rg1", "nw1", "cm1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ConnectionMonitorsClient) BeginStart

func (client *ConnectionMonitorsClient) BeginStart(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, options *ConnectionMonitorsClientBeginStartOptions) (*runtime.Poller[ConnectionMonitorsClientStartResponse], error)

BeginStart - Starts the specified connection monitor. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherConnectionMonitorStart.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectionMonitorsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStart(ctx, "rg1", "nw1", "cm1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ConnectionMonitorsClient) BeginStop

func (client *ConnectionMonitorsClient) BeginStop(ctx context.Context, resourceGroupName string, networkWatcherName string, connectionMonitorName string, options *ConnectionMonitorsClientBeginStopOptions) (*runtime.Poller[ConnectionMonitorsClientStopResponse], error)

BeginStop - Stops the specified connection monitor. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherConnectionMonitorStop.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectionMonitorsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStop(ctx, "rg1", "nw1", "cm1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherConnectionMonitorGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectionMonitorsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "nw1", "cm1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ConnectionMonitorsClient) NewListPager

func (client *ConnectionMonitorsClient) NewListPager(resourceGroupName string, networkWatcherName string, options *ConnectionMonitorsClientListOptions) *runtime.Pager[ConnectionMonitorsClientListResponse]

NewListPager - Lists all connection monitors for the specified Network Watcher. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherConnectionMonitorList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectionMonitorsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "nw1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectionMonitorsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "nw1", "cm1", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ConnectionMonitorsClientBeginCreateOrUpdateOptions

type ConnectionMonitorsClientBeginCreateOrUpdateOptions struct {
	// Value indicating whether connection monitor V1 should be migrated to V2 format.
	Migrate *string
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConnectionMonitorsClientBeginCreateOrUpdateOptions contains the optional parameters for the ConnectionMonitorsClient.BeginCreateOrUpdate method.

type ConnectionMonitorsClientBeginDeleteOptions

type ConnectionMonitorsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConnectionMonitorsClientBeginDeleteOptions contains the optional parameters for the ConnectionMonitorsClient.BeginDelete method.

type ConnectionMonitorsClientBeginQueryOptions

type ConnectionMonitorsClientBeginQueryOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConnectionMonitorsClientBeginQueryOptions contains the optional parameters for the ConnectionMonitorsClient.BeginQuery method.

type ConnectionMonitorsClientBeginStartOptions

type ConnectionMonitorsClientBeginStartOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConnectionMonitorsClientBeginStartOptions contains the optional parameters for the ConnectionMonitorsClient.BeginStart method.

type ConnectionMonitorsClientBeginStopOptions

type ConnectionMonitorsClientBeginStopOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConnectionMonitorsClientBeginStopOptions contains the optional parameters for the ConnectionMonitorsClient.BeginStop method.

type ConnectionMonitorsClientCreateOrUpdateResponse

type ConnectionMonitorsClientCreateOrUpdateResponse struct {
	ConnectionMonitorResult
}

ConnectionMonitorsClientCreateOrUpdateResponse contains the response from method ConnectionMonitorsClient.CreateOrUpdate.

type ConnectionMonitorsClientDeleteResponse

type ConnectionMonitorsClientDeleteResponse struct {
}

ConnectionMonitorsClientDeleteResponse contains the response from method ConnectionMonitorsClient.Delete.

type ConnectionMonitorsClientGetOptions

type ConnectionMonitorsClientGetOptions struct {
}

ConnectionMonitorsClientGetOptions contains the optional parameters for the ConnectionMonitorsClient.Get method.

type ConnectionMonitorsClientGetResponse

type ConnectionMonitorsClientGetResponse struct {
	ConnectionMonitorResult
}

ConnectionMonitorsClientGetResponse contains the response from method ConnectionMonitorsClient.Get.

type ConnectionMonitorsClientListOptions

type ConnectionMonitorsClientListOptions struct {
}

ConnectionMonitorsClientListOptions contains the optional parameters for the ConnectionMonitorsClient.List method.

type ConnectionMonitorsClientListResponse

type ConnectionMonitorsClientListResponse struct {
	ConnectionMonitorListResult
}

ConnectionMonitorsClientListResponse contains the response from method ConnectionMonitorsClient.List.

type ConnectionMonitorsClientQueryResponse

type ConnectionMonitorsClientQueryResponse struct {
	ConnectionMonitorQueryResult
}

ConnectionMonitorsClientQueryResponse contains the response from method ConnectionMonitorsClient.Query.

type ConnectionMonitorsClientStartResponse

type ConnectionMonitorsClientStartResponse struct {
}

ConnectionMonitorsClientStartResponse contains the response from method ConnectionMonitorsClient.Start.

type ConnectionMonitorsClientStopResponse

type ConnectionMonitorsClientStopResponse struct {
}

ConnectionMonitorsClientStopResponse contains the response from method ConnectionMonitorsClient.Stop.

type ConnectionMonitorsClientUpdateTagsOptions

type ConnectionMonitorsClientUpdateTagsOptions struct {
}

ConnectionMonitorsClientUpdateTagsOptions contains the optional parameters for the ConnectionMonitorsClient.UpdateTags method.

type ConnectionMonitorsClientUpdateTagsResponse

type ConnectionMonitorsClientUpdateTagsResponse struct {
	ConnectionMonitorResult
}

ConnectionMonitorsClientUpdateTagsResponse contains the response 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.

func (ConnectionResetSharedKey) MarshalJSON

func (c ConnectionResetSharedKey) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionResetSharedKey.

func (*ConnectionResetSharedKey) UnmarshalJSON

func (c *ConnectionResetSharedKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionResetSharedKey.

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.

func (ConnectionSharedKey) MarshalJSON

func (c ConnectionSharedKey) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionSharedKey.

func (*ConnectionSharedKey) UnmarshalJSON

func (c *ConnectionSharedKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionSharedKey.

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.

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.

type ConnectivityConfiguration

type ConnectivityConfiguration struct {
	// Properties of a network manager connectivity configuration
	Properties *ConnectivityConfigurationProperties `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 ID.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

ConnectivityConfiguration - The network manager connectivity configuration resource

func (ConnectivityConfiguration) MarshalJSON

func (c ConnectivityConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityConfiguration.

func (*ConnectivityConfiguration) UnmarshalJSON

func (c *ConnectivityConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectivityConfiguration.

type ConnectivityConfigurationListResult

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

	// Gets a page of Connectivity Configurations
	Value []*ConnectivityConfiguration `json:"value,omitempty"`
}

ConnectivityConfigurationListResult - Result of the request to list network manager connectivity configurations. It contains a list of configurations and a link to get the next set of results.

func (ConnectivityConfigurationListResult) MarshalJSON

func (c ConnectivityConfigurationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityConfigurationListResult.

func (*ConnectivityConfigurationListResult) UnmarshalJSON

func (c *ConnectivityConfigurationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectivityConfigurationListResult.

type ConnectivityConfigurationProperties

type ConnectivityConfigurationProperties struct {
	// REQUIRED; Groups for configuration
	AppliesToGroups []*ConnectivityGroupItem `json:"appliesToGroups,omitempty"`

	// REQUIRED; Connectivity topology type.
	ConnectivityTopology *ConnectivityTopology `json:"connectivityTopology,omitempty"`

	// Flag if need to remove current existing peerings.
	DeleteExistingPeering *DeleteExistingPeering `json:"deleteExistingPeering,omitempty"`

	// A description of the connectivity configuration.
	Description *string `json:"description,omitempty"`

	// List of hubItems
	Hubs []*Hub `json:"hubs,omitempty"`

	// Flag if global mesh is supported.
	IsGlobal *IsGlobal `json:"isGlobal,omitempty"`

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

ConnectivityConfigurationProperties - Properties of network manager connectivity configuration

func (ConnectivityConfigurationProperties) MarshalJSON

func (c ConnectivityConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityConfigurationProperties.

func (*ConnectivityConfigurationProperties) UnmarshalJSON

func (c *ConnectivityConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectivityConfigurationProperties.

type ConnectivityConfigurationsClient

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

ConnectivityConfigurationsClient contains the methods for the ConnectivityConfigurations group. Don't use this type directly, use NewConnectivityConfigurationsClient() instead.

func NewConnectivityConfigurationsClient

func NewConnectivityConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConnectivityConfigurationsClient, error)

NewConnectivityConfigurationsClient creates a new instance of ConnectivityConfigurationsClient 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 (*ConnectivityConfigurationsClient) BeginDelete

BeginDelete - Deletes a network manager connectivity configuration, specified by the resource group, network manager name, and connectivity configuration name If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager connectivity configuration. options - ConnectivityConfigurationsClientBeginDeleteOptions contains the optional parameters for the ConnectivityConfigurationsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectivityConfigurationDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectivityConfigurationsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "myResourceGroup", "testNetworkManager", "myTestConnectivityConfig", &armnetwork.ConnectivityConfigurationsClientBeginDeleteOptions{Force: to.Ptr(false)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ConnectivityConfigurationsClient) CreateOrUpdate

func (client *ConnectivityConfigurationsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkManagerName string, configurationName string, connectivityConfiguration ConnectivityConfiguration, options *ConnectivityConfigurationsClientCreateOrUpdateOptions) (ConnectivityConfigurationsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates/Updates a new network manager connectivity configuration If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager connectivity configuration. connectivityConfiguration - Parameters supplied to create/update a network manager connectivity configuration options - ConnectivityConfigurationsClientCreateOrUpdateOptions contains the optional parameters for the ConnectivityConfigurationsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectivityConfigurationPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectivityConfigurationsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "myResourceGroup", "testNetworkManager", "myTestConnectivityConfig", armnetwork.ConnectivityConfiguration{
	Properties: &armnetwork.ConnectivityConfigurationProperties{
		Description: to.Ptr("Sample Configuration"),
		AppliesToGroups: []*armnetwork.ConnectivityGroupItem{
			{
				GroupConnectivity: to.Ptr(armnetwork.GroupConnectivityNone),
				IsGlobal:          to.Ptr(armnetwork.IsGlobalFalse),
				NetworkGroupID:    to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1"),
				UseHubGateway:     to.Ptr(armnetwork.UseHubGatewayTrue),
			}},
		ConnectivityTopology:  to.Ptr(armnetwork.ConnectivityTopologyHubAndSpoke),
		DeleteExistingPeering: to.Ptr(armnetwork.DeleteExistingPeeringTrue),
		Hubs: []*armnetwork.Hub{
			{
				ResourceID:   to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig"),
				ResourceType: to.Ptr("Microsoft.Network/virtualNetworks"),
			}},
		IsGlobal: to.Ptr(armnetwork.IsGlobalTrue),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ConnectivityConfigurationsClient) Get

func (client *ConnectivityConfigurationsClient) Get(ctx context.Context, resourceGroupName string, networkManagerName string, configurationName string, options *ConnectivityConfigurationsClientGetOptions) (ConnectivityConfigurationsClientGetResponse, error)

Get - Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager connectivity configuration. options - ConnectivityConfigurationsClientGetOptions contains the optional parameters for the ConnectivityConfigurationsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectivityConfigurationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectivityConfigurationsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myResourceGroup", "testNetworkManager", "myTestConnectivityConfig", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ConnectivityConfigurationsClient) NewListPager

NewListPager - Lists all the network manager connectivity configuration in a specified network manager. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. options - ConnectivityConfigurationsClientListOptions contains the optional parameters for the ConnectivityConfigurationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectivityConfigurationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewConnectivityConfigurationsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("myResourceGroup", "testNetworkManager", &armnetwork.ConnectivityConfigurationsClientListOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ConnectivityConfigurationsClientBeginDeleteOptions

type ConnectivityConfigurationsClientBeginDeleteOptions struct {
	// Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service
	// will do a cleanup deployment in the background, prior to the delete.
	Force *bool
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConnectivityConfigurationsClientBeginDeleteOptions contains the optional parameters for the ConnectivityConfigurationsClient.BeginDelete method.

type ConnectivityConfigurationsClientCreateOrUpdateOptions

type ConnectivityConfigurationsClientCreateOrUpdateOptions struct {
}

ConnectivityConfigurationsClientCreateOrUpdateOptions contains the optional parameters for the ConnectivityConfigurationsClient.CreateOrUpdate method.

type ConnectivityConfigurationsClientCreateOrUpdateResponse

type ConnectivityConfigurationsClientCreateOrUpdateResponse struct {
	ConnectivityConfiguration
}

ConnectivityConfigurationsClientCreateOrUpdateResponse contains the response from method ConnectivityConfigurationsClient.CreateOrUpdate.

type ConnectivityConfigurationsClientDeleteResponse

type ConnectivityConfigurationsClientDeleteResponse struct {
}

ConnectivityConfigurationsClientDeleteResponse contains the response from method ConnectivityConfigurationsClient.Delete.

type ConnectivityConfigurationsClientGetOptions

type ConnectivityConfigurationsClientGetOptions struct {
}

ConnectivityConfigurationsClientGetOptions contains the optional parameters for the ConnectivityConfigurationsClient.Get method.

type ConnectivityConfigurationsClientGetResponse

type ConnectivityConfigurationsClientGetResponse struct {
	ConnectivityConfiguration
}

ConnectivityConfigurationsClientGetResponse contains the response from method ConnectivityConfigurationsClient.Get.

type ConnectivityConfigurationsClientListOptions

type ConnectivityConfigurationsClientListOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

ConnectivityConfigurationsClientListOptions contains the optional parameters for the ConnectivityConfigurationsClient.List method.

type ConnectivityConfigurationsClientListResponse

type ConnectivityConfigurationsClientListResponse struct {
	ConnectivityConfigurationListResult
}

ConnectivityConfigurationsClientListResponse contains the response from method ConnectivityConfigurationsClient.List.

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.

func (ConnectivityDestination) MarshalJSON

func (c ConnectivityDestination) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityDestination.

func (*ConnectivityDestination) UnmarshalJSON

func (c *ConnectivityDestination) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectivityDestination.

type ConnectivityGroupItem

type ConnectivityGroupItem struct {
	// REQUIRED; Group connectivity type.
	GroupConnectivity *GroupConnectivity `json:"groupConnectivity,omitempty"`

	// REQUIRED; Network group Id.
	NetworkGroupID *string `json:"networkGroupId,omitempty"`

	// Flag if global is supported.
	IsGlobal *IsGlobal `json:"isGlobal,omitempty"`

	// Flag if need to use hub gateway.
	UseHubGateway *UseHubGateway `json:"useHubGateway,omitempty"`
}

ConnectivityGroupItem - Connectivity group item.

func (ConnectivityGroupItem) MarshalJSON

func (c ConnectivityGroupItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityGroupItem.

func (*ConnectivityGroupItem) UnmarshalJSON

func (c *ConnectivityGroupItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectivityGroupItem.

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.

func (*ConnectivityHop) UnmarshalJSON

func (c *ConnectivityHop) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ConnectivityInformation) UnmarshalJSON

func (c *ConnectivityInformation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ConnectivityIssue) UnmarshalJSON

func (c *ConnectivityIssue) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ConnectivityParameters) MarshalJSON

func (c ConnectivityParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivityParameters.

func (*ConnectivityParameters) UnmarshalJSON

func (c *ConnectivityParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectivityParameters.

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.

func (ConnectivitySource) MarshalJSON

func (c ConnectivitySource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectivitySource.

func (*ConnectivitySource) UnmarshalJSON

func (c *ConnectivitySource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectivitySource.

type ConnectivityTopology

type ConnectivityTopology string

ConnectivityTopology - Connectivity topology type.

const (
	ConnectivityTopologyHubAndSpoke ConnectivityTopology = "HubAndSpoke"
	ConnectivityTopologyMesh        ConnectivityTopology = "Mesh"
)

func PossibleConnectivityTopologyValues

func PossibleConnectivityTopologyValues() []ConnectivityTopology

PossibleConnectivityTopologyValues returns the possible values for the ConnectivityTopology const type.

type Container

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

Container - Reference to container resource in remote resource provider.

func (Container) MarshalJSON

func (c Container) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Container.

func (*Container) UnmarshalJSON

func (c *Container) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Container.

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.

func (ContainerNetworkInterface) MarshalJSON

func (c ContainerNetworkInterface) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkInterface.

func (*ContainerNetworkInterface) UnmarshalJSON

func (c *ContainerNetworkInterface) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerNetworkInterface.

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.

func (ContainerNetworkInterfaceConfiguration) MarshalJSON

func (c ContainerNetworkInterfaceConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkInterfaceConfiguration.

func (*ContainerNetworkInterfaceConfiguration) UnmarshalJSON

func (c *ContainerNetworkInterfaceConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerNetworkInterfaceConfiguration.

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

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkInterfaceConfigurationPropertiesFormat.

func (*ContainerNetworkInterfaceConfigurationPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (ContainerNetworkInterfaceIPConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkInterfaceIPConfiguration.

func (*ContainerNetworkInterfaceIPConfiguration) UnmarshalJSON

func (c *ContainerNetworkInterfaceIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerNetworkInterfaceIPConfiguration.

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.

func (ContainerNetworkInterfaceIPConfigurationPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkInterfaceIPConfigurationPropertiesFormat.

func (*ContainerNetworkInterfaceIPConfigurationPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerNetworkInterfaceIPConfigurationPropertiesFormat.

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

MarshalJSON implements the json.Marshaller interface for type ContainerNetworkInterfacePropertiesFormat.

func (*ContainerNetworkInterfacePropertiesFormat) UnmarshalJSON

func (c *ContainerNetworkInterfacePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

type CreatedByType

type CreatedByType string

CreatedByType - The type of identity that created the resource.

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type Criterion

type Criterion struct {
	// List of AS paths which this criteria matches.
	AsPath []*string `json:"asPath,omitempty"`

	// List of BGP communities which this criteria matches.
	Community []*string `json:"community,omitempty"`

	// Match condition to apply RouteMap rules.
	MatchCondition *RouteMapMatchCondition `json:"matchCondition,omitempty"`

	// List of route prefixes which this criteria matches.
	RoutePrefix []*string `json:"routePrefix,omitempty"`
}

Criterion - A matching criteria which matches routes based on route prefix, community, and AS path.

func (Criterion) MarshalJSON

func (c Criterion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Criterion.

func (*Criterion) UnmarshalJSON

func (c *Criterion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Criterion.

type CrossTenantScopes

type CrossTenantScopes struct {
	// READ-ONLY; List of management groups.
	ManagementGroups []*string `json:"managementGroups,omitempty" azure:"ro"`

	// READ-ONLY; List of subscriptions.
	Subscriptions []*string `json:"subscriptions,omitempty" azure:"ro"`

	// READ-ONLY; Tenant ID.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

CrossTenantScopes - Cross tenant scopes.

func (CrossTenantScopes) MarshalJSON

func (c CrossTenantScopes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CrossTenantScopes.

func (*CrossTenantScopes) UnmarshalJSON

func (c *CrossTenantScopes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CrossTenantScopes.

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.

func (*CustomDNSConfigPropertiesFormat) UnmarshalJSON

func (c *CustomDNSConfigPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*CustomIPPrefix) UnmarshalJSON

func (c *CustomIPPrefix) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*CustomIPPrefixListResult) UnmarshalJSON

func (c *CustomIPPrefixListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomIPPrefixListResult.

type CustomIPPrefixPropertiesFormat

type CustomIPPrefixPropertiesFormat struct {
	// The ASN for CIDR advertising. Should be an integer as string.
	Asn *string `json:"asn,omitempty"`

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

	// Whether to do express route advertise.
	ExpressRouteAdvertise *bool `json:"expressRouteAdvertise,omitempty"`

	// The Geo for CIDR advertising. Should be an Geo code.
	Geo *Geo `json:"geo,omitempty"`

	// Whether to Advertise the range to Internet.
	NoInternetAdvertise *bool `json:"noInternetAdvertise,omitempty"`

	// Type of custom IP prefix. Should be Singular, Parent, or Child.
	PrefixType *CustomIPPrefixType `json:"prefixType,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.

func (*CustomIPPrefixPropertiesFormat) UnmarshalJSON

func (c *CustomIPPrefixPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomIPPrefixPropertiesFormat.

type CustomIPPrefixType

type CustomIPPrefixType string

CustomIPPrefixType - Type of custom IP prefix. Should be Singular, Parent, or Child.

const (
	CustomIPPrefixTypeChild    CustomIPPrefixType = "Child"
	CustomIPPrefixTypeParent   CustomIPPrefixType = "Parent"
	CustomIPPrefixTypeSingular CustomIPPrefixType = "Singular"
)

func PossibleCustomIPPrefixTypeValues

func PossibleCustomIPPrefixTypeValues() []CustomIPPrefixType

PossibleCustomIPPrefixTypeValues returns the possible values for the CustomIPPrefixType const type.

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, error)

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) (*runtime.Poller[CustomIPPrefixesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a custom IP prefix. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CustomIpPrefixCreateCustomizedValues.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewCustomIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-customipprefix", armnetwork.CustomIPPrefix{
	Location: to.Ptr("westus"),
	Properties: &armnetwork.CustomIPPrefixPropertiesFormat{
		Cidr: to.Ptr("0.0.0.0/24"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*CustomIPPrefixesClient) BeginDelete

func (client *CustomIPPrefixesClient) BeginDelete(ctx context.Context, resourceGroupName string, customIPPrefixName string, options *CustomIPPrefixesClientBeginDeleteOptions) (*runtime.Poller[CustomIPPrefixesClientDeleteResponse], error)

BeginDelete - Deletes the specified custom IP prefix. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CustomIpPrefixDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewCustomIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-customipprefix", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CustomIpPrefixGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewCustomIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "test-customipprefix", &armnetwork.CustomIPPrefixesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*CustomIPPrefixesClient) NewListAllPager

NewListAllPager - Gets all the custom IP prefixes in a subscription. Generated from API version 2022-05-01 options - CustomIPPrefixesClientListAllOptions contains the optional parameters for the CustomIPPrefixesClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CustomIpPrefixListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewCustomIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*CustomIPPrefixesClient) NewListPager

NewListPager - Gets all custom IP prefixes in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - CustomIPPrefixesClientListOptions contains the optional parameters for the CustomIPPrefixesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CustomIpPrefixList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewCustomIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CustomIpPrefixUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewCustomIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-customipprefix", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type CustomIPPrefixesClientBeginCreateOrUpdateOptions

type CustomIPPrefixesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

CustomIPPrefixesClientBeginCreateOrUpdateOptions contains the optional parameters for the CustomIPPrefixesClient.BeginCreateOrUpdate method.

type CustomIPPrefixesClientBeginDeleteOptions

type CustomIPPrefixesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

CustomIPPrefixesClientBeginDeleteOptions contains the optional parameters for the CustomIPPrefixesClient.BeginDelete method.

type CustomIPPrefixesClientCreateOrUpdateResponse

type CustomIPPrefixesClientCreateOrUpdateResponse struct {
	CustomIPPrefix
}

CustomIPPrefixesClientCreateOrUpdateResponse contains the response from method CustomIPPrefixesClient.CreateOrUpdate.

type CustomIPPrefixesClientDeleteResponse

type CustomIPPrefixesClientDeleteResponse struct {
}

CustomIPPrefixesClientDeleteResponse contains the response from method CustomIPPrefixesClient.Delete.

type CustomIPPrefixesClientGetOptions

type CustomIPPrefixesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

CustomIPPrefixesClientGetOptions contains the optional parameters for the CustomIPPrefixesClient.Get method.

type CustomIPPrefixesClientGetResponse

type CustomIPPrefixesClientGetResponse struct {
	CustomIPPrefix
}

CustomIPPrefixesClientGetResponse contains the response from method CustomIPPrefixesClient.Get.

type CustomIPPrefixesClientListAllOptions

type CustomIPPrefixesClientListAllOptions struct {
}

CustomIPPrefixesClientListAllOptions contains the optional parameters for the CustomIPPrefixesClient.ListAll method.

type CustomIPPrefixesClientListAllResponse

type CustomIPPrefixesClientListAllResponse struct {
	CustomIPPrefixListResult
}

CustomIPPrefixesClientListAllResponse contains the response from method CustomIPPrefixesClient.ListAll.

type CustomIPPrefixesClientListOptions

type CustomIPPrefixesClientListOptions struct {
}

CustomIPPrefixesClientListOptions contains the optional parameters for the CustomIPPrefixesClient.List method.

type CustomIPPrefixesClientListResponse

type CustomIPPrefixesClientListResponse struct {
	CustomIPPrefixListResult
}

CustomIPPrefixesClientListResponse contains the response from method CustomIPPrefixesClient.List.

type CustomIPPrefixesClientUpdateTagsOptions

type CustomIPPrefixesClientUpdateTagsOptions struct {
}

CustomIPPrefixesClientUpdateTagsOptions contains the optional parameters for the CustomIPPrefixesClient.UpdateTags method.

type CustomIPPrefixesClientUpdateTagsResponse

type CustomIPPrefixesClientUpdateTagsResponse struct {
	CustomIPPrefix
}

CustomIPPrefixesClientUpdateTagsResponse contains the response 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.

func (DNSNameAvailabilityResult) MarshalJSON

func (d DNSNameAvailabilityResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DNSNameAvailabilityResult.

func (*DNSNameAvailabilityResult) UnmarshalJSON

func (d *DNSNameAvailabilityResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DNSNameAvailabilityResult.

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.

func (*DNSSettings) UnmarshalJSON

func (d *DNSSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[DdosCustomPoliciesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a DDoS custom policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DdosCustomPolicyCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDdosCustomPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-ddos-custom-policy", armnetwork.DdosCustomPolicy{
	Location: to.Ptr("centraluseuap"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DdosCustomPoliciesClient) BeginDelete

func (client *DdosCustomPoliciesClient) BeginDelete(ctx context.Context, resourceGroupName string, ddosCustomPolicyName string, options *DdosCustomPoliciesClientBeginDeleteOptions) (*runtime.Poller[DdosCustomPoliciesClientDeleteResponse], error)

BeginDelete - Deletes the specified DDoS custom policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DdosCustomPolicyDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDdosCustomPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-ddos-custom-policy", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DdosCustomPolicyGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDdosCustomPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "test-ddos-custom-policy", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DdosCustomPolicyUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDdosCustomPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-ddos-custom-policy", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type DdosCustomPoliciesClientBeginCreateOrUpdateOptions

type DdosCustomPoliciesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DdosCustomPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the DdosCustomPoliciesClient.BeginCreateOrUpdate method.

type DdosCustomPoliciesClientBeginDeleteOptions

type DdosCustomPoliciesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DdosCustomPoliciesClientBeginDeleteOptions contains the optional parameters for the DdosCustomPoliciesClient.BeginDelete method.

type DdosCustomPoliciesClientCreateOrUpdateResponse

type DdosCustomPoliciesClientCreateOrUpdateResponse struct {
	DdosCustomPolicy
}

DdosCustomPoliciesClientCreateOrUpdateResponse contains the response from method DdosCustomPoliciesClient.CreateOrUpdate.

type DdosCustomPoliciesClientDeleteResponse

type DdosCustomPoliciesClientDeleteResponse struct {
}

DdosCustomPoliciesClientDeleteResponse contains the response from method DdosCustomPoliciesClient.Delete.

type DdosCustomPoliciesClientGetOptions

type DdosCustomPoliciesClientGetOptions struct {
}

DdosCustomPoliciesClientGetOptions contains the optional parameters for the DdosCustomPoliciesClient.Get method.

type DdosCustomPoliciesClientGetResponse

type DdosCustomPoliciesClientGetResponse struct {
	DdosCustomPolicy
}

DdosCustomPoliciesClientGetResponse contains the response from method DdosCustomPoliciesClient.Get.

type DdosCustomPoliciesClientUpdateTagsOptions

type DdosCustomPoliciesClientUpdateTagsOptions struct {
}

DdosCustomPoliciesClientUpdateTagsOptions contains the optional parameters for the DdosCustomPoliciesClient.UpdateTags method.

type DdosCustomPoliciesClientUpdateTagsResponse

type DdosCustomPoliciesClientUpdateTagsResponse struct {
	DdosCustomPolicy
}

DdosCustomPoliciesClientUpdateTagsResponse contains the response 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.

func (*DdosCustomPolicy) UnmarshalJSON

func (d *DdosCustomPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DdosCustomPolicy.

type DdosCustomPolicyPropertiesFormat

type DdosCustomPolicyPropertiesFormat struct {
	// READ-ONLY; The provisioning state of the DDoS custom policy resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,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.

func (*DdosCustomPolicyPropertiesFormat) UnmarshalJSON

func (d *DdosCustomPolicyPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DdosCustomPolicyPropertiesFormat.

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.

func (*DdosProtectionPlan) UnmarshalJSON

func (d *DdosProtectionPlan) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*DdosProtectionPlanListResult) UnmarshalJSON

func (d *DdosProtectionPlanListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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 list of public IPs associated with the DDoS protection plan resource. This list is read-only.
	PublicIPAddresses []*SubResource `json:"publicIpAddresses,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.

func (*DdosProtectionPlanPropertiesFormat) UnmarshalJSON

func (d *DdosProtectionPlanPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

BeginCreateOrUpdate - Creates or updates a DDoS protection plan. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DdosProtectionPlanCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDdosProtectionPlansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-plan", armnetwork.DdosProtectionPlan{
	Location:   to.Ptr("westus"),
	Properties: &armnetwork.DdosProtectionPlanPropertiesFormat{},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DdosProtectionPlansClient) BeginDelete

func (client *DdosProtectionPlansClient) BeginDelete(ctx context.Context, resourceGroupName string, ddosProtectionPlanName string, options *DdosProtectionPlansClientBeginDeleteOptions) (*runtime.Poller[DdosProtectionPlansClientDeleteResponse], error)

BeginDelete - Deletes the specified DDoS protection plan. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DdosProtectionPlanDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDdosProtectionPlansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-plan", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DdosProtectionPlanGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDdosProtectionPlansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "test-plan", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DdosProtectionPlansClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Gets all the DDoS protection plans in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - DdosProtectionPlansClientListByResourceGroupOptions contains the optional parameters for the DdosProtectionPlansClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DdosProtectionPlanList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDdosProtectionPlansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*DdosProtectionPlansClient) NewListPager

NewListPager - Gets all DDoS protection plans in a subscription. Generated from API version 2022-05-01 options - DdosProtectionPlansClientListOptions contains the optional parameters for the DdosProtectionPlansClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DdosProtectionPlanListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDdosProtectionPlansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DdosProtectionPlanUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDdosProtectionPlansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-plan", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type DdosProtectionPlansClientBeginCreateOrUpdateOptions

type DdosProtectionPlansClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DdosProtectionPlansClientBeginCreateOrUpdateOptions contains the optional parameters for the DdosProtectionPlansClient.BeginCreateOrUpdate method.

type DdosProtectionPlansClientBeginDeleteOptions

type DdosProtectionPlansClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DdosProtectionPlansClientBeginDeleteOptions contains the optional parameters for the DdosProtectionPlansClient.BeginDelete method.

type DdosProtectionPlansClientCreateOrUpdateResponse

type DdosProtectionPlansClientCreateOrUpdateResponse struct {
	DdosProtectionPlan
}

DdosProtectionPlansClientCreateOrUpdateResponse contains the response from method DdosProtectionPlansClient.CreateOrUpdate.

type DdosProtectionPlansClientDeleteResponse

type DdosProtectionPlansClientDeleteResponse struct {
}

DdosProtectionPlansClientDeleteResponse contains the response from method DdosProtectionPlansClient.Delete.

type DdosProtectionPlansClientGetOptions

type DdosProtectionPlansClientGetOptions struct {
}

DdosProtectionPlansClientGetOptions contains the optional parameters for the DdosProtectionPlansClient.Get method.

type DdosProtectionPlansClientGetResponse

type DdosProtectionPlansClientGetResponse struct {
	DdosProtectionPlan
}

DdosProtectionPlansClientGetResponse contains the response from method DdosProtectionPlansClient.Get.

type DdosProtectionPlansClientListByResourceGroupOptions

type DdosProtectionPlansClientListByResourceGroupOptions struct {
}

DdosProtectionPlansClientListByResourceGroupOptions contains the optional parameters for the DdosProtectionPlansClient.ListByResourceGroup method.

type DdosProtectionPlansClientListByResourceGroupResponse

type DdosProtectionPlansClientListByResourceGroupResponse struct {
	DdosProtectionPlanListResult
}

DdosProtectionPlansClientListByResourceGroupResponse contains the response from method DdosProtectionPlansClient.ListByResourceGroup.

type DdosProtectionPlansClientListOptions

type DdosProtectionPlansClientListOptions struct {
}

DdosProtectionPlansClientListOptions contains the optional parameters for the DdosProtectionPlansClient.List method.

type DdosProtectionPlansClientListResponse

type DdosProtectionPlansClientListResponse struct {
	DdosProtectionPlanListResult
}

DdosProtectionPlansClientListResponse contains the response from method DdosProtectionPlansClient.List.

type DdosProtectionPlansClientUpdateTagsOptions

type DdosProtectionPlansClientUpdateTagsOptions struct {
}

DdosProtectionPlansClientUpdateTagsOptions contains the optional parameters for the DdosProtectionPlansClient.UpdateTags method.

type DdosProtectionPlansClientUpdateTagsResponse

type DdosProtectionPlansClientUpdateTagsResponse struct {
	DdosProtectionPlan
}

DdosProtectionPlansClientUpdateTagsResponse contains the response from method DdosProtectionPlansClient.UpdateTags.

type DdosSettings

type DdosSettings struct {
	// The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled
	DdosProtectionPlan *SubResource `json:"ddosProtectionPlan,omitempty"`

	// The DDoS protection mode of the public IP
	ProtectionMode *DdosSettingsProtectionMode `json:"protectionMode,omitempty"`
}

DdosSettings - Contains the DDoS protection settings of the public IP.

func (DdosSettings) MarshalJSON

func (d DdosSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DdosSettings.

func (*DdosSettings) UnmarshalJSON

func (d *DdosSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DdosSettings.

type DdosSettingsProtectionMode

type DdosSettingsProtectionMode string

DdosSettingsProtectionMode - The DDoS protection mode of the public IP

const (
	DdosSettingsProtectionModeDisabled                DdosSettingsProtectionMode = "Disabled"
	DdosSettingsProtectionModeEnabled                 DdosSettingsProtectionMode = "Enabled"
	DdosSettingsProtectionModeVirtualNetworkInherited DdosSettingsProtectionMode = "VirtualNetworkInherited"
)

func PossibleDdosSettingsProtectionModeValues

func PossibleDdosSettingsProtectionModeValues() []DdosSettingsProtectionMode

PossibleDdosSettingsProtectionModeValues returns the possible values for the DdosSettingsProtectionMode const type.

type DefaultAdminPropertiesFormat

type DefaultAdminPropertiesFormat struct {
	// Default rule flag.
	Flag *string `json:"flag,omitempty"`

	// READ-ONLY; Indicates the access allowed for this particular rule
	Access *SecurityConfigurationRuleAccess `json:"access,omitempty" azure:"ro"`

	// READ-ONLY; A description for this rule. Restricted to 140 chars.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; The destination port ranges.
	DestinationPortRanges []*string `json:"destinationPortRanges,omitempty" azure:"ro"`

	// READ-ONLY; The destination address prefixes. CIDR or destination IP ranges.
	Destinations []*AddressPrefixItem `json:"destinations,omitempty" azure:"ro"`

	// READ-ONLY; Indicates if the traffic matched against the rule in inbound or outbound.
	Direction *SecurityConfigurationRuleDirection `json:"direction,omitempty" azure:"ro"`

	// READ-ONLY; The priority of the rule. The value can be between 1 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" azure:"ro"`

	// READ-ONLY; Network protocol this rule applies to.
	Protocol *SecurityConfigurationRuleProtocol `json:"protocol,omitempty" azure:"ro"`

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

	// READ-ONLY; The source port ranges.
	SourcePortRanges []*string `json:"sourcePortRanges,omitempty" azure:"ro"`

	// READ-ONLY; The CIDR or source IP ranges.
	Sources []*AddressPrefixItem `json:"sources,omitempty" azure:"ro"`
}

DefaultAdminPropertiesFormat - Security default admin rule resource.

func (DefaultAdminPropertiesFormat) MarshalJSON

func (d DefaultAdminPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DefaultAdminPropertiesFormat.

func (*DefaultAdminPropertiesFormat) UnmarshalJSON

func (d *DefaultAdminPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultAdminPropertiesFormat.

type DefaultAdminRule

type DefaultAdminRule struct {
	// REQUIRED; Whether the rule is custom or default.
	Kind *AdminRuleKind `json:"kind,omitempty"`

	// Indicates the properties of the security admin rule
	Properties *DefaultAdminPropertiesFormat `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 ID.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

DefaultAdminRule - Network default admin rule.

func (*DefaultAdminRule) GetBaseAdminRule

func (d *DefaultAdminRule) GetBaseAdminRule() *BaseAdminRule

GetBaseAdminRule implements the BaseAdminRuleClassification interface for type DefaultAdminRule.

func (DefaultAdminRule) MarshalJSON

func (d DefaultAdminRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DefaultAdminRule.

func (*DefaultAdminRule) UnmarshalJSON

func (d *DefaultAdminRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultAdminRule.

type DefaultRuleSetPropertyFormat

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

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

DefaultRuleSetPropertyFormat - the default web application firewall rule set.

func (DefaultRuleSetPropertyFormat) MarshalJSON

func (d DefaultRuleSetPropertyFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DefaultRuleSetPropertyFormat.

func (*DefaultRuleSetPropertyFormat) UnmarshalJSON

func (d *DefaultRuleSetPropertyFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DefaultRuleSetPropertyFormat.

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, error)

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DefaultSecurityRuleGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDefaultSecurityRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "testrg", "nsg1", "AllowVnetInBound", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DefaultSecurityRulesClient) NewListPager

func (client *DefaultSecurityRulesClient) NewListPager(resourceGroupName string, networkSecurityGroupName string, options *DefaultSecurityRulesClientListOptions) *runtime.Pager[DefaultSecurityRulesClientListResponse]

NewListPager - Gets all default security rules in a network security group. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DefaultSecurityRuleList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDefaultSecurityRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "nsg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type DefaultSecurityRulesClientGetOptions

type DefaultSecurityRulesClientGetOptions struct {
}

DefaultSecurityRulesClientGetOptions contains the optional parameters for the DefaultSecurityRulesClient.Get method.

type DefaultSecurityRulesClientGetResponse

type DefaultSecurityRulesClientGetResponse struct {
	SecurityRule
}

DefaultSecurityRulesClientGetResponse contains the response from method DefaultSecurityRulesClient.Get.

type DefaultSecurityRulesClientListOptions

type DefaultSecurityRulesClientListOptions struct {
}

DefaultSecurityRulesClientListOptions contains the optional parameters for the DefaultSecurityRulesClient.List method.

type DefaultSecurityRulesClientListResponse

type DefaultSecurityRulesClientListResponse struct {
	SecurityRuleListResult
}

DefaultSecurityRulesClientListResponse contains the response 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.

func (Delegation) MarshalJSON

func (d Delegation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Delegation.

func (*Delegation) UnmarshalJSON

func (d *Delegation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Delegation.

type DeleteExistingPeering

type DeleteExistingPeering string

DeleteExistingPeering - Flag if need to remove current existing peerings.

const (
	DeleteExistingPeeringFalse DeleteExistingPeering = "False"
	DeleteExistingPeeringTrue  DeleteExistingPeering = "True"
)

func PossibleDeleteExistingPeeringValues

func PossibleDeleteExistingPeeringValues() []DeleteExistingPeering

PossibleDeleteExistingPeeringValues returns the possible values for the DeleteExistingPeering const type.

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.

type DeploymentStatus

type DeploymentStatus string

DeploymentStatus - Deployment Status.

const (
	DeploymentStatusDeployed   DeploymentStatus = "Deployed"
	DeploymentStatusDeploying  DeploymentStatus = "Deploying"
	DeploymentStatusFailed     DeploymentStatus = "Failed"
	DeploymentStatusNotStarted DeploymentStatus = "NotStarted"
)

func PossibleDeploymentStatusValues

func PossibleDeploymentStatusValues() []DeploymentStatus

PossibleDeploymentStatusValues returns the possible values for the DeploymentStatus const type.

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.

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.

func (DeviceProperties) MarshalJSON

func (d DeviceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeviceProperties.

func (*DeviceProperties) UnmarshalJSON

func (d *DeviceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeviceProperties.

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.

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.

func (*DhcpOptions) UnmarshalJSON

func (d *DhcpOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (Dimension) MarshalJSON

func (d Dimension) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Dimension.

func (*Dimension) UnmarshalJSON

func (d *Dimension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Dimension.

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.

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.

func (*DscpConfiguration) UnmarshalJSON

func (d *DscpConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[DscpConfigurationClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a DSCP Configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DscpConfigurationCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDscpConfigurationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "mydscpconfig", armnetwork.DscpConfiguration{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.DscpConfigurationPropertiesFormat{
		QosDefinitionCollection: []*armnetwork.QosDefinition{
			{
				DestinationIPRanges: []*armnetwork.QosIPRange{
					{
						EndIP:   to.Ptr("127.0.10.2"),
						StartIP: to.Ptr("127.0.10.1"),
					}},
				DestinationPortRanges: []*armnetwork.QosPortRange{
					{
						End:   to.Ptr[int32](15),
						Start: to.Ptr[int32](15),
					}},
				Markings: []*int32{
					to.Ptr[int32](1)},
				SourceIPRanges: []*armnetwork.QosIPRange{
					{
						EndIP:   to.Ptr("127.0.0.2"),
						StartIP: to.Ptr("127.0.0.1"),
					}},
				SourcePortRanges: []*armnetwork.QosPortRange{
					{
						End:   to.Ptr[int32](11),
						Start: to.Ptr[int32](10),
					},
					{
						End:   to.Ptr[int32](21),
						Start: to.Ptr[int32](20),
					}},
				Protocol: to.Ptr(armnetwork.ProtocolTypeTCP),
			},
			{
				DestinationIPRanges: []*armnetwork.QosIPRange{
					{
						EndIP:   to.Ptr("12.0.10.2"),
						StartIP: to.Ptr("12.0.10.1"),
					}},
				DestinationPortRanges: []*armnetwork.QosPortRange{
					{
						End:   to.Ptr[int32](52),
						Start: to.Ptr[int32](51),
					}},
				Markings: []*int32{
					to.Ptr[int32](2)},
				SourceIPRanges: []*armnetwork.QosIPRange{
					{
						EndIP:   to.Ptr("12.0.0.2"),
						StartIP: to.Ptr("12.0.0.1"),
					}},
				SourcePortRanges: []*armnetwork.QosPortRange{
					{
						End:   to.Ptr[int32](12),
						Start: to.Ptr[int32](11),
					}},
				Protocol: to.Ptr(armnetwork.ProtocolTypeUDP),
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DscpConfigurationClient) BeginDelete

func (client *DscpConfigurationClient) BeginDelete(ctx context.Context, resourceGroupName string, dscpConfigurationName string, options *DscpConfigurationClientBeginDeleteOptions) (*runtime.Poller[DscpConfigurationClientDeleteResponse], error)

BeginDelete - Deletes a DSCP Configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DscpConfigurationDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDscpConfigurationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "mydscpConfig", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DscpConfigurationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDscpConfigurationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "mydscpConfig", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*DscpConfigurationClient) NewListAllPager

NewListAllPager - Gets all dscp configurations in a subscription. Generated from API version 2022-05-01 options - DscpConfigurationClientListAllOptions contains the optional parameters for the DscpConfigurationClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DscpConfigurationListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDscpConfigurationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*DscpConfigurationClient) NewListPager

NewListPager - Gets a DSCP Configuration. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - DscpConfigurationClientListOptions contains the optional parameters for the DscpConfigurationClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/DscpConfigurationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewDscpConfigurationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type DscpConfigurationClientBeginCreateOrUpdateOptions

type DscpConfigurationClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DscpConfigurationClientBeginCreateOrUpdateOptions contains the optional parameters for the DscpConfigurationClient.BeginCreateOrUpdate method.

type DscpConfigurationClientBeginDeleteOptions

type DscpConfigurationClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DscpConfigurationClientBeginDeleteOptions contains the optional parameters for the DscpConfigurationClient.BeginDelete method.

type DscpConfigurationClientCreateOrUpdateResponse

type DscpConfigurationClientCreateOrUpdateResponse struct {
	DscpConfiguration
}

DscpConfigurationClientCreateOrUpdateResponse contains the response from method DscpConfigurationClient.CreateOrUpdate.

type DscpConfigurationClientDeleteResponse

type DscpConfigurationClientDeleteResponse struct {
}

DscpConfigurationClientDeleteResponse contains the response from method DscpConfigurationClient.Delete.

type DscpConfigurationClientGetOptions

type DscpConfigurationClientGetOptions struct {
}

DscpConfigurationClientGetOptions contains the optional parameters for the DscpConfigurationClient.Get method.

type DscpConfigurationClientGetResponse

type DscpConfigurationClientGetResponse struct {
	DscpConfiguration
}

DscpConfigurationClientGetResponse contains the response from method DscpConfigurationClient.Get.

type DscpConfigurationClientListAllOptions

type DscpConfigurationClientListAllOptions struct {
}

DscpConfigurationClientListAllOptions contains the optional parameters for the DscpConfigurationClient.ListAll method.

type DscpConfigurationClientListAllResponse

type DscpConfigurationClientListAllResponse struct {
	DscpConfigurationListResult
}

DscpConfigurationClientListAllResponse contains the response from method DscpConfigurationClient.ListAll.

type DscpConfigurationClientListOptions

type DscpConfigurationClientListOptions struct {
}

DscpConfigurationClientListOptions contains the optional parameters for the DscpConfigurationClient.List method.

type DscpConfigurationClientListResponse

type DscpConfigurationClientListResponse struct {
	DscpConfigurationListResult
}

DscpConfigurationClientListResponse contains the response 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.

func (*DscpConfigurationListResult) UnmarshalJSON

func (d *DscpConfigurationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*DscpConfigurationPropertiesFormat) UnmarshalJSON

func (d *DscpConfigurationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DscpConfigurationPropertiesFormat.

type EffectiveAdminRuleKind

type EffectiveAdminRuleKind string

EffectiveAdminRuleKind - Whether the rule is custom or default.

const (
	EffectiveAdminRuleKindCustom  EffectiveAdminRuleKind = "Custom"
	EffectiveAdminRuleKindDefault EffectiveAdminRuleKind = "Default"
)

func PossibleEffectiveAdminRuleKindValues

func PossibleEffectiveAdminRuleKindValues() []EffectiveAdminRuleKind

PossibleEffectiveAdminRuleKindValues returns the possible values for the EffectiveAdminRuleKind const type.

type EffectiveBaseSecurityAdminRule

type EffectiveBaseSecurityAdminRule struct {
	// REQUIRED; Whether the rule is custom or default.
	Kind *EffectiveAdminRuleKind `json:"kind,omitempty"`

	// A description of the security admin configuration.
	ConfigurationDescription *string `json:"configurationDescription,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Groups for rule collection
	RuleCollectionAppliesToGroups []*ManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`

	// A description of the rule collection.
	RuleCollectionDescription *string `json:"ruleCollectionDescription,omitempty"`

	// Effective configuration groups.
	RuleGroups []*ConfigurationGroup `json:"ruleGroups,omitempty"`
}

EffectiveBaseSecurityAdminRule - Network base admin rule.

func (*EffectiveBaseSecurityAdminRule) GetEffectiveBaseSecurityAdminRule

func (e *EffectiveBaseSecurityAdminRule) GetEffectiveBaseSecurityAdminRule() *EffectiveBaseSecurityAdminRule

GetEffectiveBaseSecurityAdminRule implements the EffectiveBaseSecurityAdminRuleClassification interface for type EffectiveBaseSecurityAdminRule.

func (EffectiveBaseSecurityAdminRule) MarshalJSON

func (e EffectiveBaseSecurityAdminRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveBaseSecurityAdminRule.

func (*EffectiveBaseSecurityAdminRule) UnmarshalJSON

func (e *EffectiveBaseSecurityAdminRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EffectiveBaseSecurityAdminRule.

type EffectiveBaseSecurityAdminRuleClassification

type EffectiveBaseSecurityAdminRuleClassification interface {
	// GetEffectiveBaseSecurityAdminRule returns the EffectiveBaseSecurityAdminRule content of the underlying type.
	GetEffectiveBaseSecurityAdminRule() *EffectiveBaseSecurityAdminRule
}

EffectiveBaseSecurityAdminRuleClassification provides polymorphic access to related types. Call the interface's GetEffectiveBaseSecurityAdminRule() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EffectiveBaseSecurityAdminRule, *EffectiveDefaultSecurityAdminRule, *EffectiveSecurityAdminRule

type EffectiveConnectivityConfiguration

type EffectiveConnectivityConfiguration struct {
	// Effective configuration groups.
	ConfigurationGroups []*ConfigurationGroup `json:"configurationGroups,omitempty"`

	// Connectivity configuration ID.
	ID *string `json:"id,omitempty"`

	// Properties of a network manager connectivity configuration
	Properties *ConnectivityConfigurationProperties `json:"properties,omitempty"`
}

EffectiveConnectivityConfiguration - The network manager effective connectivity configuration

func (EffectiveConnectivityConfiguration) MarshalJSON

func (e EffectiveConnectivityConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveConnectivityConfiguration.

func (*EffectiveConnectivityConfiguration) UnmarshalJSON

func (e *EffectiveConnectivityConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EffectiveConnectivityConfiguration.

type EffectiveDefaultSecurityAdminRule

type EffectiveDefaultSecurityAdminRule struct {
	// REQUIRED; Whether the rule is custom or default.
	Kind *EffectiveAdminRuleKind `json:"kind,omitempty"`

	// A description of the security admin configuration.
	ConfigurationDescription *string `json:"configurationDescription,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Indicates the properties of the default security admin rule
	Properties *DefaultAdminPropertiesFormat `json:"properties,omitempty"`

	// Groups for rule collection
	RuleCollectionAppliesToGroups []*ManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`

	// A description of the rule collection.
	RuleCollectionDescription *string `json:"ruleCollectionDescription,omitempty"`

	// Effective configuration groups.
	RuleGroups []*ConfigurationGroup `json:"ruleGroups,omitempty"`
}

EffectiveDefaultSecurityAdminRule - Network default admin rule.

func (*EffectiveDefaultSecurityAdminRule) GetEffectiveBaseSecurityAdminRule

func (e *EffectiveDefaultSecurityAdminRule) GetEffectiveBaseSecurityAdminRule() *EffectiveBaseSecurityAdminRule

GetEffectiveBaseSecurityAdminRule implements the EffectiveBaseSecurityAdminRuleClassification interface for type EffectiveDefaultSecurityAdminRule.

func (EffectiveDefaultSecurityAdminRule) MarshalJSON

func (e EffectiveDefaultSecurityAdminRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveDefaultSecurityAdminRule.

func (*EffectiveDefaultSecurityAdminRule) UnmarshalJSON

func (e *EffectiveDefaultSecurityAdminRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EffectiveDefaultSecurityAdminRule.

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.

func (*EffectiveNetworkSecurityGroup) UnmarshalJSON

func (e *EffectiveNetworkSecurityGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (EffectiveNetworkSecurityGroupAssociation) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type EffectiveNetworkSecurityGroupAssociation.

func (*EffectiveNetworkSecurityGroupAssociation) UnmarshalJSON

func (e *EffectiveNetworkSecurityGroupAssociation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EffectiveNetworkSecurityGroupAssociation.

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.

func (*EffectiveNetworkSecurityGroupListResult) UnmarshalJSON

func (e *EffectiveNetworkSecurityGroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*EffectiveNetworkSecurityRule) UnmarshalJSON

func (e *EffectiveNetworkSecurityRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*EffectiveRoute) UnmarshalJSON

func (e *EffectiveRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*EffectiveRouteListResult) UnmarshalJSON

func (e *EffectiveRouteListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EffectiveRouteListResult.

type EffectiveRouteMapRoute

type EffectiveRouteMapRoute struct {
	// The ASPath of this route.
	AsPath *string `json:"asPath,omitempty"`

	// BGP communities of the route.
	BgpCommunities *string `json:"bgpCommunities,omitempty"`

	// The address prefix of the route.
	Prefix []*string `json:"prefix,omitempty"`
}

EffectiveRouteMapRoute - The effective RouteMap route configured on the connection resource.

func (EffectiveRouteMapRoute) MarshalJSON

func (e EffectiveRouteMapRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveRouteMapRoute.

func (*EffectiveRouteMapRoute) UnmarshalJSON

func (e *EffectiveRouteMapRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EffectiveRouteMapRoute.

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.

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.

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.

func (EffectiveRoutesParameters) MarshalJSON

func (e EffectiveRoutesParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveRoutesParameters.

func (*EffectiveRoutesParameters) UnmarshalJSON

func (e *EffectiveRoutesParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EffectiveRoutesParameters.

type EffectiveSecurityAdminRule

type EffectiveSecurityAdminRule struct {
	// REQUIRED; Whether the rule is custom or default.
	Kind *EffectiveAdminRuleKind `json:"kind,omitempty"`

	// A description of the security admin configuration.
	ConfigurationDescription *string `json:"configurationDescription,omitempty"`

	// Resource ID.
	ID *string `json:"id,omitempty"`

	// Indicates the properties of the security admin rule
	Properties *AdminPropertiesFormat `json:"properties,omitempty"`

	// Groups for rule collection
	RuleCollectionAppliesToGroups []*ManagerSecurityGroupItem `json:"ruleCollectionAppliesToGroups,omitempty"`

	// A description of the rule collection.
	RuleCollectionDescription *string `json:"ruleCollectionDescription,omitempty"`

	// Effective configuration groups.
	RuleGroups []*ConfigurationGroup `json:"ruleGroups,omitempty"`
}

EffectiveSecurityAdminRule - Network admin rule.

func (*EffectiveSecurityAdminRule) GetEffectiveBaseSecurityAdminRule

func (e *EffectiveSecurityAdminRule) GetEffectiveBaseSecurityAdminRule() *EffectiveBaseSecurityAdminRule

GetEffectiveBaseSecurityAdminRule implements the EffectiveBaseSecurityAdminRuleClassification interface for type EffectiveSecurityAdminRule.

func (EffectiveSecurityAdminRule) MarshalJSON

func (e EffectiveSecurityAdminRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EffectiveSecurityAdminRule.

func (*EffectiveSecurityAdminRule) UnmarshalJSON

func (e *EffectiveSecurityAdminRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EffectiveSecurityAdminRule.

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.

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.

func (EndpointServiceResult) MarshalJSON

func (e EndpointServiceResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointServiceResult.

func (*EndpointServiceResult) UnmarshalJSON

func (e *EndpointServiceResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointServiceResult.

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.

func (*EndpointServicesListResult) UnmarshalJSON

func (e *EndpointServicesListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointServicesListResult.

type EndpointType

type EndpointType string

EndpointType - The endpoint type.

const (
	EndpointTypeAzureArcVM          EndpointType = "AzureArcVM"
	EndpointTypeAzureSubnet         EndpointType = "AzureSubnet"
	EndpointTypeAzureVM             EndpointType = "AzureVM"
	EndpointTypeAzureVMSS           EndpointType = "AzureVMSS"
	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.

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

func (e Error) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Error.

func (*Error) UnmarshalJSON

func (e *Error) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ErrorDetails) MarshalJSON

func (e ErrorDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetails.

func (*ErrorDetails) UnmarshalJSON

func (e *ErrorDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetails.

type ErrorResponse

type ErrorResponse struct {
	// The error details object.
	Error *ErrorDetails `json:"error,omitempty"`
}

ErrorResponse - The error object.

func (ErrorResponse) MarshalJSON

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON

func (e *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

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.

func (*EvaluatedNetworkSecurityGroup) UnmarshalJSON

func (e *EvaluatedNetworkSecurityGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

type ExclusionManagedRule

type ExclusionManagedRule struct {
	// REQUIRED; Identifier for the managed rule.
	RuleID *string `json:"ruleId,omitempty"`
}

ExclusionManagedRule - Defines a managed rule to use for exclusion.

func (ExclusionManagedRule) MarshalJSON

func (e ExclusionManagedRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExclusionManagedRule.

func (*ExclusionManagedRule) UnmarshalJSON

func (e *ExclusionManagedRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExclusionManagedRule.

type ExclusionManagedRuleGroup

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

func (e ExclusionManagedRuleGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExclusionManagedRuleGroup.

func (*ExclusionManagedRuleGroup) UnmarshalJSON

func (e *ExclusionManagedRuleGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExclusionManagedRuleGroup.

type ExclusionManagedRuleSet

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

func (e ExclusionManagedRuleSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExclusionManagedRuleSet.

func (*ExclusionManagedRuleSet) UnmarshalJSON

func (e *ExclusionManagedRuleSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExclusionManagedRuleSet.

type ExplicitProxySettings

type ExplicitProxySettings struct {
	// When set to true, explicit proxy mode is enabled.
	EnableExplicitProxy *bool `json:"enableExplicitProxy,omitempty"`

	// When set to true, pac file port and url needs to be provided.
	EnablePacFile *bool `json:"enablePacFile,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.

func (ExplicitProxySettings) MarshalJSON

func (e ExplicitProxySettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExplicitProxySettings.

func (*ExplicitProxySettings) UnmarshalJSON

func (e *ExplicitProxySettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExplicitProxySettings.

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.

func (*ExpressRouteCircuit) UnmarshalJSON

func (e *ExpressRouteCircuit) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteCircuitArpTable) MarshalJSON

func (e ExpressRouteCircuitArpTable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitArpTable.

func (*ExpressRouteCircuitArpTable) UnmarshalJSON

func (e *ExpressRouteCircuitArpTable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitArpTable.

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.

func (ExpressRouteCircuitAuthorization) MarshalJSON

func (e ExpressRouteCircuitAuthorization) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitAuthorization.

func (*ExpressRouteCircuitAuthorization) UnmarshalJSON

func (e *ExpressRouteCircuitAuthorization) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitAuthorization.

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, error)

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

BeginCreateOrUpdate - Creates or updates an authorization in the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitAuthorizationCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitAuthorizationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "circuitName", "authorizatinName", armnetwork.ExpressRouteCircuitAuthorization{
	Properties: &armnetwork.AuthorizationPropertiesFormat{},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitAuthorizationsClient) BeginDelete

BeginDelete - Deletes the specified authorization from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitAuthorizationDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitAuthorizationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "circuitName", "authorizationName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ExpressRouteCircuitAuthorizationsClient) Get

Get - Gets the specified authorization from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitAuthorizationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitAuthorizationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "circuitName", "authorizationName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitAuthorizationsClient) NewListPager

NewListPager - Gets all authorizations in an express route circuit. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitAuthorizationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitAuthorizationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "circuitName", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ExpressRouteCircuitAuthorizationsClientBeginCreateOrUpdateOptions

type ExpressRouteCircuitAuthorizationsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitAuthorizationsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.BeginCreateOrUpdate method.

type ExpressRouteCircuitAuthorizationsClientBeginDeleteOptions

type ExpressRouteCircuitAuthorizationsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitAuthorizationsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.BeginDelete method.

type ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResponse

type ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResponse struct {
	ExpressRouteCircuitAuthorization
}

ExpressRouteCircuitAuthorizationsClientCreateOrUpdateResponse contains the response from method ExpressRouteCircuitAuthorizationsClient.CreateOrUpdate.

type ExpressRouteCircuitAuthorizationsClientDeleteResponse

type ExpressRouteCircuitAuthorizationsClientDeleteResponse struct {
}

ExpressRouteCircuitAuthorizationsClientDeleteResponse contains the response from method ExpressRouteCircuitAuthorizationsClient.Delete.

type ExpressRouteCircuitAuthorizationsClientGetOptions

type ExpressRouteCircuitAuthorizationsClientGetOptions struct {
}

ExpressRouteCircuitAuthorizationsClientGetOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.Get method.

type ExpressRouteCircuitAuthorizationsClientGetResponse

type ExpressRouteCircuitAuthorizationsClientGetResponse struct {
	ExpressRouteCircuitAuthorization
}

ExpressRouteCircuitAuthorizationsClientGetResponse contains the response from method ExpressRouteCircuitAuthorizationsClient.Get.

type ExpressRouteCircuitAuthorizationsClientListOptions

type ExpressRouteCircuitAuthorizationsClientListOptions struct {
}

ExpressRouteCircuitAuthorizationsClientListOptions contains the optional parameters for the ExpressRouteCircuitAuthorizationsClient.List method.

type ExpressRouteCircuitAuthorizationsClientListResponse

type ExpressRouteCircuitAuthorizationsClientListResponse struct {
	AuthorizationListResult
}

ExpressRouteCircuitAuthorizationsClientListResponse contains the response 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.

func (ExpressRouteCircuitConnection) MarshalJSON

func (e ExpressRouteCircuitConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitConnection.

func (*ExpressRouteCircuitConnection) UnmarshalJSON

func (e *ExpressRouteCircuitConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitConnection.

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.

func (*ExpressRouteCircuitConnectionListResult) UnmarshalJSON

func (e *ExpressRouteCircuitConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteCircuitConnectionPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitConnectionPropertiesFormat.

func (*ExpressRouteCircuitConnectionPropertiesFormat) UnmarshalJSON

func (e *ExpressRouteCircuitConnectionPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitConnectionPropertiesFormat.

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, error)

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) (*runtime.Poller[ExpressRouteCircuitConnectionsClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitConnectionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitConnectionsClient("subid1", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "ExpressRouteARMCircuitA", "AzurePrivatePeering", "circuitConnectionUSAUS", armnetwork.ExpressRouteCircuitConnection{
	Properties: &armnetwork.ExpressRouteCircuitConnectionPropertiesFormat{
		AddressPrefix:    to.Ptr("10.0.0.0/29"),
		AuthorizationKey: to.Ptr("946a1918-b7a2-4917-b43c-8c4cdaee006a"),
		ExpressRouteCircuitPeering: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"),
		},
		IPv6CircuitConnectionConfig: &armnetwork.IPv6CircuitConnectionConfig{
			AddressPrefix: to.Ptr("aa:bb::/125"),
		},
		PeerExpressRouteCircuitPeering: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitConnectionsClient) BeginDelete

BeginDelete - Deletes the specified Express Route Circuit Connection from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitConnectionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "ExpressRouteARMCircuitA", "AzurePrivatePeering", "circuitConnectionUSAUS", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ExpressRouteCircuitConnectionsClient) Get

Get - Gets the specified Express Route Circuit Connection from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitConnectionsClient("subid1", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "ExpressRouteARMCircuitA", "AzurePrivatePeering", "circuitConnectionUSAUS", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitConnectionsClient) NewListPager

NewListPager - Gets all global reach connections associated with a private peering in an express route circuit. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitConnectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitConnectionsClient("subid1", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "ExpressRouteARMCircuitA", "AzurePrivatePeering", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ExpressRouteCircuitConnectionsClientBeginCreateOrUpdateOptions

type ExpressRouteCircuitConnectionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.BeginCreateOrUpdate method.

type ExpressRouteCircuitConnectionsClientBeginDeleteOptions

type ExpressRouteCircuitConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitConnectionsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.BeginDelete method.

type ExpressRouteCircuitConnectionsClientCreateOrUpdateResponse

type ExpressRouteCircuitConnectionsClientCreateOrUpdateResponse struct {
	ExpressRouteCircuitConnection
}

ExpressRouteCircuitConnectionsClientCreateOrUpdateResponse contains the response from method ExpressRouteCircuitConnectionsClient.CreateOrUpdate.

type ExpressRouteCircuitConnectionsClientDeleteResponse

type ExpressRouteCircuitConnectionsClientDeleteResponse struct {
}

ExpressRouteCircuitConnectionsClientDeleteResponse contains the response from method ExpressRouteCircuitConnectionsClient.Delete.

type ExpressRouteCircuitConnectionsClientGetOptions

type ExpressRouteCircuitConnectionsClientGetOptions struct {
}

ExpressRouteCircuitConnectionsClientGetOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.Get method.

type ExpressRouteCircuitConnectionsClientGetResponse

type ExpressRouteCircuitConnectionsClientGetResponse struct {
	ExpressRouteCircuitConnection
}

ExpressRouteCircuitConnectionsClientGetResponse contains the response from method ExpressRouteCircuitConnectionsClient.Get.

type ExpressRouteCircuitConnectionsClientListOptions

type ExpressRouteCircuitConnectionsClientListOptions struct {
}

ExpressRouteCircuitConnectionsClientListOptions contains the optional parameters for the ExpressRouteCircuitConnectionsClient.List method.

type ExpressRouteCircuitConnectionsClientListResponse

type ExpressRouteCircuitConnectionsClientListResponse struct {
	ExpressRouteCircuitConnectionListResult
}

ExpressRouteCircuitConnectionsClientListResponse contains the response 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.

func (*ExpressRouteCircuitListResult) UnmarshalJSON

func (e *ExpressRouteCircuitListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteCircuitPeering) MarshalJSON

func (e ExpressRouteCircuitPeering) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitPeering.

func (*ExpressRouteCircuitPeering) UnmarshalJSON

func (e *ExpressRouteCircuitPeering) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitPeering.

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.

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.

func (*ExpressRouteCircuitPeeringConfig) UnmarshalJSON

func (e *ExpressRouteCircuitPeeringConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteCircuitPeeringID) MarshalJSON

func (e ExpressRouteCircuitPeeringID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitPeeringID.

func (*ExpressRouteCircuitPeeringID) UnmarshalJSON

func (e *ExpressRouteCircuitPeeringID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitPeeringID.

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.

func (*ExpressRouteCircuitPeeringListResult) UnmarshalJSON

func (e *ExpressRouteCircuitPeeringListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitPeeringPropertiesFormat.

func (*ExpressRouteCircuitPeeringPropertiesFormat) UnmarshalJSON

func (e *ExpressRouteCircuitPeeringPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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, error)

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

BeginCreateOrUpdate - Creates or updates a peering in the specified express route circuits. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitPeeringCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "circuitName", "AzurePrivatePeering", armnetwork.ExpressRouteCircuitPeering{
	Properties: &armnetwork.ExpressRouteCircuitPeeringPropertiesFormat{
		PeerASN:                    to.Ptr[int64](200),
		PrimaryPeerAddressPrefix:   to.Ptr("192.168.16.252/30"),
		SecondaryPeerAddressPrefix: to.Ptr("192.168.18.252/30"),
		VlanID:                     to.Ptr[int32](200),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitPeeringsClient) BeginDelete

BeginDelete - Deletes the specified peering from the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitPeeringDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "circuitName", "peeringName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ExpressRouteCircuitPeeringsClient) Get

Get - Gets the specified peering for the express route circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitPeeringGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "circuitName", "MicrosoftPeering", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitPeeringsClient) NewListPager

NewListPager - Gets all peerings in a specified express route circuit. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitPeeringList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "circuitName", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ExpressRouteCircuitPeeringsClientBeginCreateOrUpdateOptions

type ExpressRouteCircuitPeeringsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.BeginCreateOrUpdate method.

type ExpressRouteCircuitPeeringsClientBeginDeleteOptions

type ExpressRouteCircuitPeeringsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitPeeringsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.BeginDelete method.

type ExpressRouteCircuitPeeringsClientCreateOrUpdateResponse

type ExpressRouteCircuitPeeringsClientCreateOrUpdateResponse struct {
	ExpressRouteCircuitPeering
}

ExpressRouteCircuitPeeringsClientCreateOrUpdateResponse contains the response from method ExpressRouteCircuitPeeringsClient.CreateOrUpdate.

type ExpressRouteCircuitPeeringsClientDeleteResponse

type ExpressRouteCircuitPeeringsClientDeleteResponse struct {
}

ExpressRouteCircuitPeeringsClientDeleteResponse contains the response from method ExpressRouteCircuitPeeringsClient.Delete.

type ExpressRouteCircuitPeeringsClientGetOptions

type ExpressRouteCircuitPeeringsClientGetOptions struct {
}

ExpressRouteCircuitPeeringsClientGetOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.Get method.

type ExpressRouteCircuitPeeringsClientGetResponse

type ExpressRouteCircuitPeeringsClientGetResponse struct {
	ExpressRouteCircuitPeering
}

ExpressRouteCircuitPeeringsClientGetResponse contains the response from method ExpressRouteCircuitPeeringsClient.Get.

type ExpressRouteCircuitPeeringsClientListOptions

type ExpressRouteCircuitPeeringsClientListOptions struct {
}

ExpressRouteCircuitPeeringsClientListOptions contains the optional parameters for the ExpressRouteCircuitPeeringsClient.List method.

type ExpressRouteCircuitPeeringsClientListResponse

type ExpressRouteCircuitPeeringsClientListResponse struct {
	ExpressRouteCircuitPeeringListResult
}

ExpressRouteCircuitPeeringsClientListResponse contains the response from method ExpressRouteCircuitPeeringsClient.List.

type ExpressRouteCircuitPropertiesFormat

type ExpressRouteCircuitPropertiesFormat struct {
	// Allow classic operations.
	AllowClassicOperations *bool `json:"allowClassicOperations,omitempty"`

	// The authorizationKey.
	AuthorizationKey *string `json:"authorizationKey,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.

func (*ExpressRouteCircuitPropertiesFormat) UnmarshalJSON

func (e *ExpressRouteCircuitPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteCircuitReference) MarshalJSON

func (e ExpressRouteCircuitReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitReference.

func (*ExpressRouteCircuitReference) UnmarshalJSON

func (e *ExpressRouteCircuitReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitReference.

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.

func (ExpressRouteCircuitRoutesTable) MarshalJSON

func (e ExpressRouteCircuitRoutesTable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitRoutesTable.

func (*ExpressRouteCircuitRoutesTable) UnmarshalJSON

func (e *ExpressRouteCircuitRoutesTable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitRoutesTable.

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.

func (ExpressRouteCircuitRoutesTableSummary) MarshalJSON

func (e ExpressRouteCircuitRoutesTableSummary) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitRoutesTableSummary.

func (*ExpressRouteCircuitRoutesTableSummary) UnmarshalJSON

func (e *ExpressRouteCircuitRoutesTableSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitRoutesTableSummary.

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.

func (ExpressRouteCircuitSKU) MarshalJSON

func (e ExpressRouteCircuitSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitSKU.

func (*ExpressRouteCircuitSKU) UnmarshalJSON

func (e *ExpressRouteCircuitSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitSKU.

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.

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.

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.

func (ExpressRouteCircuitServiceProviderProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitServiceProviderProperties.

func (*ExpressRouteCircuitServiceProviderProperties) UnmarshalJSON

func (e *ExpressRouteCircuitServiceProviderProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitServiceProviderProperties.

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.

func (ExpressRouteCircuitStats) MarshalJSON

func (e ExpressRouteCircuitStats) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitStats.

func (*ExpressRouteCircuitStats) UnmarshalJSON

func (e *ExpressRouteCircuitStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCircuitStats.

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.

func (*ExpressRouteCircuitsArpTableListResult) UnmarshalJSON

func (e *ExpressRouteCircuitsArpTableListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

BeginCreateOrUpdate - Creates or updates an express route circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateExpressRouteCircuit)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "circuitName", armnetwork.ExpressRouteCircuit{
	Location: to.Ptr("Brazil South"),
	Properties: &armnetwork.ExpressRouteCircuitPropertiesFormat{
		AllowClassicOperations: to.Ptr(false),
		Authorizations:         []*armnetwork.ExpressRouteCircuitAuthorization{},
		Peerings:               []*armnetwork.ExpressRouteCircuitPeering{},
		ServiceProviderProperties: &armnetwork.ExpressRouteCircuitServiceProviderProperties{
			BandwidthInMbps:     to.Ptr[int32](200),
			PeeringLocation:     to.Ptr("Silicon Valley"),
			ServiceProviderName: to.Ptr("Equinix"),
		},
	},
	SKU: &armnetwork.ExpressRouteCircuitSKU{
		Name:   to.Ptr("Standard_MeteredData"),
		Family: to.Ptr(armnetwork.ExpressRouteCircuitSKUFamilyMeteredData),
		Tier:   to.Ptr(armnetwork.ExpressRouteCircuitSKUTierStandard),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateExpressRouteCircuitOnExpressRoutePort)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "expressRouteCircuit1", armnetwork.ExpressRouteCircuit{
	Location: to.Ptr("westus"),
	Properties: &armnetwork.ExpressRouteCircuitPropertiesFormat{
		AuthorizationKey: to.Ptr("b0be57f5-1fba-463b-adec-ffe767354cdd"),
		BandwidthInGbps:  to.Ptr[float32](10),
		ExpressRoutePort: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName"),
		},
	},
	SKU: &armnetwork.ExpressRouteCircuitSKU{
		Name:   to.Ptr("Premium_MeteredData"),
		Family: to.Ptr(armnetwork.ExpressRouteCircuitSKUFamilyMeteredData),
		Tier:   to.Ptr(armnetwork.ExpressRouteCircuitSKUTierPremium),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitsClient) BeginDelete

BeginDelete - Deletes the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "circuitName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ExpressRouteCircuitsClient) BeginListArpTable

func (client *ExpressRouteCircuitsClient) BeginListArpTable(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string, options *ExpressRouteCircuitsClientBeginListArpTableOptions) (*runtime.Poller[ExpressRouteCircuitsClientListArpTableResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitARPTableList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListArpTable(ctx, "rg1", "circuitName", "peeringName", "devicePath", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitsClient) BeginListRoutesTable

func (client *ExpressRouteCircuitsClient) BeginListRoutesTable(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string, options *ExpressRouteCircuitsClientBeginListRoutesTableOptions) (*runtime.Poller[ExpressRouteCircuitsClientListRoutesTableResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitRouteTableList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListRoutesTable(ctx, "rg1", "circuitName", "peeringName", "devicePath", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitsClient) BeginListRoutesTableSummary

func (client *ExpressRouteCircuitsClient) BeginListRoutesTableSummary(ctx context.Context, resourceGroupName string, circuitName string, peeringName string, devicePath string, options *ExpressRouteCircuitsClientBeginListRoutesTableSummaryOptions) (*runtime.Poller[ExpressRouteCircuitsClientListRoutesTableSummaryResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitRouteTableSummaryList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListRoutesTableSummary(ctx, "rg1", "circuitName", "peeringName", "devicePath", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitsClient) Get

Get - Gets information about the specified express route circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "circuitName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitsClient) GetPeeringStats

GetPeeringStats - Gets all stats from an express route circuit in a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitPeeringStats.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetPeeringStats(ctx, "rg1", "circuitName", "peeringName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitsClient) GetStats

GetStats - Gets all the stats from an express route circuit in a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitStats.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetStats(ctx, "rg1", "circuitName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCircuitsClient) NewListAllPager

NewListAllPager - Gets all the express route circuits in a subscription. Generated from API version 2022-05-01 options - ExpressRouteCircuitsClientListAllOptions contains the optional parameters for the ExpressRouteCircuitsClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ExpressRouteCircuitsClient) NewListPager

NewListPager - Gets all the express route circuits in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - ExpressRouteCircuitsClientListOptions contains the optional parameters for the ExpressRouteCircuitsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ExpressRouteCircuitsClient) UpdateTags

UpdateTags - Updates an express route circuit tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCircuitUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCircuitsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "ertest", "er1", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ExpressRouteCircuitsClientBeginCreateOrUpdateOptions

type ExpressRouteCircuitsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginCreateOrUpdate method.

type ExpressRouteCircuitsClientBeginDeleteOptions

type ExpressRouteCircuitsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginDelete method.

type ExpressRouteCircuitsClientBeginListArpTableOptions

type ExpressRouteCircuitsClientBeginListArpTableOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitsClientBeginListArpTableOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginListArpTable method.

type ExpressRouteCircuitsClientBeginListRoutesTableOptions

type ExpressRouteCircuitsClientBeginListRoutesTableOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitsClientBeginListRoutesTableOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginListRoutesTable method.

type ExpressRouteCircuitsClientBeginListRoutesTableSummaryOptions

type ExpressRouteCircuitsClientBeginListRoutesTableSummaryOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCircuitsClientBeginListRoutesTableSummaryOptions contains the optional parameters for the ExpressRouteCircuitsClient.BeginListRoutesTableSummary method.

type ExpressRouteCircuitsClientCreateOrUpdateResponse

type ExpressRouteCircuitsClientCreateOrUpdateResponse struct {
	ExpressRouteCircuit
}

ExpressRouteCircuitsClientCreateOrUpdateResponse contains the response from method ExpressRouteCircuitsClient.CreateOrUpdate.

type ExpressRouteCircuitsClientDeleteResponse

type ExpressRouteCircuitsClientDeleteResponse struct {
}

ExpressRouteCircuitsClientDeleteResponse contains the response from method ExpressRouteCircuitsClient.Delete.

type ExpressRouteCircuitsClientGetOptions

type ExpressRouteCircuitsClientGetOptions struct {
}

ExpressRouteCircuitsClientGetOptions contains the optional parameters for the ExpressRouteCircuitsClient.Get method.

type ExpressRouteCircuitsClientGetPeeringStatsOptions

type ExpressRouteCircuitsClientGetPeeringStatsOptions struct {
}

ExpressRouteCircuitsClientGetPeeringStatsOptions contains the optional parameters for the ExpressRouteCircuitsClient.GetPeeringStats method.

type ExpressRouteCircuitsClientGetPeeringStatsResponse

type ExpressRouteCircuitsClientGetPeeringStatsResponse struct {
	ExpressRouteCircuitStats
}

ExpressRouteCircuitsClientGetPeeringStatsResponse contains the response from method ExpressRouteCircuitsClient.GetPeeringStats.

type ExpressRouteCircuitsClientGetResponse

type ExpressRouteCircuitsClientGetResponse struct {
	ExpressRouteCircuit
}

ExpressRouteCircuitsClientGetResponse contains the response from method ExpressRouteCircuitsClient.Get.

type ExpressRouteCircuitsClientGetStatsOptions

type ExpressRouteCircuitsClientGetStatsOptions struct {
}

ExpressRouteCircuitsClientGetStatsOptions contains the optional parameters for the ExpressRouteCircuitsClient.GetStats method.

type ExpressRouteCircuitsClientGetStatsResponse

type ExpressRouteCircuitsClientGetStatsResponse struct {
	ExpressRouteCircuitStats
}

ExpressRouteCircuitsClientGetStatsResponse contains the response from method ExpressRouteCircuitsClient.GetStats.

type ExpressRouteCircuitsClientListAllOptions

type ExpressRouteCircuitsClientListAllOptions struct {
}

ExpressRouteCircuitsClientListAllOptions contains the optional parameters for the ExpressRouteCircuitsClient.ListAll method.

type ExpressRouteCircuitsClientListAllResponse

type ExpressRouteCircuitsClientListAllResponse struct {
	ExpressRouteCircuitListResult
}

ExpressRouteCircuitsClientListAllResponse contains the response from method ExpressRouteCircuitsClient.ListAll.

type ExpressRouteCircuitsClientListArpTableResponse

type ExpressRouteCircuitsClientListArpTableResponse struct {
	ExpressRouteCircuitsArpTableListResult
}

ExpressRouteCircuitsClientListArpTableResponse contains the response from method ExpressRouteCircuitsClient.ListArpTable.

type ExpressRouteCircuitsClientListOptions

type ExpressRouteCircuitsClientListOptions struct {
}

ExpressRouteCircuitsClientListOptions contains the optional parameters for the ExpressRouteCircuitsClient.List method.

type ExpressRouteCircuitsClientListResponse

type ExpressRouteCircuitsClientListResponse struct {
	ExpressRouteCircuitListResult
}

ExpressRouteCircuitsClientListResponse contains the response from method ExpressRouteCircuitsClient.List.

type ExpressRouteCircuitsClientListRoutesTableResponse

type ExpressRouteCircuitsClientListRoutesTableResponse struct {
	ExpressRouteCircuitsRoutesTableListResult
}

ExpressRouteCircuitsClientListRoutesTableResponse contains the response from method ExpressRouteCircuitsClient.ListRoutesTable.

type ExpressRouteCircuitsClientListRoutesTableSummaryResponse

type ExpressRouteCircuitsClientListRoutesTableSummaryResponse struct {
	ExpressRouteCircuitsRoutesTableSummaryListResult
}

ExpressRouteCircuitsClientListRoutesTableSummaryResponse contains the response from method ExpressRouteCircuitsClient.ListRoutesTableSummary.

type ExpressRouteCircuitsClientUpdateTagsOptions

type ExpressRouteCircuitsClientUpdateTagsOptions struct {
}

ExpressRouteCircuitsClientUpdateTagsOptions contains the optional parameters for the ExpressRouteCircuitsClient.UpdateTags method.

type ExpressRouteCircuitsClientUpdateTagsResponse

type ExpressRouteCircuitsClientUpdateTagsResponse struct {
	ExpressRouteCircuit
}

ExpressRouteCircuitsClientUpdateTagsResponse contains the response 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

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitsRoutesTableListResult.

func (*ExpressRouteCircuitsRoutesTableListResult) UnmarshalJSON

func (e *ExpressRouteCircuitsRoutesTableListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCircuitsRoutesTableSummaryListResult.

func (*ExpressRouteCircuitsRoutesTableSummaryListResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteConnection) MarshalJSON

func (e ExpressRouteConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteConnection.

func (*ExpressRouteConnection) UnmarshalJSON

func (e *ExpressRouteConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteConnection.

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.

func (ExpressRouteConnectionID) MarshalJSON

func (e ExpressRouteConnectionID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteConnectionID.

func (*ExpressRouteConnectionID) UnmarshalJSON

func (e *ExpressRouteConnectionID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteConnectionID.

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.

func (*ExpressRouteConnectionList) UnmarshalJSON

func (e *ExpressRouteConnectionList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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"`

	// Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be
	// enabled.
	EnablePrivateLinkFastPath *bool `json:"enablePrivateLinkFastPath,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.

func (ExpressRouteConnectionProperties) MarshalJSON

func (e ExpressRouteConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteConnectionProperties.

func (*ExpressRouteConnectionProperties) UnmarshalJSON

func (e *ExpressRouteConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteConnectionProperties.

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, error)

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) (*runtime.Poller[ExpressRouteConnectionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteConnectionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "resourceGroupName", "gateway-2", "connectionName", armnetwork.ExpressRouteConnection{
	ID:   to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2/expressRouteConnections/connectionName"),
	Name: to.Ptr("connectionName"),
	Properties: &armnetwork.ExpressRouteConnectionProperties{
		AuthorizationKey: to.Ptr("authorizationKey"),
		ExpressRouteCircuitPeering: &armnetwork.ExpressRouteCircuitPeeringID{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering"),
		},
		RoutingConfiguration: &armnetwork.RoutingConfiguration{
			AssociatedRouteTable: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
			},
			InboundRouteMap: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"),
			},
			OutboundRouteMap: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"),
			},
			PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
				IDs: []*armnetwork.SubResource{
					{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
					},
					{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"),
					},
					{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"),
					}},
				Labels: []*string{
					to.Ptr("label1"),
					to.Ptr("label2")},
			},
		},
		RoutingWeight: to.Ptr[int32](2),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteConnectionsClient) BeginDelete

func (client *ExpressRouteConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, expressRouteGatewayName string, connectionName string, options *ExpressRouteConnectionsClientBeginDeleteOptions) (*runtime.Poller[ExpressRouteConnectionsClientDeleteResponse], error)

BeginDelete - Deletes a connection to a ExpressRoute circuit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteConnectionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "resourceGroupName", "expressRouteGatewayName", "connectionName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "resourceGroupName", "expressRouteGatewayName", "connectionName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteConnectionsClient) List

List - Lists ExpressRouteConnections. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteConnectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx, "resourceGroupName", "expressRouteGatewayName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ExpressRouteConnectionsClientBeginCreateOrUpdateOptions

type ExpressRouteConnectionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteConnectionsClient.BeginCreateOrUpdate method.

type ExpressRouteConnectionsClientBeginDeleteOptions

type ExpressRouteConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteConnectionsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteConnectionsClient.BeginDelete method.

type ExpressRouteConnectionsClientCreateOrUpdateResponse

type ExpressRouteConnectionsClientCreateOrUpdateResponse struct {
	ExpressRouteConnection
}

ExpressRouteConnectionsClientCreateOrUpdateResponse contains the response from method ExpressRouteConnectionsClient.CreateOrUpdate.

type ExpressRouteConnectionsClientDeleteResponse

type ExpressRouteConnectionsClientDeleteResponse struct {
}

ExpressRouteConnectionsClientDeleteResponse contains the response from method ExpressRouteConnectionsClient.Delete.

type ExpressRouteConnectionsClientGetOptions

type ExpressRouteConnectionsClientGetOptions struct {
}

ExpressRouteConnectionsClientGetOptions contains the optional parameters for the ExpressRouteConnectionsClient.Get method.

type ExpressRouteConnectionsClientGetResponse

type ExpressRouteConnectionsClientGetResponse struct {
	ExpressRouteConnection
}

ExpressRouteConnectionsClientGetResponse contains the response from method ExpressRouteConnectionsClient.Get.

type ExpressRouteConnectionsClientListOptions

type ExpressRouteConnectionsClientListOptions struct {
}

ExpressRouteConnectionsClientListOptions contains the optional parameters for the ExpressRouteConnectionsClient.List method.

type ExpressRouteConnectionsClientListResponse

type ExpressRouteConnectionsClientListResponse struct {
	ExpressRouteConnectionList
}

ExpressRouteConnectionsClientListResponse contains the response 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.

func (*ExpressRouteCrossConnection) UnmarshalJSON

func (e *ExpressRouteCrossConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ExpressRouteCrossConnectionListResult) UnmarshalJSON

func (e *ExpressRouteCrossConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteCrossConnectionPeering) MarshalJSON

func (e ExpressRouteCrossConnectionPeering) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCrossConnectionPeering.

func (*ExpressRouteCrossConnectionPeering) UnmarshalJSON

func (e *ExpressRouteCrossConnectionPeering) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCrossConnectionPeering.

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.

func (*ExpressRouteCrossConnectionPeeringList) UnmarshalJSON

func (e *ExpressRouteCrossConnectionPeeringList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteCrossConnectionPeeringProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCrossConnectionPeeringProperties.

func (*ExpressRouteCrossConnectionPeeringProperties) UnmarshalJSON

func (e *ExpressRouteCrossConnectionPeeringProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCrossConnectionPeeringProperties.

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, error)

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

BeginCreateOrUpdate - Creates or updates a peering in the specified ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", "AzurePrivatePeering", armnetwork.ExpressRouteCrossConnectionPeering{
	Properties: &armnetwork.ExpressRouteCrossConnectionPeeringProperties{
		IPv6PeeringConfig: &armnetwork.IPv6ExpressRouteCircuitPeeringConfig{
			PrimaryPeerAddressPrefix:   to.Ptr("3FFE:FFFF:0:CD30::/126"),
			SecondaryPeerAddressPrefix: to.Ptr("3FFE:FFFF:0:CD30::4/126"),
		},
		PeerASN:                    to.Ptr[int64](200),
		PrimaryPeerAddressPrefix:   to.Ptr("192.168.16.252/30"),
		SecondaryPeerAddressPrefix: to.Ptr("192.168.18.252/30"),
		VlanID:                     to.Ptr[int32](200),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCrossConnectionPeeringsClient) BeginDelete

BeginDelete - Deletes the specified peering from the ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", "AzurePrivatePeering", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ExpressRouteCrossConnectionPeeringsClient) Get

Get - Gets the specified peering for the ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", "AzurePrivatePeering", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCrossConnectionPeeringsClient) NewListPager

NewListPager - Gets all peerings in a specified ExpressRouteCrossConnection. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("CrossConnection-SiliconValley", "<circuitServiceKey>", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ExpressRouteCrossConnectionPeeringsClientBeginCreateOrUpdateOptions

type ExpressRouteCrossConnectionPeeringsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCrossConnectionPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.BeginCreateOrUpdate method.

type ExpressRouteCrossConnectionPeeringsClientBeginDeleteOptions

type ExpressRouteCrossConnectionPeeringsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCrossConnectionPeeringsClientBeginDeleteOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.BeginDelete method.

type ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResponse

type ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResponse struct {
	ExpressRouteCrossConnectionPeering
}

ExpressRouteCrossConnectionPeeringsClientCreateOrUpdateResponse contains the response from method ExpressRouteCrossConnectionPeeringsClient.CreateOrUpdate.

type ExpressRouteCrossConnectionPeeringsClientDeleteResponse

type ExpressRouteCrossConnectionPeeringsClientDeleteResponse struct {
}

ExpressRouteCrossConnectionPeeringsClientDeleteResponse contains the response from method ExpressRouteCrossConnectionPeeringsClient.Delete.

type ExpressRouteCrossConnectionPeeringsClientGetOptions

type ExpressRouteCrossConnectionPeeringsClientGetOptions struct {
}

ExpressRouteCrossConnectionPeeringsClientGetOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.Get method.

type ExpressRouteCrossConnectionPeeringsClientGetResponse

type ExpressRouteCrossConnectionPeeringsClientGetResponse struct {
	ExpressRouteCrossConnectionPeering
}

ExpressRouteCrossConnectionPeeringsClientGetResponse contains the response from method ExpressRouteCrossConnectionPeeringsClient.Get.

type ExpressRouteCrossConnectionPeeringsClientListOptions

type ExpressRouteCrossConnectionPeeringsClientListOptions struct {
}

ExpressRouteCrossConnectionPeeringsClientListOptions contains the optional parameters for the ExpressRouteCrossConnectionPeeringsClient.List method.

type ExpressRouteCrossConnectionPeeringsClientListResponse

type ExpressRouteCrossConnectionPeeringsClientListResponse struct {
	ExpressRouteCrossConnectionPeeringList
}

ExpressRouteCrossConnectionPeeringsClientListResponse contains the response 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.

func (*ExpressRouteCrossConnectionProperties) UnmarshalJSON

func (e *ExpressRouteCrossConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteCrossConnectionRoutesTableSummary) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCrossConnectionRoutesTableSummary.

func (*ExpressRouteCrossConnectionRoutesTableSummary) UnmarshalJSON

func (e *ExpressRouteCrossConnectionRoutesTableSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteCrossConnectionRoutesTableSummary.

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, error)

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

BeginCreateOrUpdate - Update the specified ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", armnetwork.ExpressRouteCrossConnection{
	Properties: &armnetwork.ExpressRouteCrossConnectionProperties{
		ServiceProviderProvisioningState: to.Ptr(armnetwork.ServiceProviderProvisioningStateNotProvisioned),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCrossConnectionsClient) BeginListArpTable

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionsArpTable.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListArpTable(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", "AzurePrivatePeering", "primary", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCrossConnectionsClient) BeginListRoutesTable

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionsRouteTable.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListRoutesTable(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", "AzurePrivatePeering", "primary", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCrossConnectionsClient) BeginListRoutesTableSummary

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListRoutesTableSummary(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", "AzurePrivatePeering", "primary", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCrossConnectionsClient) Get

Get - Gets details about the specified ExpressRouteCrossConnection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteCrossConnectionsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Retrieves all the ExpressRouteCrossConnections in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - ExpressRouteCrossConnectionsClientListByResourceGroupOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("CrossConnection-SiliconValley", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ExpressRouteCrossConnectionsClient) NewListPager

NewListPager - Retrieves all the ExpressRouteCrossConnections in a subscription. Generated from API version 2022-05-01 options - ExpressRouteCrossConnectionsClientListOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteCrossConnectionUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteCrossConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ExpressRouteCrossConnectionsClientBeginCreateOrUpdateOptions

type ExpressRouteCrossConnectionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCrossConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginCreateOrUpdate method.

type ExpressRouteCrossConnectionsClientBeginListArpTableOptions

type ExpressRouteCrossConnectionsClientBeginListArpTableOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCrossConnectionsClientBeginListArpTableOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginListArpTable method.

type ExpressRouteCrossConnectionsClientBeginListRoutesTableOptions

type ExpressRouteCrossConnectionsClientBeginListRoutesTableOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCrossConnectionsClientBeginListRoutesTableOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginListRoutesTable method.

type ExpressRouteCrossConnectionsClientBeginListRoutesTableSummaryOptions

type ExpressRouteCrossConnectionsClientBeginListRoutesTableSummaryOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteCrossConnectionsClientBeginListRoutesTableSummaryOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.BeginListRoutesTableSummary method.

type ExpressRouteCrossConnectionsClientCreateOrUpdateResponse

type ExpressRouteCrossConnectionsClientCreateOrUpdateResponse struct {
	ExpressRouteCrossConnection
}

ExpressRouteCrossConnectionsClientCreateOrUpdateResponse contains the response from method ExpressRouteCrossConnectionsClient.CreateOrUpdate.

type ExpressRouteCrossConnectionsClientGetOptions

type ExpressRouteCrossConnectionsClientGetOptions struct {
}

ExpressRouteCrossConnectionsClientGetOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.Get method.

type ExpressRouteCrossConnectionsClientGetResponse

type ExpressRouteCrossConnectionsClientGetResponse struct {
	ExpressRouteCrossConnection
}

ExpressRouteCrossConnectionsClientGetResponse contains the response from method ExpressRouteCrossConnectionsClient.Get.

type ExpressRouteCrossConnectionsClientListArpTableResponse

type ExpressRouteCrossConnectionsClientListArpTableResponse struct {
	ExpressRouteCircuitsArpTableListResult
}

ExpressRouteCrossConnectionsClientListArpTableResponse contains the response from method ExpressRouteCrossConnectionsClient.ListArpTable.

type ExpressRouteCrossConnectionsClientListByResourceGroupOptions

type ExpressRouteCrossConnectionsClientListByResourceGroupOptions struct {
}

ExpressRouteCrossConnectionsClientListByResourceGroupOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.ListByResourceGroup method.

type ExpressRouteCrossConnectionsClientListByResourceGroupResponse

type ExpressRouteCrossConnectionsClientListByResourceGroupResponse struct {
	ExpressRouteCrossConnectionListResult
}

ExpressRouteCrossConnectionsClientListByResourceGroupResponse contains the response from method ExpressRouteCrossConnectionsClient.ListByResourceGroup.

type ExpressRouteCrossConnectionsClientListOptions

type ExpressRouteCrossConnectionsClientListOptions struct {
}

ExpressRouteCrossConnectionsClientListOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.List method.

type ExpressRouteCrossConnectionsClientListResponse

type ExpressRouteCrossConnectionsClientListResponse struct {
	ExpressRouteCrossConnectionListResult
}

ExpressRouteCrossConnectionsClientListResponse contains the response from method ExpressRouteCrossConnectionsClient.List.

type ExpressRouteCrossConnectionsClientListRoutesTableResponse

type ExpressRouteCrossConnectionsClientListRoutesTableResponse struct {
	ExpressRouteCircuitsRoutesTableListResult
}

ExpressRouteCrossConnectionsClientListRoutesTableResponse contains the response from method ExpressRouteCrossConnectionsClient.ListRoutesTable.

type ExpressRouteCrossConnectionsClientListRoutesTableSummaryResponse

type ExpressRouteCrossConnectionsClientListRoutesTableSummaryResponse struct {
	ExpressRouteCrossConnectionsRoutesTableSummaryListResult
}

ExpressRouteCrossConnectionsClientListRoutesTableSummaryResponse contains the response from method ExpressRouteCrossConnectionsClient.ListRoutesTableSummary.

type ExpressRouteCrossConnectionsClientUpdateTagsOptions

type ExpressRouteCrossConnectionsClientUpdateTagsOptions struct {
}

ExpressRouteCrossConnectionsClientUpdateTagsOptions contains the optional parameters for the ExpressRouteCrossConnectionsClient.UpdateTags method.

type ExpressRouteCrossConnectionsClientUpdateTagsResponse

type ExpressRouteCrossConnectionsClientUpdateTagsResponse struct {
	ExpressRouteCrossConnection
}

ExpressRouteCrossConnectionsClientUpdateTagsResponse contains the response 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

MarshalJSON implements the json.Marshaller interface for type ExpressRouteCrossConnectionsRoutesTableSummaryListResult.

func (*ExpressRouteCrossConnectionsRoutesTableSummaryListResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ExpressRouteGateway) UnmarshalJSON

func (e *ExpressRouteGateway) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ExpressRouteGatewayList) UnmarshalJSON

func (e *ExpressRouteGatewayList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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"`

	// Configures this gateway to accept traffic from non Virtual WAN networks.
	AllowNonVirtualWanTraffic *bool `json:"allowNonVirtualWanTraffic,omitempty"`

	// Configuration for auto scaling.
	AutoScaleConfiguration *ExpressRouteGatewayPropertiesAutoScaleConfiguration `json:"autoScaleConfiguration,omitempty"`

	// List of ExpressRoute connections to the ExpressRoute gateway.
	ExpressRouteConnections []*ExpressRouteConnection `json:"expressRouteConnections,omitempty"`

	// 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.

func (*ExpressRouteGatewayProperties) UnmarshalJSON

func (e *ExpressRouteGatewayProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteGatewayPropertiesAutoScaleConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ExpressRouteGatewayPropertiesAutoScaleConfiguration.

func (*ExpressRouteGatewayPropertiesAutoScaleConfiguration) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteGatewayPropertiesAutoScaleConfiguration.

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.

func (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds.

func (*ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds.

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, error)

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) (*runtime.Poller[ExpressRouteGatewaysClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a ExpressRoute gateway in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteGatewayCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "resourceGroupName", "gateway-2", armnetwork.ExpressRouteGateway{
	Location: to.Ptr("westus"),
	Properties: &armnetwork.ExpressRouteGatewayProperties{
		AllowNonVirtualWanTraffic: to.Ptr(false),
		AutoScaleConfiguration: &armnetwork.ExpressRouteGatewayPropertiesAutoScaleConfiguration{
			Bounds: &armnetwork.ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds{
				Min: to.Ptr[int32](3),
			},
		},
		VirtualHub: &armnetwork.VirtualHubID{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupId/providers/Microsoft.Network/virtualHubs/virtualHubName"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteGatewaysClient) BeginDelete

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteGatewayDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "resourceGroupName", "expressRouteGatewayName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ExpressRouteGatewaysClient) BeginUpdateTags

func (client *ExpressRouteGatewaysClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, expressRouteGatewayName string, expressRouteGatewayParameters TagsObject, options *ExpressRouteGatewaysClientBeginUpdateTagsOptions) (*runtime.Poller[ExpressRouteGatewaysClientUpdateTagsResponse], error)

BeginUpdateTags - Updates express route gateway tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteGatewayUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdateTags(ctx, "resourceGroupName", "expressRouteGatewayName", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteGatewayGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "resourceGroupName", "expressRouteGatewayName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteGatewaysClient) ListByResourceGroup

ListByResourceGroup - Lists ExpressRoute gateways in a given resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - ExpressRouteGatewaysClientListByResourceGroupOptions contains the optional parameters for the ExpressRouteGatewaysClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteGatewayListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListByResourceGroup(ctx, "resourceGroupName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteGatewaysClient) ListBySubscription

ListBySubscription - Lists ExpressRoute gateways under a given subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 options - ExpressRouteGatewaysClientListBySubscriptionOptions contains the optional parameters for the ExpressRouteGatewaysClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteGatewayListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListBySubscription(ctx, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ExpressRouteGatewaysClientBeginCreateOrUpdateOptions

type ExpressRouteGatewaysClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRouteGatewaysClient.BeginCreateOrUpdate method.

type ExpressRouteGatewaysClientBeginDeleteOptions

type ExpressRouteGatewaysClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteGatewaysClientBeginDeleteOptions contains the optional parameters for the ExpressRouteGatewaysClient.BeginDelete method.

type ExpressRouteGatewaysClientBeginUpdateTagsOptions

type ExpressRouteGatewaysClientBeginUpdateTagsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRouteGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the ExpressRouteGatewaysClient.BeginUpdateTags method.

type ExpressRouteGatewaysClientCreateOrUpdateResponse

type ExpressRouteGatewaysClientCreateOrUpdateResponse struct {
	ExpressRouteGateway
}

ExpressRouteGatewaysClientCreateOrUpdateResponse contains the response from method ExpressRouteGatewaysClient.CreateOrUpdate.

type ExpressRouteGatewaysClientDeleteResponse

type ExpressRouteGatewaysClientDeleteResponse struct {
}

ExpressRouteGatewaysClientDeleteResponse contains the response from method ExpressRouteGatewaysClient.Delete.

type ExpressRouteGatewaysClientGetOptions

type ExpressRouteGatewaysClientGetOptions struct {
}

ExpressRouteGatewaysClientGetOptions contains the optional parameters for the ExpressRouteGatewaysClient.Get method.

type ExpressRouteGatewaysClientGetResponse

type ExpressRouteGatewaysClientGetResponse struct {
	ExpressRouteGateway
}

ExpressRouteGatewaysClientGetResponse contains the response from method ExpressRouteGatewaysClient.Get.

type ExpressRouteGatewaysClientListByResourceGroupOptions

type ExpressRouteGatewaysClientListByResourceGroupOptions struct {
}

ExpressRouteGatewaysClientListByResourceGroupOptions contains the optional parameters for the ExpressRouteGatewaysClient.ListByResourceGroup method.

type ExpressRouteGatewaysClientListByResourceGroupResponse

type ExpressRouteGatewaysClientListByResourceGroupResponse struct {
	ExpressRouteGatewayList
}

ExpressRouteGatewaysClientListByResourceGroupResponse contains the response from method ExpressRouteGatewaysClient.ListByResourceGroup.

type ExpressRouteGatewaysClientListBySubscriptionOptions

type ExpressRouteGatewaysClientListBySubscriptionOptions struct {
}

ExpressRouteGatewaysClientListBySubscriptionOptions contains the optional parameters for the ExpressRouteGatewaysClient.ListBySubscription method.

type ExpressRouteGatewaysClientListBySubscriptionResponse

type ExpressRouteGatewaysClientListBySubscriptionResponse struct {
	ExpressRouteGatewayList
}

ExpressRouteGatewaysClientListBySubscriptionResponse contains the response from method ExpressRouteGatewaysClient.ListBySubscription.

type ExpressRouteGatewaysClientUpdateTagsResponse

type ExpressRouteGatewaysClientUpdateTagsResponse struct {
	ExpressRouteGateway
}

ExpressRouteGatewaysClientUpdateTagsResponse contains the response 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.

func (ExpressRouteLink) MarshalJSON

func (e ExpressRouteLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteLink.

func (*ExpressRouteLink) UnmarshalJSON

func (e *ExpressRouteLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteLink.

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.

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.

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.

func (*ExpressRouteLinkListResult) UnmarshalJSON

func (e *ExpressRouteLinkListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (ExpressRouteLinkMacSecConfig) MarshalJSON

func (e ExpressRouteLinkMacSecConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteLinkMacSecConfig.

func (*ExpressRouteLinkMacSecConfig) UnmarshalJSON

func (e *ExpressRouteLinkMacSecConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteLinkMacSecConfig.

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.

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; Cololocation for ExpressRoute Hybrid Direct.
	ColoLocation *string `json:"coloLocation,omitempty" azure:"ro"`

	// 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.

func (ExpressRouteLinkPropertiesFormat) MarshalJSON

func (e ExpressRouteLinkPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteLinkPropertiesFormat.

func (*ExpressRouteLinkPropertiesFormat) UnmarshalJSON

func (e *ExpressRouteLinkPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteLinkPropertiesFormat.

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, error)

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteLinkGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteLinksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "portName", "linkName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRouteLinksClient) NewListPager

func (client *ExpressRouteLinksClient) NewListPager(resourceGroupName string, expressRoutePortName string, options *ExpressRouteLinksClientListOptions) *runtime.Pager[ExpressRouteLinksClientListResponse]

NewListPager - Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteLinkList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteLinksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "portName", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ExpressRouteLinksClientGetOptions

type ExpressRouteLinksClientGetOptions struct {
}

ExpressRouteLinksClientGetOptions contains the optional parameters for the ExpressRouteLinksClient.Get method.

type ExpressRouteLinksClientGetResponse

type ExpressRouteLinksClientGetResponse struct {
	ExpressRouteLink
}

ExpressRouteLinksClientGetResponse contains the response from method ExpressRouteLinksClient.Get.

type ExpressRouteLinksClientListOptions

type ExpressRouteLinksClientListOptions struct {
}

ExpressRouteLinksClientListOptions contains the optional parameters for the ExpressRouteLinksClient.List method.

type ExpressRouteLinksClientListResponse

type ExpressRouteLinksClientListResponse struct {
	ExpressRouteLinkListResult
}

ExpressRouteLinksClientListResponse contains the response 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.

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.

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.

func (*ExpressRoutePort) UnmarshalJSON

func (e *ExpressRoutePort) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRoutePort.

type ExpressRoutePortAuthorization

type ExpressRoutePortAuthorization 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"`

	// ExpressRoutePort properties.
	Properties *ExpressRoutePortAuthorizationPropertiesFormat `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"`
}

ExpressRoutePortAuthorization - ExpressRoutePort Authorization resource definition.

func (ExpressRoutePortAuthorization) MarshalJSON

func (e ExpressRoutePortAuthorization) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePortAuthorization.

func (*ExpressRoutePortAuthorization) UnmarshalJSON

func (e *ExpressRoutePortAuthorization) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRoutePortAuthorization.

type ExpressRoutePortAuthorizationListResult

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

	// The authorizations in an ExpressRoute Port.
	Value []*ExpressRoutePortAuthorization `json:"value,omitempty"`
}

ExpressRoutePortAuthorizationListResult - Response for ListExpressRoutePortAuthorizations API service call.

func (ExpressRoutePortAuthorizationListResult) MarshalJSON

func (e ExpressRoutePortAuthorizationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePortAuthorizationListResult.

func (*ExpressRoutePortAuthorizationListResult) UnmarshalJSON

func (e *ExpressRoutePortAuthorizationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRoutePortAuthorizationListResult.

type ExpressRoutePortAuthorizationPropertiesFormat

type ExpressRoutePortAuthorizationPropertiesFormat struct {
	// READ-ONLY; The authorization key.
	AuthorizationKey *string `json:"authorizationKey,omitempty" azure:"ro"`

	// READ-ONLY; The authorization use status.
	AuthorizationUseStatus *ExpressRoutePortAuthorizationUseStatus `json:"authorizationUseStatus,omitempty" azure:"ro"`

	// READ-ONLY; The reference to the ExpressRoute circuit resource using the authorization.
	CircuitResourceURI *string `json:"circuitResourceUri,omitempty" azure:"ro"`

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

ExpressRoutePortAuthorizationPropertiesFormat - Properties of ExpressRoutePort Authorization.

func (ExpressRoutePortAuthorizationPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePortAuthorizationPropertiesFormat.

func (*ExpressRoutePortAuthorizationPropertiesFormat) UnmarshalJSON

func (e *ExpressRoutePortAuthorizationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRoutePortAuthorizationPropertiesFormat.

type ExpressRoutePortAuthorizationUseStatus

type ExpressRoutePortAuthorizationUseStatus string

ExpressRoutePortAuthorizationUseStatus - The authorization use status.

const (
	ExpressRoutePortAuthorizationUseStatusAvailable ExpressRoutePortAuthorizationUseStatus = "Available"
	ExpressRoutePortAuthorizationUseStatusInUse     ExpressRoutePortAuthorizationUseStatus = "InUse"
)

func PossibleExpressRoutePortAuthorizationUseStatusValues

func PossibleExpressRoutePortAuthorizationUseStatusValues() []ExpressRoutePortAuthorizationUseStatus

PossibleExpressRoutePortAuthorizationUseStatusValues returns the possible values for the ExpressRoutePortAuthorizationUseStatus const type.

type ExpressRoutePortAuthorizationsClient

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

ExpressRoutePortAuthorizationsClient contains the methods for the ExpressRoutePortAuthorizations group. Don't use this type directly, use NewExpressRoutePortAuthorizationsClient() instead.

func NewExpressRoutePortAuthorizationsClient

func NewExpressRoutePortAuthorizationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ExpressRoutePortAuthorizationsClient, error)

NewExpressRoutePortAuthorizationsClient creates a new instance of ExpressRoutePortAuthorizationsClient 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 (*ExpressRoutePortAuthorizationsClient) BeginCreateOrUpdate

BeginCreateOrUpdate - Creates or updates an authorization in the specified express route port. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. expressRoutePortName - The name of the express route port. authorizationName - The name of the authorization. authorizationParameters - Parameters supplied to the create or update express route port authorization operation. options - ExpressRoutePortAuthorizationsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRoutePortAuthorizationsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortAuthorizationCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortAuthorizationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "expressRoutePortName", "authorizatinName", armnetwork.ExpressRoutePortAuthorization{
	Properties: &armnetwork.ExpressRoutePortAuthorizationPropertiesFormat{},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRoutePortAuthorizationsClient) BeginDelete

BeginDelete - Deletes the specified authorization from the specified express route port. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. expressRoutePortName - The name of the express route port. authorizationName - The name of the authorization. options - ExpressRoutePortAuthorizationsClientBeginDeleteOptions contains the optional parameters for the ExpressRoutePortAuthorizationsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortAuthorizationDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortAuthorizationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "expressRoutePortName", "authorizationName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ExpressRoutePortAuthorizationsClient) Get

Get - Gets the specified authorization from the specified express route port. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. expressRoutePortName - The name of the express route port. authorizationName - The name of the authorization. options - ExpressRoutePortAuthorizationsClientGetOptions contains the optional parameters for the ExpressRoutePortAuthorizationsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortAuthorizationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortAuthorizationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "expressRoutePortName", "authorizationName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRoutePortAuthorizationsClient) NewListPager

NewListPager - Gets all authorizations in an express route port. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. expressRoutePortName - The name of the express route port. options - ExpressRoutePortAuthorizationsClientListOptions contains the optional parameters for the ExpressRoutePortAuthorizationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortAuthorizationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortAuthorizationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "expressRoutePortName", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ExpressRoutePortAuthorizationsClientBeginCreateOrUpdateOptions

type ExpressRoutePortAuthorizationsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRoutePortAuthorizationsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRoutePortAuthorizationsClient.BeginCreateOrUpdate method.

type ExpressRoutePortAuthorizationsClientBeginDeleteOptions

type ExpressRoutePortAuthorizationsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRoutePortAuthorizationsClientBeginDeleteOptions contains the optional parameters for the ExpressRoutePortAuthorizationsClient.BeginDelete method.

type ExpressRoutePortAuthorizationsClientCreateOrUpdateResponse

type ExpressRoutePortAuthorizationsClientCreateOrUpdateResponse struct {
	ExpressRoutePortAuthorization
}

ExpressRoutePortAuthorizationsClientCreateOrUpdateResponse contains the response from method ExpressRoutePortAuthorizationsClient.CreateOrUpdate.

type ExpressRoutePortAuthorizationsClientDeleteResponse

type ExpressRoutePortAuthorizationsClientDeleteResponse struct {
}

ExpressRoutePortAuthorizationsClientDeleteResponse contains the response from method ExpressRoutePortAuthorizationsClient.Delete.

type ExpressRoutePortAuthorizationsClientGetOptions

type ExpressRoutePortAuthorizationsClientGetOptions struct {
}

ExpressRoutePortAuthorizationsClientGetOptions contains the optional parameters for the ExpressRoutePortAuthorizationsClient.Get method.

type ExpressRoutePortAuthorizationsClientGetResponse

type ExpressRoutePortAuthorizationsClientGetResponse struct {
	ExpressRoutePortAuthorization
}

ExpressRoutePortAuthorizationsClientGetResponse contains the response from method ExpressRoutePortAuthorizationsClient.Get.

type ExpressRoutePortAuthorizationsClientListOptions

type ExpressRoutePortAuthorizationsClientListOptions struct {
}

ExpressRoutePortAuthorizationsClientListOptions contains the optional parameters for the ExpressRoutePortAuthorizationsClient.List method.

type ExpressRoutePortAuthorizationsClientListResponse

type ExpressRoutePortAuthorizationsClientListResponse struct {
	ExpressRoutePortAuthorizationListResult
}

ExpressRoutePortAuthorizationsClientListResponse contains the response from method ExpressRoutePortAuthorizationsClient.List.

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.

func (*ExpressRoutePortListResult) UnmarshalJSON

func (e *ExpressRoutePortListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRoutePortListResult.

type ExpressRoutePortPropertiesFormat

type ExpressRoutePortPropertiesFormat struct {
	// Bandwidth of procured ports in Gbps.
	BandwidthInGbps *int32 `json:"bandwidthInGbps,omitempty"`

	// The billing type of the ExpressRoutePort resource.
	BillingType *ExpressRoutePortsBillingType `json:"billingType,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.

func (*ExpressRoutePortPropertiesFormat) UnmarshalJSON

func (e *ExpressRoutePortPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRoutePortPropertiesFormat.

type ExpressRoutePortsBillingType

type ExpressRoutePortsBillingType string

ExpressRoutePortsBillingType - The billing type of the ExpressRoutePort resource.

const (
	ExpressRoutePortsBillingTypeMeteredData   ExpressRoutePortsBillingType = "MeteredData"
	ExpressRoutePortsBillingTypeUnlimitedData ExpressRoutePortsBillingType = "UnlimitedData"
)

func PossibleExpressRoutePortsBillingTypeValues

func PossibleExpressRoutePortsBillingTypeValues() []ExpressRoutePortsBillingType

PossibleExpressRoutePortsBillingTypeValues returns the possible values for the ExpressRoutePortsBillingType const type.

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, error)

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) (*runtime.Poller[ExpressRoutePortsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates the specified ExpressRoutePort resource. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (ExpressRoutePortCreate)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "portName", armnetwork.ExpressRoutePort{
	Location: to.Ptr("westus"),
	Properties: &armnetwork.ExpressRoutePortPropertiesFormat{
		BandwidthInGbps: to.Ptr[int32](100),
		BillingType:     to.Ptr(armnetwork.ExpressRoutePortsBillingTypeUnlimitedData),
		Encapsulation:   to.Ptr(armnetwork.ExpressRoutePortsEncapsulationQinQ),
		PeeringLocation: to.Ptr("peeringLocationName"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRoutePortsClient) BeginDelete

func (client *ExpressRoutePortsClient) BeginDelete(ctx context.Context, resourceGroupName string, expressRoutePortName string, options *ExpressRoutePortsClientBeginDeleteOptions) (*runtime.Poller[ExpressRoutePortsClientDeleteResponse], error)

BeginDelete - Deletes the specified ExpressRoutePort resource. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "portName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ExpressRoutePortsClient) GenerateLOA

GenerateLOA - Generate a letter of authorization for the requested ExpressRoutePort resource. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/GenerateExpressRoutePortsLOA.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GenerateLOA(ctx, "rg1", "portName", armnetwork.GenerateExpressRoutePortsLOARequest{
	CustomerName: to.Ptr("customerName"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. expressRoutePortName - The name of ExpressRoutePort. options - ExpressRoutePortsClientGetOptions contains the optional parameters for the ExpressRoutePortsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "portName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRoutePortsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - List all the ExpressRoutePort resources in the specified resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - ExpressRoutePortsClientListByResourceGroupOptions contains the optional parameters for the ExpressRoutePortsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ExpressRoutePortsClient) NewListPager

NewListPager - List all the ExpressRoutePort resources in the specified subscription. Generated from API version 2022-05-01 options - ExpressRoutePortsClientListOptions contains the optional parameters for the ExpressRoutePortsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "portName", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ExpressRoutePortsClientBeginCreateOrUpdateOptions

type ExpressRoutePortsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRoutePortsClientBeginCreateOrUpdateOptions contains the optional parameters for the ExpressRoutePortsClient.BeginCreateOrUpdate method.

type ExpressRoutePortsClientBeginDeleteOptions

type ExpressRoutePortsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ExpressRoutePortsClientBeginDeleteOptions contains the optional parameters for the ExpressRoutePortsClient.BeginDelete method.

type ExpressRoutePortsClientCreateOrUpdateResponse

type ExpressRoutePortsClientCreateOrUpdateResponse struct {
	ExpressRoutePort
}

ExpressRoutePortsClientCreateOrUpdateResponse contains the response from method ExpressRoutePortsClient.CreateOrUpdate.

type ExpressRoutePortsClientDeleteResponse

type ExpressRoutePortsClientDeleteResponse struct {
}

ExpressRoutePortsClientDeleteResponse contains the response from method ExpressRoutePortsClient.Delete.

type ExpressRoutePortsClientGenerateLOAOptions

type ExpressRoutePortsClientGenerateLOAOptions struct {
}

ExpressRoutePortsClientGenerateLOAOptions contains the optional parameters for the ExpressRoutePortsClient.GenerateLOA method.

type ExpressRoutePortsClientGenerateLOAResponse

type ExpressRoutePortsClientGenerateLOAResponse struct {
	GenerateExpressRoutePortsLOAResult
}

ExpressRoutePortsClientGenerateLOAResponse contains the response from method ExpressRoutePortsClient.GenerateLOA.

type ExpressRoutePortsClientGetOptions

type ExpressRoutePortsClientGetOptions struct {
}

ExpressRoutePortsClientGetOptions contains the optional parameters for the ExpressRoutePortsClient.Get method.

type ExpressRoutePortsClientGetResponse

type ExpressRoutePortsClientGetResponse struct {
	ExpressRoutePort
}

ExpressRoutePortsClientGetResponse contains the response from method ExpressRoutePortsClient.Get.

type ExpressRoutePortsClientListByResourceGroupOptions

type ExpressRoutePortsClientListByResourceGroupOptions struct {
}

ExpressRoutePortsClientListByResourceGroupOptions contains the optional parameters for the ExpressRoutePortsClient.ListByResourceGroup method.

type ExpressRoutePortsClientListByResourceGroupResponse

type ExpressRoutePortsClientListByResourceGroupResponse struct {
	ExpressRoutePortListResult
}

ExpressRoutePortsClientListByResourceGroupResponse contains the response from method ExpressRoutePortsClient.ListByResourceGroup.

type ExpressRoutePortsClientListOptions

type ExpressRoutePortsClientListOptions struct {
}

ExpressRoutePortsClientListOptions contains the optional parameters for the ExpressRoutePortsClient.List method.

type ExpressRoutePortsClientListResponse

type ExpressRoutePortsClientListResponse struct {
	ExpressRoutePortListResult
}

ExpressRoutePortsClientListResponse contains the response from method ExpressRoutePortsClient.List.

type ExpressRoutePortsClientUpdateTagsOptions

type ExpressRoutePortsClientUpdateTagsOptions struct {
}

ExpressRoutePortsClientUpdateTagsOptions contains the optional parameters for the ExpressRoutePortsClient.UpdateTags method.

type ExpressRoutePortsClientUpdateTagsResponse

type ExpressRoutePortsClientUpdateTagsResponse struct {
	ExpressRoutePort
}

ExpressRoutePortsClientUpdateTagsResponse contains the response 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.

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.

func (*ExpressRoutePortsLocation) UnmarshalJSON

func (e *ExpressRoutePortsLocation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRoutePortsLocationBandwidths) MarshalJSON

func (e ExpressRoutePortsLocationBandwidths) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePortsLocationBandwidths.

func (*ExpressRoutePortsLocationBandwidths) UnmarshalJSON

func (e *ExpressRoutePortsLocationBandwidths) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRoutePortsLocationBandwidths.

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.

func (*ExpressRoutePortsLocationListResult) UnmarshalJSON

func (e *ExpressRoutePortsLocationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type ExpressRoutePortsLocationPropertiesFormat.

func (*ExpressRoutePortsLocationPropertiesFormat) UnmarshalJSON

func (e *ExpressRoutePortsLocationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

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. Generated from API version 2022-05-01 locationName - Name of the requested ExpressRoutePort peering location. options - ExpressRoutePortsLocationsClientGetOptions contains the optional parameters for the ExpressRoutePortsLocationsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortsLocationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortsLocationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "locationName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ExpressRoutePortsLocationsClient) NewListPager

NewListPager - 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. Generated from API version 2022-05-01 options - ExpressRoutePortsLocationsClientListOptions contains the optional parameters for the ExpressRoutePortsLocationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRoutePortsLocationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRoutePortsLocationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ExpressRoutePortsLocationsClientGetOptions

type ExpressRoutePortsLocationsClientGetOptions struct {
}

ExpressRoutePortsLocationsClientGetOptions contains the optional parameters for the ExpressRoutePortsLocationsClient.Get method.

type ExpressRoutePortsLocationsClientGetResponse

type ExpressRoutePortsLocationsClientGetResponse struct {
	ExpressRoutePortsLocation
}

ExpressRoutePortsLocationsClientGetResponse contains the response from method ExpressRoutePortsLocationsClient.Get.

type ExpressRoutePortsLocationsClientListOptions

type ExpressRoutePortsLocationsClientListOptions struct {
}

ExpressRoutePortsLocationsClientListOptions contains the optional parameters for the ExpressRoutePortsLocationsClient.List method.

type ExpressRoutePortsLocationsClientListResponse

type ExpressRoutePortsLocationsClientListResponse struct {
	ExpressRoutePortsLocationListResult
}

ExpressRoutePortsLocationsClientListResponse contains the response from method ExpressRoutePortsLocationsClient.List.

type ExpressRouteProviderPort

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

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

	// Properties of the express route Service Provider Port.
	Properties *ExpressRouteProviderPortProperties `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"`
}

ExpressRouteProviderPort resource.

func (ExpressRouteProviderPort) MarshalJSON

func (e ExpressRouteProviderPort) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteProviderPort.

func (*ExpressRouteProviderPort) UnmarshalJSON

func (e *ExpressRouteProviderPort) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteProviderPort.

type ExpressRouteProviderPortListResult

type ExpressRouteProviderPortListResult struct {
	// A list of ExpressRouteProviderPort resources.
	Value []*ExpressRouteProviderPort `json:"value,omitempty"`

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

ExpressRouteProviderPortListResult - Response for ListExpressRouteProviderPort API service call.

func (ExpressRouteProviderPortListResult) MarshalJSON

func (e ExpressRouteProviderPortListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteProviderPortListResult.

func (*ExpressRouteProviderPortListResult) UnmarshalJSON

func (e *ExpressRouteProviderPortListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteProviderPortListResult.

type ExpressRouteProviderPortProperties

type ExpressRouteProviderPortProperties struct {
	// Overprovisioning factor for the port pair.
	OverprovisionFactor *int32 `json:"overprovisionFactor,omitempty"`

	// The peering location of the port pair.
	PeeringLocation *string `json:"peeringLocation,omitempty"`

	// Bandwidth of the port in Mbps
	PortBandwidthInMbps *int32 `json:"portBandwidthInMbps,omitempty"`

	// Remaining Bandwidth of the port in Mbps
	RemainingBandwidthInMbps *int32 `json:"remainingBandwidthInMbps,omitempty"`

	// Used Bandwidth of the port in Mbps
	UsedBandwidthInMbps *int32 `json:"usedBandwidthInMbps,omitempty"`

	// READ-ONLY; The name of the port pair.
	PortPairDescriptor *string `json:"portPairDescriptor,omitempty" azure:"ro"`

	// READ-ONLY; The name of the primary port.
	PrimaryAzurePort *string `json:"primaryAzurePort,omitempty" azure:"ro"`

	// READ-ONLY; The name of the secondary port.
	SecondaryAzurePort *string `json:"secondaryAzurePort,omitempty" azure:"ro"`
}

ExpressRouteProviderPortProperties - Properties of ExpressRouteProviderPort.

func (ExpressRouteProviderPortProperties) MarshalJSON

func (e ExpressRouteProviderPortProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExpressRouteProviderPortProperties.

func (*ExpressRouteProviderPortProperties) UnmarshalJSON

func (e *ExpressRouteProviderPortProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteProviderPortProperties.

type ExpressRouteProviderPortsLocationClient

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

ExpressRouteProviderPortsLocationClient contains the methods for the ExpressRouteProviderPortsLocation group. Don't use this type directly, use NewExpressRouteProviderPortsLocationClient() instead.

func NewExpressRouteProviderPortsLocationClient

func NewExpressRouteProviderPortsLocationClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ExpressRouteProviderPortsLocationClient, error)

NewExpressRouteProviderPortsLocationClient creates a new instance of ExpressRouteProviderPortsLocationClient 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 (*ExpressRouteProviderPortsLocationClient) List

List - Retrieves all the ExpressRouteProviderPorts in a subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 options - ExpressRouteProviderPortsLocationClientListOptions contains the optional parameters for the ExpressRouteProviderPortsLocationClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/expressRouteProviderPortList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteProviderPortsLocationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx, &armnetwork.ExpressRouteProviderPortsLocationClientListOptions{Filter: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ExpressRouteProviderPortsLocationClientListOptions

type ExpressRouteProviderPortsLocationClientListOptions struct {
	// The filter to apply on the operation. For example, you can use $filter=location eq '{state}'.
	Filter *string
}

ExpressRouteProviderPortsLocationClientListOptions contains the optional parameters for the ExpressRouteProviderPortsLocationClient.List method.

type ExpressRouteProviderPortsLocationClientListResponse

type ExpressRouteProviderPortsLocationClientListResponse struct {
	ExpressRouteProviderPortListResult
}

ExpressRouteProviderPortsLocationClientListResponse contains the response from method ExpressRouteProviderPortsLocationClient.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.

func (*ExpressRouteServiceProvider) UnmarshalJSON

func (e *ExpressRouteServiceProvider) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ExpressRouteServiceProviderBandwidthsOffered) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ExpressRouteServiceProviderBandwidthsOffered.

func (*ExpressRouteServiceProviderBandwidthsOffered) UnmarshalJSON

func (e *ExpressRouteServiceProviderBandwidthsOffered) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExpressRouteServiceProviderBandwidthsOffered.

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.

func (*ExpressRouteServiceProviderListResult) UnmarshalJSON

func (e *ExpressRouteServiceProviderListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type ExpressRouteServiceProviderPropertiesFormat.

func (*ExpressRouteServiceProviderPropertiesFormat) UnmarshalJSON

func (e *ExpressRouteServiceProviderPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) NewListPager

NewListPager - Gets all the available express route service providers. Generated from API version 2022-05-01 options - ExpressRouteServiceProvidersClientListOptions contains the optional parameters for the ExpressRouteServiceProvidersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ExpressRouteProviderList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewExpressRouteServiceProvidersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ExpressRouteServiceProvidersClientListOptions

type ExpressRouteServiceProvidersClientListOptions struct {
}

ExpressRouteServiceProvidersClientListOptions contains the optional parameters for the ExpressRouteServiceProvidersClient.List method.

type ExpressRouteServiceProvidersClientListResponse

type ExpressRouteServiceProvidersClientListResponse struct {
	ExpressRouteServiceProviderListResult
}

ExpressRouteServiceProvidersClientListResponse contains the response 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.

func (ExtendedLocation) MarshalJSON

func (e ExtendedLocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtendedLocation.

func (*ExtendedLocation) UnmarshalJSON

func (e *ExtendedLocation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExtendedLocation.

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.

type FilterItems

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

func (f FilterItems) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FilterItems.

func (*FilterItems) UnmarshalJSON

func (f *FilterItems) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[FirewallPoliciesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates the specified Firewall Policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "firewallPolicy", armnetwork.FirewallPolicy{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.FirewallPolicyPropertiesFormat{
		DNSSettings: &armnetwork.DNSSettings{
			EnableProxy:                 to.Ptr(true),
			RequireProxyForNetworkRules: to.Ptr(false),
			Servers: []*string{
				to.Ptr("30.3.4.5")},
		},
		Insights: &armnetwork.FirewallPolicyInsights{
			IsEnabled: to.Ptr(true),
			LogAnalyticsResources: &armnetwork.FirewallPolicyLogAnalyticsResources{
				DefaultWorkspaceID: &armnetwork.SubResource{
					ID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace"),
				},
				Workspaces: []*armnetwork.FirewallPolicyLogAnalyticsWorkspace{
					{
						Region: to.Ptr("westus"),
						WorkspaceID: &armnetwork.SubResource{
							ID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1"),
						},
					},
					{
						Region: to.Ptr("eastus"),
						WorkspaceID: &armnetwork.SubResource{
							ID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2"),
						},
					}},
			},
			RetentionDays: to.Ptr[int32](100),
		},
		IntrusionDetection: &armnetwork.FirewallPolicyIntrusionDetection{
			Configuration: &armnetwork.FirewallPolicyIntrusionDetectionConfiguration{
				BypassTrafficSettings: []*armnetwork.FirewallPolicyIntrusionDetectionBypassTrafficSpecifications{
					{
						Name:        to.Ptr("bypassRule1"),
						Description: to.Ptr("Rule 1"),
						DestinationAddresses: []*string{
							to.Ptr("5.6.7.8")},
						DestinationPorts: []*string{
							to.Ptr("*")},
						SourceAddresses: []*string{
							to.Ptr("1.2.3.4")},
						Protocol: to.Ptr(armnetwork.FirewallPolicyIntrusionDetectionProtocolTCP),
					}},
				SignatureOverrides: []*armnetwork.FirewallPolicyIntrusionDetectionSignatureSpecification{
					{
						ID:   to.Ptr("2525004"),
						Mode: to.Ptr(armnetwork.FirewallPolicyIntrusionDetectionStateTypeDeny),
					}},
			},
			Mode: to.Ptr(armnetwork.FirewallPolicyIntrusionDetectionStateTypeAlert),
		},
		SKU: &armnetwork.FirewallPolicySKU{
			Tier: to.Ptr(armnetwork.FirewallPolicySKUTierPremium),
		},
		Snat: &armnetwork.FirewallPolicySNAT{
			PrivateRanges: []*string{
				to.Ptr("IANAPrivateRanges")},
		},
		SQL: &armnetwork.FirewallPolicySQL{
			AllowSQLRedirect: to.Ptr(true),
		},
		ThreatIntelMode: to.Ptr(armnetwork.AzureFirewallThreatIntelModeAlert),
		ThreatIntelWhitelist: &armnetwork.FirewallPolicyThreatIntelWhitelist{
			Fqdns: []*string{
				to.Ptr("*.microsoft.com")},
			IPAddresses: []*string{
				to.Ptr("20.3.4.5")},
		},
		TransportSecurity: &armnetwork.FirewallPolicyTransportSecurity{
			CertificateAuthority: &armnetwork.FirewallPolicyCertificateAuthority{
				Name:             to.Ptr("clientcert"),
				KeyVaultSecretID: to.Ptr("https://kv/secret"),
			},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*FirewallPoliciesClient) BeginDelete

func (client *FirewallPoliciesClient) BeginDelete(ctx context.Context, resourceGroupName string, firewallPolicyName string, options *FirewallPoliciesClientBeginDeleteOptions) (*runtime.Poller[FirewallPoliciesClientDeleteResponse], error)

BeginDelete - Deletes the specified Firewall Policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "firewallPolicy", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "firewallPolicy", &armnetwork.FirewallPoliciesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*FirewallPoliciesClient) NewListAllPager

NewListAllPager - Gets all the Firewall Policies in a subscription. Generated from API version 2022-05-01 options - FirewallPoliciesClientListAllOptions contains the optional parameters for the FirewallPoliciesClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*FirewallPoliciesClient) NewListPager

NewListPager - Lists all Firewall Policies in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - FirewallPoliciesClientListOptions contains the optional parameters for the FirewallPoliciesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*FirewallPoliciesClient) UpdateTags

func (client *FirewallPoliciesClient) UpdateTags(ctx context.Context, resourceGroupName string, firewallPolicyName string, parameters TagsObject, options *FirewallPoliciesClientUpdateTagsOptions) (FirewallPoliciesClientUpdateTagsResponse, error)

UpdateTags - Updates tags of a Azure Firewall Policy resource. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. firewallPolicyName - The name of the Firewall Policy. parameters - Parameters supplied to update Azure Firewall Policy tags. options - FirewallPoliciesClientUpdateTagsOptions contains the optional parameters for the FirewallPoliciesClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyPatch.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPoliciesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "myResourceGroup", "firewallPolicy", armnetwork.TagsObject{
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
		"key2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type FirewallPoliciesClientBeginCreateOrUpdateOptions

type FirewallPoliciesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

FirewallPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the FirewallPoliciesClient.BeginCreateOrUpdate method.

type FirewallPoliciesClientBeginDeleteOptions

type FirewallPoliciesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

FirewallPoliciesClientBeginDeleteOptions contains the optional parameters for the FirewallPoliciesClient.BeginDelete method.

type FirewallPoliciesClientCreateOrUpdateResponse

type FirewallPoliciesClientCreateOrUpdateResponse struct {
	FirewallPolicy
}

FirewallPoliciesClientCreateOrUpdateResponse contains the response from method FirewallPoliciesClient.CreateOrUpdate.

type FirewallPoliciesClientDeleteResponse

type FirewallPoliciesClientDeleteResponse struct {
}

FirewallPoliciesClientDeleteResponse contains the response from method FirewallPoliciesClient.Delete.

type FirewallPoliciesClientGetOptions

type FirewallPoliciesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

FirewallPoliciesClientGetOptions contains the optional parameters for the FirewallPoliciesClient.Get method.

type FirewallPoliciesClientGetResponse

type FirewallPoliciesClientGetResponse struct {
	FirewallPolicy
}

FirewallPoliciesClientGetResponse contains the response from method FirewallPoliciesClient.Get.

type FirewallPoliciesClientListAllOptions

type FirewallPoliciesClientListAllOptions struct {
}

FirewallPoliciesClientListAllOptions contains the optional parameters for the FirewallPoliciesClient.ListAll method.

type FirewallPoliciesClientListAllResponse

type FirewallPoliciesClientListAllResponse struct {
	FirewallPolicyListResult
}

FirewallPoliciesClientListAllResponse contains the response from method FirewallPoliciesClient.ListAll.

type FirewallPoliciesClientListOptions

type FirewallPoliciesClientListOptions struct {
}

FirewallPoliciesClientListOptions contains the optional parameters for the FirewallPoliciesClient.List method.

type FirewallPoliciesClientListResponse

type FirewallPoliciesClientListResponse struct {
	FirewallPolicyListResult
}

FirewallPoliciesClientListResponse contains the response from method FirewallPoliciesClient.List.

type FirewallPoliciesClientUpdateTagsOptions

type FirewallPoliciesClientUpdateTagsOptions struct {
}

FirewallPoliciesClientUpdateTagsOptions contains the optional parameters for the FirewallPoliciesClient.UpdateTags method.

type FirewallPoliciesClientUpdateTagsResponse

type FirewallPoliciesClientUpdateTagsResponse struct {
	FirewallPolicy
}

FirewallPoliciesClientUpdateTagsResponse contains the response from method FirewallPoliciesClient.UpdateTags.

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.

func (*FirewallPolicy) UnmarshalJSON

func (f *FirewallPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (FirewallPolicyCertificateAuthority) MarshalJSON

func (f FirewallPolicyCertificateAuthority) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyCertificateAuthority.

func (*FirewallPolicyCertificateAuthority) UnmarshalJSON

func (f *FirewallPolicyCertificateAuthority) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyCertificateAuthority.

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

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.

func (FirewallPolicyFilterRuleCollectionAction) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyFilterRuleCollectionAction.

func (*FirewallPolicyFilterRuleCollectionAction) UnmarshalJSON

func (f *FirewallPolicyFilterRuleCollectionAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type 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.

type FirewallPolicyIDPSQuerySortOrder

type FirewallPolicyIDPSQuerySortOrder string

FirewallPolicyIDPSQuerySortOrder - Describes if results should be in ascending/descending order

const (
	FirewallPolicyIDPSQuerySortOrderAscending  FirewallPolicyIDPSQuerySortOrder = "Ascending"
	FirewallPolicyIDPSQuerySortOrderDescending FirewallPolicyIDPSQuerySortOrder = "Descending"
)

func PossibleFirewallPolicyIDPSQuerySortOrderValues

func PossibleFirewallPolicyIDPSQuerySortOrderValues() []FirewallPolicyIDPSQuerySortOrder

PossibleFirewallPolicyIDPSQuerySortOrderValues returns the possible values for the FirewallPolicyIDPSQuerySortOrder const type.

type FirewallPolicyIDPSSignatureDirection

type FirewallPolicyIDPSSignatureDirection int32

FirewallPolicyIDPSSignatureDirection - Describes in which direction signature is being enforced: 0 - Inbound, 1 - OutBound, 2 - Bidirectional

const (
	FirewallPolicyIDPSSignatureDirectionZero FirewallPolicyIDPSSignatureDirection = 0
	FirewallPolicyIDPSSignatureDirectionOne  FirewallPolicyIDPSSignatureDirection = 1
	FirewallPolicyIDPSSignatureDirectionTwo  FirewallPolicyIDPSSignatureDirection = 2
)

func PossibleFirewallPolicyIDPSSignatureDirectionValues

func PossibleFirewallPolicyIDPSSignatureDirectionValues() []FirewallPolicyIDPSSignatureDirection

PossibleFirewallPolicyIDPSSignatureDirectionValues returns the possible values for the FirewallPolicyIDPSSignatureDirection const type.

type FirewallPolicyIDPSSignatureMode

type FirewallPolicyIDPSSignatureMode int32

FirewallPolicyIDPSSignatureMode - The current mode enforced, 0 - Disabled, 1 - Alert, 2 -Deny

const (
	FirewallPolicyIDPSSignatureModeZero FirewallPolicyIDPSSignatureMode = 0
	FirewallPolicyIDPSSignatureModeOne  FirewallPolicyIDPSSignatureMode = 1
	FirewallPolicyIDPSSignatureModeTwo  FirewallPolicyIDPSSignatureMode = 2
)

func PossibleFirewallPolicyIDPSSignatureModeValues

func PossibleFirewallPolicyIDPSSignatureModeValues() []FirewallPolicyIDPSSignatureMode

PossibleFirewallPolicyIDPSSignatureModeValues returns the possible values for the FirewallPolicyIDPSSignatureMode const type.

type FirewallPolicyIDPSSignatureSeverity

type FirewallPolicyIDPSSignatureSeverity int32

FirewallPolicyIDPSSignatureSeverity - Describes the severity of signature: 1 - Low, 2 - Medium, 3 - High

const (
	FirewallPolicyIDPSSignatureSeverityOne   FirewallPolicyIDPSSignatureSeverity = 1
	FirewallPolicyIDPSSignatureSeverityTwo   FirewallPolicyIDPSSignatureSeverity = 2
	FirewallPolicyIDPSSignatureSeverityThree FirewallPolicyIDPSSignatureSeverity = 3
)

func PossibleFirewallPolicyIDPSSignatureSeverityValues

func PossibleFirewallPolicyIDPSSignatureSeverityValues() []FirewallPolicyIDPSSignatureSeverity

PossibleFirewallPolicyIDPSSignatureSeverityValues returns the possible values for the FirewallPolicyIDPSSignatureSeverity const type.

type FirewallPolicyIdpsSignaturesClient

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

func NewFirewallPolicyIdpsSignaturesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*FirewallPolicyIdpsSignaturesClient, error)

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

List - Retrieves the current status of IDPS signatures for the relevant policy If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyQuerySignatureOverrides.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyIdpsSignaturesClient("e747cc13-97d4-4a79-b463-42d7f4e558f2", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx, "rg1", "firewallPolicy", armnetwork.IDPSQueryObject{
	Filters: []*armnetwork.FilterItems{
		{
			Field: to.Ptr("Mode"),
			Values: []*string{
				to.Ptr("Deny")},
		}},
	OrderBy: &armnetwork.OrderBy{
		Field: to.Ptr("severity"),
		Order: to.Ptr(armnetwork.FirewallPolicyIDPSQuerySortOrderAscending),
	},
	ResultsPerPage: to.Ptr[int32](20),
	Search:         to.Ptr(""),
	Skip:           to.Ptr[int32](0),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type FirewallPolicyIdpsSignaturesClientListOptions

type FirewallPolicyIdpsSignaturesClientListOptions struct {
}

FirewallPolicyIdpsSignaturesClientListOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesClient.List method.

type FirewallPolicyIdpsSignaturesClientListResponse

type FirewallPolicyIdpsSignaturesClientListResponse struct {
	QueryResults
}

FirewallPolicyIdpsSignaturesClientListResponse contains the response from method FirewallPolicyIdpsSignaturesClient.List.

type FirewallPolicyIdpsSignaturesFilterValuesClient

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

func NewFirewallPolicyIdpsSignaturesFilterValuesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*FirewallPolicyIdpsSignaturesFilterValuesClient, error)

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

List - Retrieves the current filter values for the signatures overrides If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyQuerySignatureOverridesFilterValues.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyIdpsSignaturesFilterValuesClient("e747cc13-97d4-4a79-b463-42d7f4e558f2", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx, "rg1", "firewallPolicy", armnetwork.SignatureOverridesFilterValuesQuery{
	FilterName: to.Ptr("severity"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type FirewallPolicyIdpsSignaturesFilterValuesClientListOptions

type FirewallPolicyIdpsSignaturesFilterValuesClientListOptions struct {
}

FirewallPolicyIdpsSignaturesFilterValuesClientListOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesFilterValuesClient.List method.

type FirewallPolicyIdpsSignaturesFilterValuesClientListResponse

type FirewallPolicyIdpsSignaturesFilterValuesClientListResponse struct {
	SignatureOverridesFilterValuesResponse
}

FirewallPolicyIdpsSignaturesFilterValuesClientListResponse contains the response from method FirewallPolicyIdpsSignaturesFilterValuesClient.List.

type FirewallPolicyIdpsSignaturesOverridesClient

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

func NewFirewallPolicyIdpsSignaturesOverridesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*FirewallPolicyIdpsSignaturesOverridesClient, error)

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

Get - Returns all signatures overrides for a specific policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicySignatureOverridesGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyIdpsSignaturesOverridesClient("e747cc13-97d4-4a79-b463-42d7f4e558f2", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "firewallPolicy", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*FirewallPolicyIdpsSignaturesOverridesClient) List

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicySignatureOverridesList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyIdpsSignaturesOverridesClient("e747cc13-97d4-4a79-b463-42d7f4e558f2", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx, "rg1", "firewallPolicy", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*FirewallPolicyIdpsSignaturesOverridesClient) Patch

Patch - Will update the status of policy's signature overrides for IDPS If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicySignatureOverridesPatch.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyIdpsSignaturesOverridesClient("e747cc13-97d4-4a79-b463-42d7f4e558f2", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Patch(ctx, "rg1", "firewallPolicy", armnetwork.SignaturesOverrides{
	Name: to.Ptr("default"),
	Type: to.Ptr("Microsoft.Network/firewallPolicies/signatureOverrides"),
	ID:   to.Ptr("/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default"),
	Properties: &armnetwork.SignaturesOverridesProperties{
		Signatures: map[string]*string{
			"2000105": to.Ptr("Off"),
			"2000106": to.Ptr("Deny"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*FirewallPolicyIdpsSignaturesOverridesClient) Put

Put - Will override/create a new signature overrides for the policy's IDPS If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicySignatureOverridesPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyIdpsSignaturesOverridesClient("e747cc13-97d4-4a79-b463-42d7f4e558f2", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Put(ctx, "rg1", "firewallPolicy", armnetwork.SignaturesOverrides{
	Name: to.Ptr("default"),
	Type: to.Ptr("Microsoft.Network/firewallPolicies/signatureOverrides"),
	ID:   to.Ptr("/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default"),
	Properties: &armnetwork.SignaturesOverridesProperties{
		Signatures: map[string]*string{
			"2000105": to.Ptr("Off"),
			"2000106": to.Ptr("Deny"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type FirewallPolicyIdpsSignaturesOverridesClientGetOptions

type FirewallPolicyIdpsSignaturesOverridesClientGetOptions struct {
}

FirewallPolicyIdpsSignaturesOverridesClientGetOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.Get method.

type FirewallPolicyIdpsSignaturesOverridesClientGetResponse

type FirewallPolicyIdpsSignaturesOverridesClientGetResponse struct {
	SignaturesOverrides
}

FirewallPolicyIdpsSignaturesOverridesClientGetResponse contains the response from method FirewallPolicyIdpsSignaturesOverridesClient.Get.

type FirewallPolicyIdpsSignaturesOverridesClientListOptions

type FirewallPolicyIdpsSignaturesOverridesClientListOptions struct {
}

FirewallPolicyIdpsSignaturesOverridesClientListOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.List method.

type FirewallPolicyIdpsSignaturesOverridesClientListResponse

type FirewallPolicyIdpsSignaturesOverridesClientListResponse struct {
	SignaturesOverridesList
}

FirewallPolicyIdpsSignaturesOverridesClientListResponse contains the response from method FirewallPolicyIdpsSignaturesOverridesClient.List.

type FirewallPolicyIdpsSignaturesOverridesClientPatchOptions

type FirewallPolicyIdpsSignaturesOverridesClientPatchOptions struct {
}

FirewallPolicyIdpsSignaturesOverridesClientPatchOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.Patch method.

type FirewallPolicyIdpsSignaturesOverridesClientPatchResponse

type FirewallPolicyIdpsSignaturesOverridesClientPatchResponse struct {
	SignaturesOverrides
}

FirewallPolicyIdpsSignaturesOverridesClientPatchResponse contains the response from method FirewallPolicyIdpsSignaturesOverridesClient.Patch.

type FirewallPolicyIdpsSignaturesOverridesClientPutOptions

type FirewallPolicyIdpsSignaturesOverridesClientPutOptions struct {
}

FirewallPolicyIdpsSignaturesOverridesClientPutOptions contains the optional parameters for the FirewallPolicyIdpsSignaturesOverridesClient.Put method.

type FirewallPolicyIdpsSignaturesOverridesClientPutResponse

type FirewallPolicyIdpsSignaturesOverridesClientPutResponse struct {
	SignaturesOverrides
}

FirewallPolicyIdpsSignaturesOverridesClientPutResponse contains the response 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.

func (FirewallPolicyInsights) MarshalJSON

func (f FirewallPolicyInsights) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyInsights.

func (*FirewallPolicyInsights) UnmarshalJSON

func (f *FirewallPolicyInsights) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyInsights.

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.

func (FirewallPolicyIntrusionDetection) MarshalJSON

func (f FirewallPolicyIntrusionDetection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyIntrusionDetection.

func (*FirewallPolicyIntrusionDetection) UnmarshalJSON

func (f *FirewallPolicyIntrusionDetection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyIntrusionDetection.

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

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyIntrusionDetectionBypassTrafficSpecifications.

func (*FirewallPolicyIntrusionDetectionBypassTrafficSpecifications) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyIntrusionDetectionBypassTrafficSpecifications.

type FirewallPolicyIntrusionDetectionConfiguration

type FirewallPolicyIntrusionDetectionConfiguration struct {
	// List of rules for traffic to bypass.
	BypassTrafficSettings []*FirewallPolicyIntrusionDetectionBypassTrafficSpecifications `json:"bypassTrafficSettings,omitempty"`

	// IDPS Private IP address ranges are used to identify traffic direction (i.e. inbound, outbound, etc.). By default, only
	// ranges defined by IANA RFC 1918 are considered private IP addresses. To modify
	// default ranges, specify your Private IP address ranges with this property
	PrivateRanges []*string `json:"privateRanges,omitempty"`

	// List of specific signatures states.
	SignatureOverrides []*FirewallPolicyIntrusionDetectionSignatureSpecification `json:"signatureOverrides,omitempty"`
}

FirewallPolicyIntrusionDetectionConfiguration - The operation for configuring intrusion detection.

func (FirewallPolicyIntrusionDetectionConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyIntrusionDetectionConfiguration.

func (*FirewallPolicyIntrusionDetectionConfiguration) UnmarshalJSON

func (f *FirewallPolicyIntrusionDetectionConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (FirewallPolicyIntrusionDetectionSignatureSpecification) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyIntrusionDetectionSignatureSpecification.

func (*FirewallPolicyIntrusionDetectionSignatureSpecification) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyIntrusionDetectionSignatureSpecification.

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.

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.

func (*FirewallPolicyListResult) UnmarshalJSON

func (f *FirewallPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*FirewallPolicyLogAnalyticsResources) UnmarshalJSON

func (f *FirewallPolicyLogAnalyticsResources) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (FirewallPolicyLogAnalyticsWorkspace) MarshalJSON

func (f FirewallPolicyLogAnalyticsWorkspace) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyLogAnalyticsWorkspace.

func (*FirewallPolicyLogAnalyticsWorkspace) UnmarshalJSON

func (f *FirewallPolicyLogAnalyticsWorkspace) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyLogAnalyticsWorkspace.

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

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.

func (FirewallPolicyNatRuleCollectionAction) MarshalJSON

func (f FirewallPolicyNatRuleCollectionAction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyNatRuleCollectionAction.

func (*FirewallPolicyNatRuleCollectionAction) UnmarshalJSON

func (f *FirewallPolicyNatRuleCollectionAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type 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.

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.

func (*FirewallPolicyPropertiesFormat) UnmarshalJSON

func (f *FirewallPolicyPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (FirewallPolicyRule) MarshalJSON

func (f FirewallPolicyRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyRule.

func (*FirewallPolicyRule) UnmarshalJSON

func (f *FirewallPolicyRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (FirewallPolicyRuleApplicationProtocol) MarshalJSON

func (f FirewallPolicyRuleApplicationProtocol) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyRuleApplicationProtocol.

func (*FirewallPolicyRuleApplicationProtocol) UnmarshalJSON

func (f *FirewallPolicyRuleApplicationProtocol) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyRuleApplicationProtocol.

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.

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.

func (FirewallPolicyRuleCollection) MarshalJSON

func (f FirewallPolicyRuleCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyRuleCollection.

func (*FirewallPolicyRuleCollection) UnmarshalJSON

func (f *FirewallPolicyRuleCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (FirewallPolicyRuleCollectionGroup) MarshalJSON

func (f FirewallPolicyRuleCollectionGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyRuleCollectionGroup.

func (*FirewallPolicyRuleCollectionGroup) UnmarshalJSON

func (f *FirewallPolicyRuleCollectionGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyRuleCollectionGroup.

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

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyRuleCollectionGroupListResult.

func (*FirewallPolicyRuleCollectionGroupListResult) UnmarshalJSON

func (f *FirewallPolicyRuleCollectionGroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

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, error)

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

BeginCreateOrUpdate - Creates or updates the specified FirewallPolicyRuleCollectionGroup. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateFirewallPolicyNatRuleCollectionGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyNatRuleCollectionGroupPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "firewallPolicy", "ruleCollectionGroup1", armnetwork.FirewallPolicyRuleCollectionGroup{
	Properties: &armnetwork.FirewallPolicyRuleCollectionGroupProperties{
		Priority: to.Ptr[int32](100),
		RuleCollections: []armnetwork.FirewallPolicyRuleCollectionClassification{
			&armnetwork.FirewallPolicyNatRuleCollection{
				Name:               to.Ptr("Example-Nat-Rule-Collection"),
				Priority:           to.Ptr[int32](100),
				RuleCollectionType: to.Ptr(armnetwork.FirewallPolicyRuleCollectionTypeFirewallPolicyNatRuleCollection),
				Action: &armnetwork.FirewallPolicyNatRuleCollectionAction{
					Type: to.Ptr(armnetwork.FirewallPolicyNatRuleCollectionActionTypeDNAT),
				},
				Rules: []armnetwork.FirewallPolicyRuleClassification{
					&armnetwork.NatRule{
						Name:     to.Ptr("nat-rule1"),
						RuleType: to.Ptr(armnetwork.FirewallPolicyRuleTypeNatRule),
						DestinationAddresses: []*string{
							to.Ptr("152.23.32.23")},
						DestinationPorts: []*string{
							to.Ptr("8080")},
						IPProtocols: []*armnetwork.FirewallPolicyRuleNetworkProtocol{
							to.Ptr(armnetwork.FirewallPolicyRuleNetworkProtocolTCP),
							to.Ptr(armnetwork.FirewallPolicyRuleNetworkProtocolUDP)},
						SourceAddresses: []*string{
							to.Ptr("2.2.2.2")},
						SourceIPGroups: []*string{},
						TranslatedFqdn: to.Ptr("internalhttp.server.net"),
						TranslatedPort: to.Ptr("8080"),
					}},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateFirewallPolicyRuleCollectionGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyRuleCollectionGroupPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "firewallPolicy", "ruleCollectionGroup1", armnetwork.FirewallPolicyRuleCollectionGroup{
	Properties: &armnetwork.FirewallPolicyRuleCollectionGroupProperties{
		Priority: to.Ptr[int32](100),
		RuleCollections: []armnetwork.FirewallPolicyRuleCollectionClassification{
			&armnetwork.FirewallPolicyFilterRuleCollection{
				Name:               to.Ptr("Example-Filter-Rule-Collection"),
				Priority:           to.Ptr[int32](100),
				RuleCollectionType: to.Ptr(armnetwork.FirewallPolicyRuleCollectionTypeFirewallPolicyFilterRuleCollection),
				Action: &armnetwork.FirewallPolicyFilterRuleCollectionAction{
					Type: to.Ptr(armnetwork.FirewallPolicyFilterRuleCollectionActionTypeDeny),
				},
				Rules: []armnetwork.FirewallPolicyRuleClassification{
					&armnetwork.Rule{
						Name:     to.Ptr("network-rule1"),
						RuleType: to.Ptr(armnetwork.FirewallPolicyRuleTypeNetworkRule),
						DestinationAddresses: []*string{
							to.Ptr("*")},
						DestinationPorts: []*string{
							to.Ptr("*")},
						IPProtocols: []*armnetwork.FirewallPolicyRuleNetworkProtocol{
							to.Ptr(armnetwork.FirewallPolicyRuleNetworkProtocolTCP)},
						SourceAddresses: []*string{
							to.Ptr("10.1.25.0/24")},
					}},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateFirewallPolicyRuleCollectionGroupWithIpGroups)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "firewallPolicy", "ruleCollectionGroup1", armnetwork.FirewallPolicyRuleCollectionGroup{
	Properties: &armnetwork.FirewallPolicyRuleCollectionGroupProperties{
		Priority: to.Ptr[int32](110),
		RuleCollections: []armnetwork.FirewallPolicyRuleCollectionClassification{
			&armnetwork.FirewallPolicyFilterRuleCollection{
				Name:               to.Ptr("Example-Filter-Rule-Collection"),
				RuleCollectionType: to.Ptr(armnetwork.FirewallPolicyRuleCollectionTypeFirewallPolicyFilterRuleCollection),
				Action: &armnetwork.FirewallPolicyFilterRuleCollectionAction{
					Type: to.Ptr(armnetwork.FirewallPolicyFilterRuleCollectionActionTypeDeny),
				},
				Rules: []armnetwork.FirewallPolicyRuleClassification{
					&armnetwork.Rule{
						Name:     to.Ptr("network-1"),
						RuleType: to.Ptr(armnetwork.FirewallPolicyRuleTypeNetworkRule),
						DestinationIPGroups: []*string{
							to.Ptr("/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2")},
						DestinationPorts: []*string{
							to.Ptr("*")},
						IPProtocols: []*armnetwork.FirewallPolicyRuleNetworkProtocol{
							to.Ptr(armnetwork.FirewallPolicyRuleNetworkProtocolTCP)},
						SourceIPGroups: []*string{
							to.Ptr("/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1")},
					}},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateFirewallPolicyRuleCollectionGroupWithWebCategories)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("e747cc13-97d4-4a79-b463-42d7f4e558f2", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "firewallPolicy", "ruleCollectionGroup1", armnetwork.FirewallPolicyRuleCollectionGroup{
	Properties: &armnetwork.FirewallPolicyRuleCollectionGroupProperties{
		Priority: to.Ptr[int32](110),
		RuleCollections: []armnetwork.FirewallPolicyRuleCollectionClassification{
			&armnetwork.FirewallPolicyFilterRuleCollection{
				Name:               to.Ptr("Example-Filter-Rule-Collection"),
				RuleCollectionType: to.Ptr(armnetwork.FirewallPolicyRuleCollectionTypeFirewallPolicyFilterRuleCollection),
				Action: &armnetwork.FirewallPolicyFilterRuleCollectionAction{
					Type: to.Ptr(armnetwork.FirewallPolicyFilterRuleCollectionActionTypeDeny),
				},
				Rules: []armnetwork.FirewallPolicyRuleClassification{
					&armnetwork.ApplicationRule{
						Name:        to.Ptr("rule1"),
						Description: to.Ptr("Deny inbound rule"),
						RuleType:    to.Ptr(armnetwork.FirewallPolicyRuleTypeApplicationRule),
						Protocols: []*armnetwork.FirewallPolicyRuleApplicationProtocol{
							{
								Port:         to.Ptr[int32](443),
								ProtocolType: to.Ptr(armnetwork.FirewallPolicyRuleApplicationProtocolTypeHTTPS),
							}},
						SourceAddresses: []*string{
							to.Ptr("216.58.216.164"),
							to.Ptr("10.0.0.0/24")},
						WebCategories: []*string{
							to.Ptr("Hacking")},
					}},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*FirewallPolicyRuleCollectionGroupsClient) BeginDelete

BeginDelete - Deletes the specified FirewallPolicyRuleCollectionGroup. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyRuleCollectionGroupDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "firewallPolicy", "ruleCollectionGroup1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*FirewallPolicyRuleCollectionGroupsClient) Get

Get - Gets the specified FirewallPolicyRuleCollectionGroup. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (GetFirewallPolicyNatRuleCollectionGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyNatRuleCollectionGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "firewallPolicy", "ruleCollectionGroup1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetFirewallPolicyRuleCollectionGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyRuleCollectionGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "firewallPolicy", "ruleCollectionGroup1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetFirewallPolicyRuleCollectionGroupWithIpGroups)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "firewallPolicy", "ruleGroup1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetFirewallPolicyRuleCollectionGroupWithWebCategories)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("e747cc13-97d4-4a79-b463-42d7f4e558f2", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "firewallPolicy", "ruleCollectionGroup1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*FirewallPolicyRuleCollectionGroupsClient) NewListPager

NewListPager - Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource. Generated from API version 2022-05-01 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 (ListAllFirewallPolicyRuleCollectionGroupWithWebCategories)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("e747cc13-97d4-4a79-b463-42d7f4e558f2", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "firewallPolicy", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

Example (ListAllFirewallPolicyRuleCollectionGroupsForAGivenFirewallPolicy)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyRuleCollectionGroupList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "firewallPolicy", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

Example (ListAllFirewallPolicyRuleCollectionGroupsWithIpGroupsForAGivenFirewallPolicy)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFirewallPolicyRuleCollectionGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "firewallPolicy", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type FirewallPolicyRuleCollectionGroupsClientBeginCreateOrUpdateOptions

type FirewallPolicyRuleCollectionGroupsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

FirewallPolicyRuleCollectionGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.BeginCreateOrUpdate method.

type FirewallPolicyRuleCollectionGroupsClientBeginDeleteOptions

type FirewallPolicyRuleCollectionGroupsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

FirewallPolicyRuleCollectionGroupsClientBeginDeleteOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.BeginDelete method.

type FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResponse

type FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResponse struct {
	FirewallPolicyRuleCollectionGroup
}

FirewallPolicyRuleCollectionGroupsClientCreateOrUpdateResponse contains the response from method FirewallPolicyRuleCollectionGroupsClient.CreateOrUpdate.

type FirewallPolicyRuleCollectionGroupsClientDeleteResponse

type FirewallPolicyRuleCollectionGroupsClientDeleteResponse struct {
}

FirewallPolicyRuleCollectionGroupsClientDeleteResponse contains the response from method FirewallPolicyRuleCollectionGroupsClient.Delete.

type FirewallPolicyRuleCollectionGroupsClientGetOptions

type FirewallPolicyRuleCollectionGroupsClientGetOptions struct {
}

FirewallPolicyRuleCollectionGroupsClientGetOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.Get method.

type FirewallPolicyRuleCollectionGroupsClientGetResponse

type FirewallPolicyRuleCollectionGroupsClientGetResponse struct {
	FirewallPolicyRuleCollectionGroup
}

FirewallPolicyRuleCollectionGroupsClientGetResponse contains the response from method FirewallPolicyRuleCollectionGroupsClient.Get.

type FirewallPolicyRuleCollectionGroupsClientListOptions

type FirewallPolicyRuleCollectionGroupsClientListOptions struct {
}

FirewallPolicyRuleCollectionGroupsClientListOptions contains the optional parameters for the FirewallPolicyRuleCollectionGroupsClient.List method.

type FirewallPolicyRuleCollectionGroupsClientListResponse

type FirewallPolicyRuleCollectionGroupsClientListResponse struct {
	FirewallPolicyRuleCollectionGroupListResult
}

FirewallPolicyRuleCollectionGroupsClientListResponse contains the response 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.

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.

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.

type FirewallPolicySKU

type FirewallPolicySKU struct {
	// Tier of Firewall Policy.
	Tier *FirewallPolicySKUTier `json:"tier,omitempty"`
}

FirewallPolicySKU - SKU of Firewall policy.

func (FirewallPolicySKU) MarshalJSON

func (f FirewallPolicySKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicySKU.

func (*FirewallPolicySKU) UnmarshalJSON

func (f *FirewallPolicySKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicySKU.

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.

type FirewallPolicySNAT

type FirewallPolicySNAT struct {
	// The operation mode for automatically learning private ranges to not be SNAT
	AutoLearnPrivateRanges *AutoLearnPrivateRangesMode `json:"autoLearnPrivateRanges,omitempty"`

	// 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.

func (*FirewallPolicySNAT) UnmarshalJSON

func (f *FirewallPolicySNAT) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (FirewallPolicySQL) MarshalJSON

func (f FirewallPolicySQL) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicySQL.

func (*FirewallPolicySQL) UnmarshalJSON

func (f *FirewallPolicySQL) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicySQL.

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.

func (*FirewallPolicyThreatIntelWhitelist) UnmarshalJSON

func (f *FirewallPolicyThreatIntelWhitelist) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (FirewallPolicyTransportSecurity) MarshalJSON

func (f FirewallPolicyTransportSecurity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FirewallPolicyTransportSecurity.

func (*FirewallPolicyTransportSecurity) UnmarshalJSON

func (f *FirewallPolicyTransportSecurity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FirewallPolicyTransportSecurity.

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.

func (*FlowLog) UnmarshalJSON

func (f *FlowLog) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (FlowLogFormatParameters) MarshalJSON

func (f FlowLogFormatParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FlowLogFormatParameters.

func (*FlowLogFormatParameters) UnmarshalJSON

func (f *FlowLogFormatParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FlowLogFormatParameters.

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.

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) .

func (FlowLogInformation) MarshalJSON

func (f FlowLogInformation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FlowLogInformation.

func (*FlowLogInformation) UnmarshalJSON

func (f *FlowLogInformation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FlowLogInformation.

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.

func (*FlowLogListResult) UnmarshalJSON

func (f *FlowLogListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (FlowLogProperties) MarshalJSON

func (f FlowLogProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FlowLogProperties.

func (*FlowLogProperties) UnmarshalJSON

func (f *FlowLogProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FlowLogProperties.

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.

func (FlowLogPropertiesFormat) MarshalJSON

func (f FlowLogPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FlowLogPropertiesFormat.

func (*FlowLogPropertiesFormat) UnmarshalJSON

func (f *FlowLogPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FlowLogPropertiesFormat.

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.

func (FlowLogStatusParameters) MarshalJSON

func (f FlowLogStatusParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FlowLogStatusParameters.

func (*FlowLogStatusParameters) UnmarshalJSON

func (f *FlowLogStatusParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FlowLogStatusParameters.

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, error)

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) (*runtime.Poller[FlowLogsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a flow log for the specified network security group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherFlowLogCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFlowLogsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "nw1", "fl", armnetwork.FlowLog{
	Location: to.Ptr("centraluseuap"),
	Properties: &armnetwork.FlowLogPropertiesFormat{
		Format: &armnetwork.FlowLogFormatParameters{
			Type:    to.Ptr(armnetwork.FlowLogFormatTypeJSON),
			Version: to.Ptr[int32](1),
		},
		Enabled:          to.Ptr(true),
		StorageID:        to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe"),
		TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*FlowLogsClient) BeginDelete

func (client *FlowLogsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkWatcherName string, flowLogName string, options *FlowLogsClientBeginDeleteOptions) (*runtime.Poller[FlowLogsClientDeleteResponse], error)

BeginDelete - Deletes the specified flow log resource. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherFlowLogDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFlowLogsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "nw1", "fl", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherFlowLogGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFlowLogsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "nw1", "flowLog1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*FlowLogsClient) NewListPager

func (client *FlowLogsClient) NewListPager(resourceGroupName string, networkWatcherName string, options *FlowLogsClientListOptions) *runtime.Pager[FlowLogsClientListResponse]

NewListPager - Lists all flow log resources for the specified Network Watcher. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherFlowLogList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFlowLogsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "nw1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherFlowLogUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewFlowLogsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "nw", "fl", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type FlowLogsClientBeginCreateOrUpdateOptions

type FlowLogsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

FlowLogsClientBeginCreateOrUpdateOptions contains the optional parameters for the FlowLogsClient.BeginCreateOrUpdate method.

type FlowLogsClientBeginDeleteOptions

type FlowLogsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

FlowLogsClientBeginDeleteOptions contains the optional parameters for the FlowLogsClient.BeginDelete method.

type FlowLogsClientCreateOrUpdateResponse

type FlowLogsClientCreateOrUpdateResponse struct {
	FlowLog
}

FlowLogsClientCreateOrUpdateResponse contains the response from method FlowLogsClient.CreateOrUpdate.

type FlowLogsClientDeleteResponse

type FlowLogsClientDeleteResponse struct {
}

FlowLogsClientDeleteResponse contains the response from method FlowLogsClient.Delete.

type FlowLogsClientGetOptions

type FlowLogsClientGetOptions struct {
}

FlowLogsClientGetOptions contains the optional parameters for the FlowLogsClient.Get method.

type FlowLogsClientGetResponse

type FlowLogsClientGetResponse struct {
	FlowLog
}

FlowLogsClientGetResponse contains the response from method FlowLogsClient.Get.

type FlowLogsClientListOptions

type FlowLogsClientListOptions struct {
}

FlowLogsClientListOptions contains the optional parameters for the FlowLogsClient.List method.

type FlowLogsClientListResponse

type FlowLogsClientListResponse struct {
	FlowLogListResult
}

FlowLogsClientListResponse contains the response from method FlowLogsClient.List.

type FlowLogsClientUpdateTagsOptions

type FlowLogsClientUpdateTagsOptions struct {
}

FlowLogsClientUpdateTagsOptions contains the optional parameters for the FlowLogsClient.UpdateTags method.

type FlowLogsClientUpdateTagsResponse

type FlowLogsClientUpdateTagsResponse struct {
	FlowLog
}

FlowLogsClientUpdateTagsResponse contains the response 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.

func (*FrontendIPConfiguration) UnmarshalJSON

func (f *FrontendIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*FrontendIPConfigurationPropertiesFormat) UnmarshalJSON

func (f *FrontendIPConfigurationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FrontendIPConfigurationPropertiesFormat.

type GatewayCustomBgpIPAddressIPConfiguration

type GatewayCustomBgpIPAddressIPConfiguration struct {
	// REQUIRED; The custom BgpPeeringAddress which belongs to IpconfigurationId.
	CustomBgpIPAddress *string `json:"customBgpIpAddress,omitempty"`

	// REQUIRED; The IpconfigurationId of ipconfiguration which belongs to gateway.
	IPConfigurationID *string `json:"ipConfigurationId,omitempty"`
}

GatewayCustomBgpIPAddressIPConfiguration - GatewayCustomBgpIpAddressIpConfiguration for a virtual network gateway connection.

func (GatewayCustomBgpIPAddressIPConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type GatewayCustomBgpIPAddressIPConfiguration.

func (*GatewayCustomBgpIPAddressIPConfiguration) UnmarshalJSON

func (g *GatewayCustomBgpIPAddressIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayCustomBgpIPAddressIPConfiguration.

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.

func (GatewayLoadBalancerTunnelInterface) MarshalJSON

func (g GatewayLoadBalancerTunnelInterface) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayLoadBalancerTunnelInterface.

func (*GatewayLoadBalancerTunnelInterface) UnmarshalJSON

func (g *GatewayLoadBalancerTunnelInterface) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayLoadBalancerTunnelInterface.

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.

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.

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.

func (GatewayRoute) MarshalJSON

func (g GatewayRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayRoute.

func (*GatewayRoute) UnmarshalJSON

func (g *GatewayRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayRoute.

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.

func (*GatewayRouteListResult) UnmarshalJSON

func (g *GatewayRouteListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (GenerateExpressRoutePortsLOARequest) MarshalJSON

func (g GenerateExpressRoutePortsLOARequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GenerateExpressRoutePortsLOARequest.

func (*GenerateExpressRoutePortsLOARequest) UnmarshalJSON

func (g *GenerateExpressRoutePortsLOARequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GenerateExpressRoutePortsLOARequest.

type GenerateExpressRoutePortsLOAResult

type GenerateExpressRoutePortsLOAResult struct {
	// The content as a base64 encoded string.
	EncodedContent *string `json:"encodedContent,omitempty"`
}

GenerateExpressRoutePortsLOAResult - Response for GenerateExpressRoutePortsLOA API service call.

func (GenerateExpressRoutePortsLOAResult) MarshalJSON

func (g GenerateExpressRoutePortsLOAResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GenerateExpressRoutePortsLOAResult.

func (*GenerateExpressRoutePortsLOAResult) UnmarshalJSON

func (g *GenerateExpressRoutePortsLOAResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GenerateExpressRoutePortsLOAResult.

type Geo

type Geo string

Geo - The Geo for CIDR advertising. Should be an Geo code.

const (
	GeoAFRI    Geo = "AFRI"
	GeoAPAC    Geo = "APAC"
	GeoAQ      Geo = "AQ"
	GeoEURO    Geo = "EURO"
	GeoGLOBAL  Geo = "GLOBAL"
	GeoLATAM   Geo = "LATAM"
	GeoME      Geo = "ME"
	GeoNAM     Geo = "NAM"
	GeoOCEANIA Geo = "OCEANIA"
)

func PossibleGeoValues

func PossibleGeoValues() []Geo

PossibleGeoValues returns the possible values for the Geo const type.

type GetInboundRoutesParameters

type GetInboundRoutesParameters struct {
	// The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and
	// P2SConnection.
	ConnectionType *string `json:"connectionType,omitempty"`

	// The connection resource whose inbound routes are being requested.
	ResourceURI *string `json:"resourceUri,omitempty"`
}

GetInboundRoutesParameters - The parameters specifying the connection resource whose inbound routes are being requested.

func (GetInboundRoutesParameters) MarshalJSON

func (g GetInboundRoutesParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GetInboundRoutesParameters.

func (*GetInboundRoutesParameters) UnmarshalJSON

func (g *GetInboundRoutesParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GetInboundRoutesParameters.

type GetOutboundRoutesParameters

type GetOutboundRoutesParameters struct {
	// The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and
	// P2SConnection.
	ConnectionType *string `json:"connectionType,omitempty"`

	// The connection resource whose outbound routes are being requested.
	ResourceURI *string `json:"resourceUri,omitempty"`
}

GetOutboundRoutesParameters - The parameters specifying the connection resource whose outbound routes are being requested.

func (GetOutboundRoutesParameters) MarshalJSON

func (g GetOutboundRoutesParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GetOutboundRoutesParameters.

func (*GetOutboundRoutesParameters) UnmarshalJSON

func (g *GetOutboundRoutesParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GetOutboundRoutesParameters.

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.

func (*GetVPNSitesConfigurationRequest) UnmarshalJSON

func (g *GetVPNSitesConfigurationRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GetVPNSitesConfigurationRequest.

type Group

type Group struct {
	// The Network Group properties
	Properties *GroupProperties `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 ID.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

Group - The network group resource

func (Group) MarshalJSON

func (g Group) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Group.

func (*Group) UnmarshalJSON

func (g *Group) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Group.

type GroupConnectivity

type GroupConnectivity string

GroupConnectivity - Group connectivity type.

const (
	GroupConnectivityDirectlyConnected GroupConnectivity = "DirectlyConnected"
	GroupConnectivityNone              GroupConnectivity = "None"
)

func PossibleGroupConnectivityValues

func PossibleGroupConnectivityValues() []GroupConnectivity

PossibleGroupConnectivityValues returns the possible values for the GroupConnectivity const type.

type GroupListResult

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

	// Gets a page of NetworkGroup
	Value []*Group `json:"value,omitempty"`
}

GroupListResult - Result of the request to list NetworkGroup. It contains a list of groups and a URL link to get the next set of results.

func (GroupListResult) MarshalJSON

func (g GroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GroupListResult.

func (*GroupListResult) UnmarshalJSON

func (g *GroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GroupListResult.

type GroupProperties

type GroupProperties struct {
	// A description of the network group.
	Description *string `json:"description,omitempty"`

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

GroupProperties - Properties of network group

func (GroupProperties) MarshalJSON

func (g GroupProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GroupProperties.

func (*GroupProperties) UnmarshalJSON

func (g *GroupProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GroupProperties.

type GroupsClient

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

GroupsClient contains the methods for the NetworkGroups group. Don't use this type directly, use NewGroupsClient() instead.

func NewGroupsClient

func NewGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*GroupsClient, error)

NewGroupsClient creates a new instance of GroupsClient 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 (*GroupsClient) BeginDelete

func (client *GroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkManagerName string, networkGroupName string, options *GroupsClientBeginDeleteOptions) (*runtime.Poller[GroupsClientDeleteResponse], error)

BeginDelete - Deletes a network group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. networkGroupName - The name of the network group. options - GroupsClientBeginDeleteOptions contains the optional parameters for the GroupsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerGroupDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewGroupsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testNetworkManager", "testNetworkGroup", &armnetwork.GroupsClientBeginDeleteOptions{Force: to.Ptr(false)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*GroupsClient) CreateOrUpdate

func (client *GroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkManagerName string, networkGroupName string, parameters Group, options *GroupsClientCreateOrUpdateOptions) (GroupsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a network group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. networkGroupName - The name of the network group. parameters - Parameters supplied to the specify which network group need to create options - GroupsClientCreateOrUpdateOptions contains the optional parameters for the GroupsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerGroupPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewGroupsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "testNetworkManager", "testNetworkGroup", armnetwork.Group{
	Properties: &armnetwork.GroupProperties{
		Description: to.Ptr("A sample group"),
	},
}, &armnetwork.GroupsClientCreateOrUpdateOptions{IfMatch: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*GroupsClient) Get

func (client *GroupsClient) Get(ctx context.Context, resourceGroupName string, networkManagerName string, networkGroupName string, options *GroupsClientGetOptions) (GroupsClientGetResponse, error)

Get - Gets the specified network group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. networkGroupName - The name of the network group. options - GroupsClientGetOptions contains the optional parameters for the GroupsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewGroupsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testNetworkManager", "testNetworkGroup", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*GroupsClient) NewListPager

func (client *GroupsClient) NewListPager(resourceGroupName string, networkManagerName string, options *GroupsClientListOptions) *runtime.Pager[GroupsClientListResponse]

NewListPager - Lists the specified network group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. options - GroupsClientListOptions contains the optional parameters for the GroupsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerGroupList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewGroupsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "testNetworkManager", &armnetwork.GroupsClientListOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type GroupsClientBeginDeleteOptions

type GroupsClientBeginDeleteOptions struct {
	// Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service
	// will do a cleanup deployment in the background, prior to the delete.
	Force *bool
	// Resumes the LRO from the provided token.
	ResumeToken string
}

GroupsClientBeginDeleteOptions contains the optional parameters for the GroupsClient.BeginDelete method.

type GroupsClientCreateOrUpdateOptions

type GroupsClientCreateOrUpdateOptions struct {
	// The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value
	// to prevent accidentally overwriting concurrent changes.
	IfMatch *string
}

GroupsClientCreateOrUpdateOptions contains the optional parameters for the GroupsClient.CreateOrUpdate method.

type GroupsClientCreateOrUpdateResponse

type GroupsClientCreateOrUpdateResponse struct {
	Group
	// ETag contains the information returned from the ETag header response.
	ETag *string
}

GroupsClientCreateOrUpdateResponse contains the response from method GroupsClient.CreateOrUpdate.

type GroupsClientDeleteResponse

type GroupsClientDeleteResponse struct {
}

GroupsClientDeleteResponse contains the response from method GroupsClient.Delete.

type GroupsClientGetOptions

type GroupsClientGetOptions struct {
}

GroupsClientGetOptions contains the optional parameters for the GroupsClient.Get method.

type GroupsClientGetResponse

type GroupsClientGetResponse struct {
	Group
}

GroupsClientGetResponse contains the response from method GroupsClient.Get.

type GroupsClientListOptions

type GroupsClientListOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

GroupsClientListOptions contains the optional parameters for the GroupsClient.List method.

type GroupsClientListResponse

type GroupsClientListResponse struct {
	GroupListResult
}

GroupsClientListResponse contains the response from method GroupsClient.List.

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.

func (*HTTPConfiguration) UnmarshalJSON

func (h *HTTPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (HTTPHeader) MarshalJSON

func (h HTTPHeader) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HTTPHeader.

func (*HTTPHeader) UnmarshalJSON

func (h *HTTPHeader) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPHeader.

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.

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.

func (*HopLink) UnmarshalJSON

func (h *HopLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (HopLinkProperties) MarshalJSON

func (h HopLinkProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HopLinkProperties.

func (*HopLinkProperties) UnmarshalJSON

func (h *HopLinkProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HopLinkProperties.

type Hub

type Hub struct {
	// Resource Id.
	ResourceID *string `json:"resourceId,omitempty"`

	// Resource Type.
	ResourceType *string `json:"resourceType,omitempty"`
}

Hub Item.

func (Hub) MarshalJSON

func (h Hub) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Hub.

func (*Hub) UnmarshalJSON

func (h *Hub) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Hub.

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.

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.

func (HubIPAddresses) MarshalJSON

func (h HubIPAddresses) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubIPAddresses.

func (*HubIPAddresses) UnmarshalJSON

func (h *HubIPAddresses) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HubIPAddresses.

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.

func (HubIPConfiguration) MarshalJSON

func (h HubIPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubIPConfiguration.

func (*HubIPConfiguration) UnmarshalJSON

func (h *HubIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HubIPConfiguration.

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.

func (HubIPConfigurationPropertiesFormat) MarshalJSON

func (h HubIPConfigurationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubIPConfigurationPropertiesFormat.

func (*HubIPConfigurationPropertiesFormat) UnmarshalJSON

func (h *HubIPConfigurationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HubIPConfigurationPropertiesFormat.

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.

func (*HubPublicIPAddresses) UnmarshalJSON

func (h *HubPublicIPAddresses) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*HubRoute) UnmarshalJSON

func (h *HubRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (HubRouteTable) MarshalJSON

func (h HubRouteTable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubRouteTable.

func (*HubRouteTable) UnmarshalJSON

func (h *HubRouteTable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HubRouteTable.

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.

func (*HubRouteTableProperties) UnmarshalJSON

func (h *HubRouteTableProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[HubRouteTablesClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/HubRouteTablePut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewHubRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "virtualHub1", "hubRouteTable1", armnetwork.HubRouteTable{
	Properties: &armnetwork.HubRouteTableProperties{
		Labels: []*string{
			to.Ptr("label1"),
			to.Ptr("label2")},
		Routes: []*armnetwork.HubRoute{
			{
				Name:            to.Ptr("route1"),
				DestinationType: to.Ptr("CIDR"),
				Destinations: []*string{
					to.Ptr("10.0.0.0/8"),
					to.Ptr("20.0.0.0/8"),
					to.Ptr("30.0.0.0/8")},
				NextHop:     to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1"),
				NextHopType: to.Ptr("ResourceId"),
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*HubRouteTablesClient) BeginDelete

func (client *HubRouteTablesClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, routeTableName string, options *HubRouteTablesClientBeginDeleteOptions) (*runtime.Poller[HubRouteTablesClientDeleteResponse], error)

BeginDelete - Deletes a RouteTable. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/HubRouteTableDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewHubRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "virtualHub1", "hubRouteTable1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/HubRouteTableGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewHubRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "virtualHub1", "hubRouteTable1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*HubRouteTablesClient) NewListPager

func (client *HubRouteTablesClient) NewListPager(resourceGroupName string, virtualHubName string, options *HubRouteTablesClientListOptions) *runtime.Pager[HubRouteTablesClientListResponse]

NewListPager - Retrieves the details of all RouteTables. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/HubRouteTableList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewHubRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "virtualHub1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type HubRouteTablesClientBeginCreateOrUpdateOptions

type HubRouteTablesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

HubRouteTablesClientBeginCreateOrUpdateOptions contains the optional parameters for the HubRouteTablesClient.BeginCreateOrUpdate method.

type HubRouteTablesClientBeginDeleteOptions

type HubRouteTablesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

HubRouteTablesClientBeginDeleteOptions contains the optional parameters for the HubRouteTablesClient.BeginDelete method.

type HubRouteTablesClientCreateOrUpdateResponse

type HubRouteTablesClientCreateOrUpdateResponse struct {
	HubRouteTable
}

HubRouteTablesClientCreateOrUpdateResponse contains the response from method HubRouteTablesClient.CreateOrUpdate.

type HubRouteTablesClientDeleteResponse

type HubRouteTablesClientDeleteResponse struct {
}

HubRouteTablesClientDeleteResponse contains the response from method HubRouteTablesClient.Delete.

type HubRouteTablesClientGetOptions

type HubRouteTablesClientGetOptions struct {
}

HubRouteTablesClientGetOptions contains the optional parameters for the HubRouteTablesClient.Get method.

type HubRouteTablesClientGetResponse

type HubRouteTablesClientGetResponse struct {
	HubRouteTable
}

HubRouteTablesClientGetResponse contains the response from method HubRouteTablesClient.Get.

type HubRouteTablesClientListOptions

type HubRouteTablesClientListOptions struct {
}

HubRouteTablesClientListOptions contains the optional parameters for the HubRouteTablesClient.List method.

type HubRouteTablesClientListResponse

type HubRouteTablesClientListResponse struct {
	ListHubRouteTablesResult
}

HubRouteTablesClientListResponse contains the response from method HubRouteTablesClient.List.

type HubRoutingPreference

type HubRoutingPreference string

HubRoutingPreference - The hub routing preference gateway types

const (
	HubRoutingPreferenceASPath       HubRoutingPreference = "ASPath"
	HubRoutingPreferenceExpressRoute HubRoutingPreference = "ExpressRoute"
	HubRoutingPreferenceVPNGateway   HubRoutingPreference = "VpnGateway"
)

func PossibleHubRoutingPreferenceValues

func PossibleHubRoutingPreferenceValues() []HubRoutingPreference

PossibleHubRoutingPreferenceValues returns the possible values for the HubRoutingPreference const type.

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.

func (HubVirtualNetworkConnection) MarshalJSON

func (h HubVirtualNetworkConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubVirtualNetworkConnection.

func (*HubVirtualNetworkConnection) UnmarshalJSON

func (h *HubVirtualNetworkConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HubVirtualNetworkConnection.

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.

func (HubVirtualNetworkConnectionProperties) MarshalJSON

func (h HubVirtualNetworkConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HubVirtualNetworkConnectionProperties.

func (*HubVirtualNetworkConnectionProperties) UnmarshalJSON

func (h *HubVirtualNetworkConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HubVirtualNetworkConnectionProperties.

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.

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, error)

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) (*runtime.Poller[HubVirtualNetworkConnectionsClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/HubVirtualNetworkConnectionPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewHubVirtualNetworkConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "virtualHub1", "connection1", armnetwork.HubVirtualNetworkConnection{
	Properties: &armnetwork.HubVirtualNetworkConnectionProperties{
		EnableInternetSecurity: to.Ptr(false),
		RemoteVirtualNetwork: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1"),
		},
		RoutingConfiguration: &armnetwork.RoutingConfiguration{
			AssociatedRouteTable: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
			},
			InboundRouteMap: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"),
			},
			OutboundRouteMap: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"),
			},
			PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
				IDs: []*armnetwork.SubResource{
					{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
					}},
				Labels: []*string{
					to.Ptr("label1"),
					to.Ptr("label2")},
			},
			VnetRoutes: &armnetwork.VnetRoute{
				StaticRoutes: []*armnetwork.StaticRoute{
					{
						Name: to.Ptr("route1"),
						AddressPrefixes: []*string{
							to.Ptr("10.1.0.0/16"),
							to.Ptr("10.2.0.0/16")},
						NextHopIPAddress: to.Ptr("10.0.0.68"),
					},
					{
						Name: to.Ptr("route2"),
						AddressPrefixes: []*string{
							to.Ptr("10.3.0.0/16"),
							to.Ptr("10.4.0.0/16")},
						NextHopIPAddress: to.Ptr("10.0.0.65"),
					}},
				StaticRoutesConfig: &armnetwork.StaticRoutesConfig{
					VnetLocalRouteOverrideCriteria: to.Ptr(armnetwork.VnetLocalRouteOverrideCriteriaEqual),
				},
			},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*HubVirtualNetworkConnectionsClient) BeginDelete

BeginDelete - Deletes a HubVirtualNetworkConnection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/HubVirtualNetworkConnectionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewHubVirtualNetworkConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "virtualHub1", "connection1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*HubVirtualNetworkConnectionsClient) Get

Get - Retrieves the details of a HubVirtualNetworkConnection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/HubVirtualNetworkConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewHubVirtualNetworkConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "virtualHub1", "connection1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*HubVirtualNetworkConnectionsClient) NewListPager

NewListPager - Retrieves the details of all HubVirtualNetworkConnections. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/HubVirtualNetworkConnectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewHubVirtualNetworkConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "virtualHub1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type HubVirtualNetworkConnectionsClientBeginCreateOrUpdateOptions

type HubVirtualNetworkConnectionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

HubVirtualNetworkConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.BeginCreateOrUpdate method.

type HubVirtualNetworkConnectionsClientBeginDeleteOptions

type HubVirtualNetworkConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

HubVirtualNetworkConnectionsClientBeginDeleteOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.BeginDelete method.

type HubVirtualNetworkConnectionsClientCreateOrUpdateResponse

type HubVirtualNetworkConnectionsClientCreateOrUpdateResponse struct {
	HubVirtualNetworkConnection
}

HubVirtualNetworkConnectionsClientCreateOrUpdateResponse contains the response from method HubVirtualNetworkConnectionsClient.CreateOrUpdate.

type HubVirtualNetworkConnectionsClientDeleteResponse

type HubVirtualNetworkConnectionsClientDeleteResponse struct {
}

HubVirtualNetworkConnectionsClientDeleteResponse contains the response from method HubVirtualNetworkConnectionsClient.Delete.

type HubVirtualNetworkConnectionsClientGetOptions

type HubVirtualNetworkConnectionsClientGetOptions struct {
}

HubVirtualNetworkConnectionsClientGetOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.Get method.

type HubVirtualNetworkConnectionsClientGetResponse

type HubVirtualNetworkConnectionsClientGetResponse struct {
	HubVirtualNetworkConnection
}

HubVirtualNetworkConnectionsClientGetResponse contains the response from method HubVirtualNetworkConnectionsClient.Get.

type HubVirtualNetworkConnectionsClientListOptions

type HubVirtualNetworkConnectionsClientListOptions struct {
}

HubVirtualNetworkConnectionsClientListOptions contains the optional parameters for the HubVirtualNetworkConnectionsClient.List method.

type HubVirtualNetworkConnectionsClientListResponse

type HubVirtualNetworkConnectionsClientListResponse struct {
	ListHubVirtualNetworkConnectionsResult
}

HubVirtualNetworkConnectionsClientListResponse contains the response from method HubVirtualNetworkConnectionsClient.List.

type IDPSQueryObject

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

func (i IDPSQueryObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IDPSQueryObject.

func (*IDPSQueryObject) UnmarshalJSON

func (i *IDPSQueryObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*IPAddressAvailabilityResult) UnmarshalJSON

func (i *IPAddressAvailabilityResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*IPAllocation) UnmarshalJSON

func (i *IPAllocation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*IPAllocationListResult) UnmarshalJSON

func (i *IPAllocationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (*IPAllocationPropertiesFormat) UnmarshalJSON

func (i *IPAllocationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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, error)

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) (*runtime.Poller[IPAllocationsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an IpAllocation in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpAllocationCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPAllocationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-ipallocation", armnetwork.IPAllocation{
	Location: to.Ptr("centraluseuap"),
	Properties: &armnetwork.IPAllocationPropertiesFormat{
		Type: to.Ptr(armnetwork.IPAllocationTypeHypernet),
		AllocationTags: map[string]*string{
			"VNetID": to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1"),
		},
		Prefix: to.Ptr("3.2.5.0/24"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*IPAllocationsClient) BeginDelete

func (client *IPAllocationsClient) BeginDelete(ctx context.Context, resourceGroupName string, ipAllocationName string, options *IPAllocationsClientBeginDeleteOptions) (*runtime.Poller[IPAllocationsClientDeleteResponse], error)

BeginDelete - Deletes the specified IpAllocation. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpAllocationDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPAllocationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-ipallocation", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpAllocationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPAllocationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "test-ipallocation", &armnetwork.IPAllocationsClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*IPAllocationsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Gets all IpAllocations in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - IPAllocationsClientListByResourceGroupOptions contains the optional parameters for the IPAllocationsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpAllocationListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPAllocationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*IPAllocationsClient) NewListPager

NewListPager - Gets all IpAllocations in a subscription. Generated from API version 2022-05-01 options - IPAllocationsClientListOptions contains the optional parameters for the IPAllocationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpAllocationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPAllocationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpAllocationUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPAllocationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-ipallocation", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type IPAllocationsClientBeginCreateOrUpdateOptions

type IPAllocationsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IPAllocationsClientBeginCreateOrUpdateOptions contains the optional parameters for the IPAllocationsClient.BeginCreateOrUpdate method.

type IPAllocationsClientBeginDeleteOptions

type IPAllocationsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IPAllocationsClientBeginDeleteOptions contains the optional parameters for the IPAllocationsClient.BeginDelete method.

type IPAllocationsClientCreateOrUpdateResponse

type IPAllocationsClientCreateOrUpdateResponse struct {
	IPAllocation
}

IPAllocationsClientCreateOrUpdateResponse contains the response from method IPAllocationsClient.CreateOrUpdate.

type IPAllocationsClientDeleteResponse

type IPAllocationsClientDeleteResponse struct {
}

IPAllocationsClientDeleteResponse contains the response from method IPAllocationsClient.Delete.

type IPAllocationsClientGetOptions

type IPAllocationsClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

IPAllocationsClientGetOptions contains the optional parameters for the IPAllocationsClient.Get method.

type IPAllocationsClientGetResponse

type IPAllocationsClientGetResponse struct {
	IPAllocation
}

IPAllocationsClientGetResponse contains the response from method IPAllocationsClient.Get.

type IPAllocationsClientListByResourceGroupOptions

type IPAllocationsClientListByResourceGroupOptions struct {
}

IPAllocationsClientListByResourceGroupOptions contains the optional parameters for the IPAllocationsClient.ListByResourceGroup method.

type IPAllocationsClientListByResourceGroupResponse

type IPAllocationsClientListByResourceGroupResponse struct {
	IPAllocationListResult
}

IPAllocationsClientListByResourceGroupResponse contains the response from method IPAllocationsClient.ListByResourceGroup.

type IPAllocationsClientListOptions

type IPAllocationsClientListOptions struct {
}

IPAllocationsClientListOptions contains the optional parameters for the IPAllocationsClient.List method.

type IPAllocationsClientListResponse

type IPAllocationsClientListResponse struct {
	IPAllocationListResult
}

IPAllocationsClientListResponse contains the response from method IPAllocationsClient.List.

type IPAllocationsClientUpdateTagsOptions

type IPAllocationsClientUpdateTagsOptions struct {
}

IPAllocationsClientUpdateTagsOptions contains the optional parameters for the IPAllocationsClient.UpdateTags method.

type IPAllocationsClientUpdateTagsResponse

type IPAllocationsClientUpdateTagsResponse struct {
	IPAllocation
}

IPAllocationsClientUpdateTagsResponse contains the response 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.

func (IPConfiguration) MarshalJSON

func (i IPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPConfiguration.

func (*IPConfiguration) UnmarshalJSON

func (i *IPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPConfiguration.

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.

func (*IPConfigurationBgpPeeringAddress) UnmarshalJSON

func (i *IPConfigurationBgpPeeringAddress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (IPConfigurationProfile) MarshalJSON

func (i IPConfigurationProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPConfigurationProfile.

func (*IPConfigurationProfile) UnmarshalJSON

func (i *IPConfigurationProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPConfigurationProfile.

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.

func (IPConfigurationProfilePropertiesFormat) MarshalJSON

func (i IPConfigurationProfilePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPConfigurationProfilePropertiesFormat.

func (*IPConfigurationProfilePropertiesFormat) UnmarshalJSON

func (i *IPConfigurationProfilePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPConfigurationProfilePropertiesFormat.

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.

func (IPConfigurationPropertiesFormat) MarshalJSON

func (i IPConfigurationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPConfigurationPropertiesFormat.

func (*IPConfigurationPropertiesFormat) UnmarshalJSON

func (i *IPConfigurationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPConfigurationPropertiesFormat.

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.

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.

func (*IPGroup) UnmarshalJSON

func (i *IPGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*IPGroupListResult) UnmarshalJSON

func (i *IPGroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*IPGroupPropertiesFormat) UnmarshalJSON

func (i *IPGroupPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[IPGroupsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an ipGroups in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpGroupsCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPGroupsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "myResourceGroup", "ipGroups1", armnetwork.IPGroup{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.IPGroupPropertiesFormat{
		IPAddresses: []*string{
			to.Ptr("13.64.39.16/32"),
			to.Ptr("40.74.146.80/31"),
			to.Ptr("40.74.147.32/28")},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*IPGroupsClient) BeginDelete

func (client *IPGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, ipGroupsName string, options *IPGroupsClientBeginDeleteOptions) (*runtime.Poller[IPGroupsClientDeleteResponse], error)

BeginDelete - Deletes the specified ipGroups. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpGroupsDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPGroupsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "myResourceGroup", "ipGroups1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpGroupsGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPGroupsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "myResourceGroup", "ipGroups1", &armnetwork.IPGroupsClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*IPGroupsClient) NewListByResourceGroupPager

func (client *IPGroupsClient) NewListByResourceGroupPager(resourceGroupName string, options *IPGroupsClientListByResourceGroupOptions) *runtime.Pager[IPGroupsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Gets all IpGroups in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - IPGroupsClientListByResourceGroupOptions contains the optional parameters for the IPGroupsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpGroupsListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPGroupsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("myResourceGroup", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*IPGroupsClient) NewListPager

NewListPager - Gets all IpGroups in a subscription. Generated from API version 2022-05-01 options - IPGroupsClientListOptions contains the optional parameters for the IPGroupsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpGroupsListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPGroupsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/IpGroupsUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewIPGroupsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateGroups(ctx, "myResourceGroup", "ipGroups1", armnetwork.TagsObject{
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
		"key2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type IPGroupsClientBeginCreateOrUpdateOptions

type IPGroupsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IPGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the IPGroupsClient.BeginCreateOrUpdate method.

type IPGroupsClientBeginDeleteOptions

type IPGroupsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

IPGroupsClientBeginDeleteOptions contains the optional parameters for the IPGroupsClient.BeginDelete method.

type IPGroupsClientCreateOrUpdateResponse

type IPGroupsClientCreateOrUpdateResponse struct {
	IPGroup
}

IPGroupsClientCreateOrUpdateResponse contains the response from method IPGroupsClient.CreateOrUpdate.

type IPGroupsClientDeleteResponse

type IPGroupsClientDeleteResponse struct {
}

IPGroupsClientDeleteResponse contains the response from method IPGroupsClient.Delete.

type IPGroupsClientGetOptions

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

type IPGroupsClientGetResponse struct {
	IPGroup
}

IPGroupsClientGetResponse contains the response from method IPGroupsClient.Get.

type IPGroupsClientListByResourceGroupOptions

type IPGroupsClientListByResourceGroupOptions struct {
}

IPGroupsClientListByResourceGroupOptions contains the optional parameters for the IPGroupsClient.ListByResourceGroup method.

type IPGroupsClientListByResourceGroupResponse

type IPGroupsClientListByResourceGroupResponse struct {
	IPGroupListResult
}

IPGroupsClientListByResourceGroupResponse contains the response from method IPGroupsClient.ListByResourceGroup.

type IPGroupsClientListOptions

type IPGroupsClientListOptions struct {
}

IPGroupsClientListOptions contains the optional parameters for the IPGroupsClient.List method.

type IPGroupsClientListResponse

type IPGroupsClientListResponse struct {
	IPGroupListResult
}

IPGroupsClientListResponse contains the response from method IPGroupsClient.List.

type IPGroupsClientUpdateGroupsOptions

type IPGroupsClientUpdateGroupsOptions struct {
}

IPGroupsClientUpdateGroupsOptions contains the optional parameters for the IPGroupsClient.UpdateGroups method.

type IPGroupsClientUpdateGroupsResponse

type IPGroupsClientUpdateGroupsResponse struct {
	IPGroup
}

IPGroupsClientUpdateGroupsResponse contains the response from method IPGroupsClient.UpdateGroups.

type IPPrefixesList

type IPPrefixesList struct {
	// IP Prefix value.
	IPPrefixes []*string `json:"ipPrefixes,omitempty"`
}

IPPrefixesList - List of SNAT IP Prefixes learnt by firewall to not SNAT

func (IPPrefixesList) MarshalJSON

func (i IPPrefixesList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPPrefixesList.

func (*IPPrefixesList) UnmarshalJSON

func (i *IPPrefixesList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPPrefixesList.

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.

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.

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.

func (IPSecPolicy) MarshalJSON

func (i IPSecPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPSecPolicy.

func (*IPSecPolicy) UnmarshalJSON

func (i *IPSecPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPSecPolicy.

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.

func (IPTag) MarshalJSON

func (i IPTag) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPTag.

func (*IPTag) UnmarshalJSON

func (i *IPTag) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPTag.

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.

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.

func (IPv6CircuitConnectionConfig) MarshalJSON

func (i IPv6CircuitConnectionConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPv6CircuitConnectionConfig.

func (*IPv6CircuitConnectionConfig) UnmarshalJSON

func (i *IPv6CircuitConnectionConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPv6CircuitConnectionConfig.

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.

func (IPv6ExpressRouteCircuitPeeringConfig) MarshalJSON

func (i IPv6ExpressRouteCircuitPeeringConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IPv6ExpressRouteCircuitPeeringConfig.

func (*IPv6ExpressRouteCircuitPeeringConfig) UnmarshalJSON

func (i *IPv6ExpressRouteCircuitPeeringConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IPv6ExpressRouteCircuitPeeringConfig.

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.

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.

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.

func (InboundNatPool) MarshalJSON

func (i InboundNatPool) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundNatPool.

func (*InboundNatPool) UnmarshalJSON

func (i *InboundNatPool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InboundNatPool.

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.

func (InboundNatPoolPropertiesFormat) MarshalJSON

func (i InboundNatPoolPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundNatPoolPropertiesFormat.

func (*InboundNatPoolPropertiesFormat) UnmarshalJSON

func (i *InboundNatPoolPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InboundNatPoolPropertiesFormat.

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.

func (InboundNatRule) MarshalJSON

func (i InboundNatRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundNatRule.

func (*InboundNatRule) UnmarshalJSON

func (i *InboundNatRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InboundNatRule.

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.

func (*InboundNatRuleListResult) UnmarshalJSON

func (i *InboundNatRuleListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InboundNatRuleListResult.

type InboundNatRulePortMapping

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.

func (InboundNatRulePortMapping) MarshalJSON

func (i InboundNatRulePortMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundNatRulePortMapping.

func (*InboundNatRulePortMapping) UnmarshalJSON

func (i *InboundNatRulePortMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InboundNatRulePortMapping.

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.

func (InboundNatRulePropertiesFormat) MarshalJSON

func (i InboundNatRulePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundNatRulePropertiesFormat.

func (*InboundNatRulePropertiesFormat) UnmarshalJSON

func (i *InboundNatRulePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InboundNatRulePropertiesFormat.

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, error)

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) (*runtime.Poller[InboundNatRulesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a load balancer inbound NAT rule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/InboundNatRuleCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInboundNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "testrg", "lb1", "natRule1.1", armnetwork.InboundNatRule{
	Properties: &armnetwork.InboundNatRulePropertiesFormat{
		BackendPort:      to.Ptr[int32](3389),
		EnableFloatingIP: to.Ptr(false),
		EnableTCPReset:   to.Ptr(false),
		FrontendIPConfiguration: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1"),
		},
		FrontendPort:         to.Ptr[int32](3390),
		IdleTimeoutInMinutes: to.Ptr[int32](4),
		Protocol:             to.Ptr(armnetwork.TransportProtocolTCP),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InboundNatRulesClient) BeginDelete

func (client *InboundNatRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, loadBalancerName string, inboundNatRuleName string, options *InboundNatRulesClientBeginDeleteOptions) (*runtime.Poller[InboundNatRulesClientDeleteResponse], error)

BeginDelete - Deletes the specified load balancer inbound NAT rule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/InboundNatRuleDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInboundNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "testrg", "lb1", "natRule1.1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/InboundNatRuleGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInboundNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "testrg", "lb1", "natRule1.1", &armnetwork.InboundNatRulesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InboundNatRulesClient) NewListPager

func (client *InboundNatRulesClient) NewListPager(resourceGroupName string, loadBalancerName string, options *InboundNatRulesClientListOptions) *runtime.Pager[InboundNatRulesClientListResponse]

NewListPager - Gets all the inbound NAT rules in a load balancer. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/InboundNatRuleList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInboundNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "lb1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type InboundNatRulesClientBeginCreateOrUpdateOptions

type InboundNatRulesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

InboundNatRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the InboundNatRulesClient.BeginCreateOrUpdate method.

type InboundNatRulesClientBeginDeleteOptions

type InboundNatRulesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

InboundNatRulesClientBeginDeleteOptions contains the optional parameters for the InboundNatRulesClient.BeginDelete method.

type InboundNatRulesClientCreateOrUpdateResponse

type InboundNatRulesClientCreateOrUpdateResponse struct {
	InboundNatRule
}

InboundNatRulesClientCreateOrUpdateResponse contains the response from method InboundNatRulesClient.CreateOrUpdate.

type InboundNatRulesClientDeleteResponse

type InboundNatRulesClientDeleteResponse struct {
}

InboundNatRulesClientDeleteResponse contains the response from method InboundNatRulesClient.Delete.

type InboundNatRulesClientGetOptions

type InboundNatRulesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

InboundNatRulesClientGetOptions contains the optional parameters for the InboundNatRulesClient.Get method.

type InboundNatRulesClientGetResponse

type InboundNatRulesClientGetResponse struct {
	InboundNatRule
}

InboundNatRulesClientGetResponse contains the response from method InboundNatRulesClient.Get.

type InboundNatRulesClientListOptions

type InboundNatRulesClientListOptions struct {
}

InboundNatRulesClientListOptions contains the optional parameters for the InboundNatRulesClient.List method.

type InboundNatRulesClientListResponse

type InboundNatRulesClientListResponse struct {
	InboundNatRuleListResult
}

InboundNatRulesClientListResponse contains the response 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.

func (InboundSecurityRule) MarshalJSON

func (i InboundSecurityRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundSecurityRule.

func (*InboundSecurityRule) UnmarshalJSON

func (i *InboundSecurityRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InboundSecurityRule.

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, error)

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) (*runtime.Poller[InboundSecurityRuleClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates the specified Network Virtual Appliance Inbound Security Rules. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/InboundSecurityRulePut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInboundSecurityRuleClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "nva", "rule1", armnetwork.InboundSecurityRule{
	Properties: &armnetwork.InboundSecurityRuleProperties{
		Rules: []*armnetwork.InboundSecurityRules{
			{
				DestinationPortRange: to.Ptr[int32](22),
				SourceAddressPrefix:  to.Ptr("50.20.121.5/32"),
				Protocol:             to.Ptr(armnetwork.InboundSecurityRulesProtocolTCP),
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

type InboundSecurityRuleClientBeginCreateOrUpdateOptions

type InboundSecurityRuleClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

InboundSecurityRuleClientBeginCreateOrUpdateOptions contains the optional parameters for the InboundSecurityRuleClient.BeginCreateOrUpdate method.

type InboundSecurityRuleClientCreateOrUpdateResponse

type InboundSecurityRuleClientCreateOrUpdateResponse struct {
	InboundSecurityRule
}

InboundSecurityRuleClientCreateOrUpdateResponse contains the response 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.

func (*InboundSecurityRuleProperties) UnmarshalJSON

func (i *InboundSecurityRuleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (InboundSecurityRules) MarshalJSON

func (i InboundSecurityRules) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InboundSecurityRules.

func (*InboundSecurityRules) UnmarshalJSON

func (i *InboundSecurityRules) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InboundSecurityRules.

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.

type IntentPolicy

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

func (i IntentPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntentPolicy.

func (*IntentPolicy) UnmarshalJSON

func (i *IntentPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntentPolicy.

type IntentPolicyConfiguration

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.

func (IntentPolicyConfiguration) MarshalJSON

func (i IntentPolicyConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IntentPolicyConfiguration.

func (*IntentPolicyConfiguration) UnmarshalJSON

func (i *IntentPolicyConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IntentPolicyConfiguration.

type Interface

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

func (i Interface) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Interface.

func (*Interface) UnmarshalJSON

func (i *Interface) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Interface.

type InterfaceAssociation

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

func (i InterfaceAssociation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceAssociation.

func (*InterfaceAssociation) UnmarshalJSON

func (i *InterfaceAssociation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceAssociation.

type InterfaceDNSSettings

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

func (i InterfaceDNSSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceDNSSettings.

func (*InterfaceDNSSettings) UnmarshalJSON

func (i *InterfaceDNSSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceDNSSettings.

type InterfaceIPConfiguration

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.

func (InterfaceIPConfiguration) MarshalJSON

func (i InterfaceIPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceIPConfiguration.

func (*InterfaceIPConfiguration) UnmarshalJSON

func (i *InterfaceIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceIPConfiguration.

type InterfaceIPConfigurationListResult

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

func (i InterfaceIPConfigurationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceIPConfigurationListResult.

func (*InterfaceIPConfigurationListResult) UnmarshalJSON

func (i *InterfaceIPConfigurationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceIPConfigurationListResult.

type InterfaceIPConfigurationPrivateLinkConnectionProperties

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

MarshalJSON implements the json.Marshaller interface for type InterfaceIPConfigurationPrivateLinkConnectionProperties.

func (*InterfaceIPConfigurationPrivateLinkConnectionProperties) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceIPConfigurationPrivateLinkConnectionProperties.

type InterfaceIPConfigurationPropertiesFormat

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

MarshalJSON implements the json.Marshaller interface for type InterfaceIPConfigurationPropertiesFormat.

func (*InterfaceIPConfigurationPropertiesFormat) UnmarshalJSON

func (i *InterfaceIPConfigurationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceIPConfigurationPropertiesFormat.

type InterfaceIPConfigurationsClient

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

func NewInterfaceIPConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*InterfaceIPConfigurationsClient, error)

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

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceIPConfigurationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfaceIPConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "testrg", "mynic", "ipconfig1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InterfaceIPConfigurationsClient) NewListPager

NewListPager - Get all ip configurations in a network interface. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceIPConfigurationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfaceIPConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "nic1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type InterfaceIPConfigurationsClientGetOptions

type InterfaceIPConfigurationsClientGetOptions struct {
}

InterfaceIPConfigurationsClientGetOptions contains the optional parameters for the InterfaceIPConfigurationsClient.Get method.

type InterfaceIPConfigurationsClientGetResponse

type InterfaceIPConfigurationsClientGetResponse struct {
	InterfaceIPConfiguration
}

InterfaceIPConfigurationsClientGetResponse contains the response from method InterfaceIPConfigurationsClient.Get.

type InterfaceIPConfigurationsClientListOptions

type InterfaceIPConfigurationsClientListOptions struct {
}

InterfaceIPConfigurationsClientListOptions contains the optional parameters for the InterfaceIPConfigurationsClient.List method.

type InterfaceIPConfigurationsClientListResponse

type InterfaceIPConfigurationsClientListResponse struct {
	InterfaceIPConfigurationListResult
}

InterfaceIPConfigurationsClientListResponse contains the response from method InterfaceIPConfigurationsClient.List.

type InterfaceListResult

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

func (i InterfaceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceListResult.

func (*InterfaceListResult) UnmarshalJSON

func (i *InterfaceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceListResult.

type InterfaceLoadBalancerListResult

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

func (i InterfaceLoadBalancerListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceLoadBalancerListResult.

func (*InterfaceLoadBalancerListResult) UnmarshalJSON

func (i *InterfaceLoadBalancerListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceLoadBalancerListResult.

type InterfaceLoadBalancersClient

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

func NewInterfaceLoadBalancersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*InterfaceLoadBalancersClient, error)

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) NewListPager

func (client *InterfaceLoadBalancersClient) NewListPager(resourceGroupName string, networkInterfaceName string, options *InterfaceLoadBalancersClientListOptions) *runtime.Pager[InterfaceLoadBalancersClientListResponse]

NewListPager - List all load balancers in a network interface. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceLoadBalancerList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfaceLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "nic1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type InterfaceLoadBalancersClientListOptions

type InterfaceLoadBalancersClientListOptions struct {
}

InterfaceLoadBalancersClientListOptions contains the optional parameters for the InterfaceLoadBalancersClient.List method.

type InterfaceLoadBalancersClientListResponse

type InterfaceLoadBalancersClientListResponse struct {
	InterfaceLoadBalancerListResult
}

InterfaceLoadBalancersClientListResponse contains the response from method InterfaceLoadBalancersClient.List.

type InterfacePropertiesFormat

type InterfacePropertiesFormat struct {
	// Auxiliary mode of Network Interface resource.
	AuxiliaryMode *NetworkInterfaceAuxiliaryMode `json:"auxiliaryMode,omitempty"`

	// The DNS settings in network interface.
	DNSSettings *InterfaceDNSSettings `json:"dnsSettings,omitempty"`

	// Indicates whether to disable tcp state tracking.
	DisableTCPStateTracking *bool `json:"disableTcpStateTracking,omitempty"`

	// If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated
	// networking.
	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

func (i InterfacePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfacePropertiesFormat.

func (*InterfacePropertiesFormat) UnmarshalJSON

func (i *InterfacePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfacePropertiesFormat.

type InterfaceTapConfiguration

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.

func (InterfaceTapConfiguration) MarshalJSON

func (i InterfaceTapConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceTapConfiguration.

func (*InterfaceTapConfiguration) UnmarshalJSON

func (i *InterfaceTapConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceTapConfiguration.

type InterfaceTapConfigurationListResult

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

func (i InterfaceTapConfigurationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceTapConfigurationListResult.

func (*InterfaceTapConfigurationListResult) UnmarshalJSON

func (i *InterfaceTapConfigurationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceTapConfigurationListResult.

type InterfaceTapConfigurationPropertiesFormat

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.

func (InterfaceTapConfigurationPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type InterfaceTapConfigurationPropertiesFormat.

func (*InterfaceTapConfigurationPropertiesFormat) UnmarshalJSON

func (i *InterfaceTapConfigurationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceTapConfigurationPropertiesFormat.

type InterfaceTapConfigurationsClient

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

func NewInterfaceTapConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*InterfaceTapConfigurationsClient, error)

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

func (client *InterfaceTapConfigurationsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkInterfaceName string, tapConfigurationName string, tapConfigurationParameters InterfaceTapConfiguration, options *InterfaceTapConfigurationsClientBeginCreateOrUpdateOptions) (*runtime.Poller[InterfaceTapConfigurationsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a Tap configuration in the specified NetworkInterface. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceTapConfigurationCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfaceTapConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "testrg", "mynic", "tapconfiguration1", armnetwork.InterfaceTapConfiguration{
	Properties: &armnetwork.InterfaceTapConfigurationPropertiesFormat{
		VirtualNetworkTap: &armnetwork.VirtualNetworkTap{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InterfaceTapConfigurationsClient) BeginDelete

func (client *InterfaceTapConfigurationsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkInterfaceName string, tapConfigurationName string, options *InterfaceTapConfigurationsClientBeginDeleteOptions) (*runtime.Poller[InterfaceTapConfigurationsClientDeleteResponse], error)

BeginDelete - Deletes the specified tap configuration from the NetworkInterface. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceTapConfigurationDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfaceTapConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-networkinterface", "test-tapconfiguration", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*InterfaceTapConfigurationsClient) Get

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceTapConfigurationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfaceTapConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "testrg", "mynic", "tapconfiguration1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InterfaceTapConfigurationsClient) NewListPager

NewListPager - Get all Tap configurations in a network interface. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceTapConfigurationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfaceTapConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "mynic", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type InterfaceTapConfigurationsClientBeginCreateOrUpdateOptions

type InterfaceTapConfigurationsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

InterfaceTapConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the InterfaceTapConfigurationsClient.BeginCreateOrUpdate method.

type InterfaceTapConfigurationsClientBeginDeleteOptions

type InterfaceTapConfigurationsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

InterfaceTapConfigurationsClientBeginDeleteOptions contains the optional parameters for the InterfaceTapConfigurationsClient.BeginDelete method.

type InterfaceTapConfigurationsClientCreateOrUpdateResponse

type InterfaceTapConfigurationsClientCreateOrUpdateResponse struct {
	InterfaceTapConfiguration
}

InterfaceTapConfigurationsClientCreateOrUpdateResponse contains the response from method InterfaceTapConfigurationsClient.CreateOrUpdate.

type InterfaceTapConfigurationsClientDeleteResponse

type InterfaceTapConfigurationsClientDeleteResponse struct {
}

InterfaceTapConfigurationsClientDeleteResponse contains the response from method InterfaceTapConfigurationsClient.Delete.

type InterfaceTapConfigurationsClientGetOptions

type InterfaceTapConfigurationsClientGetOptions struct {
}

InterfaceTapConfigurationsClientGetOptions contains the optional parameters for the InterfaceTapConfigurationsClient.Get method.

type InterfaceTapConfigurationsClientGetResponse

type InterfaceTapConfigurationsClientGetResponse struct {
	InterfaceTapConfiguration
}

InterfaceTapConfigurationsClientGetResponse contains the response from method InterfaceTapConfigurationsClient.Get.

type InterfaceTapConfigurationsClientListOptions

type InterfaceTapConfigurationsClientListOptions struct {
}

InterfaceTapConfigurationsClientListOptions contains the optional parameters for the InterfaceTapConfigurationsClient.List method.

type InterfaceTapConfigurationsClientListResponse

type InterfaceTapConfigurationsClientListResponse struct {
	InterfaceTapConfigurationListResult
}

InterfaceTapConfigurationsClientListResponse contains the response from method InterfaceTapConfigurationsClient.List.

type InterfacesClient

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

func NewInterfacesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*InterfacesClient, error)

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

func (client *InterfacesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkInterfaceName string, parameters Interface, options *InterfacesClientBeginCreateOrUpdateOptions) (*runtime.Poller[InterfacesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a network interface. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateNetworkInterface)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-nic", armnetwork.Interface{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.InterfacePropertiesFormat{
		DisableTCPStateTracking:     to.Ptr(true),
		EnableAcceleratedNetworking: to.Ptr(true),
		IPConfigurations: []*armnetwork.InterfaceIPConfiguration{
			{
				Name: to.Ptr("ipconfig1"),
				Properties: &armnetwork.InterfaceIPConfigurationPropertiesFormat{
					PublicIPAddress: &armnetwork.PublicIPAddress{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip"),
					},
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default"),
					},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateNetworkInterfaceWithGatewayLoadBalancerConsumerConfigured)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceCreateGatewayLoadBalancerConsumer.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-nic", armnetwork.Interface{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.InterfacePropertiesFormat{
		EnableAcceleratedNetworking: to.Ptr(true),
		IPConfigurations: []*armnetwork.InterfaceIPConfiguration{
			{
				Name: to.Ptr("ipconfig1"),
				Properties: &armnetwork.InterfaceIPConfigurationPropertiesFormat{
					GatewayLoadBalancer: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider"),
					},
					PublicIPAddress: &armnetwork.PublicIPAddress{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip"),
					},
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default"),
					},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InterfacesClient) BeginDelete

func (client *InterfacesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkInterfaceName string, options *InterfacesClientBeginDeleteOptions) (*runtime.Poller[InterfacesClientDeleteResponse], error)

BeginDelete - Deletes the specified network interface. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-nic", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*InterfacesClient) BeginGetEffectiveRouteTable

func (client *InterfacesClient) BeginGetEffectiveRouteTable(ctx context.Context, resourceGroupName string, networkInterfaceName string, options *InterfacesClientBeginGetEffectiveRouteTableOptions) (*runtime.Poller[InterfacesClientGetEffectiveRouteTableResponse], error)

BeginGetEffectiveRouteTable - Gets all route tables applied to a network interface. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceEffectiveRouteTableList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetEffectiveRouteTable(ctx, "rg1", "nic1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InterfacesClient) BeginListEffectiveNetworkSecurityGroups

func (client *InterfacesClient) BeginListEffectiveNetworkSecurityGroups(ctx context.Context, resourceGroupName string, networkInterfaceName string, options *InterfacesClientBeginListEffectiveNetworkSecurityGroupsOptions) (*runtime.Poller[InterfacesClientListEffectiveNetworkSecurityGroupsResponse], error)

BeginListEffectiveNetworkSecurityGroups - Gets all network security groups applied to a network interface. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceEffectiveNSGList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListEffectiveNetworkSecurityGroups(ctx, "rg1", "nic1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InterfacesClient) Get

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "test-nic", &armnetwork.InterfacesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InterfacesClient) GetCloudServiceNetworkInterface

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CloudServiceNetworkInterfaceGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetCloudServiceNetworkInterface(ctx, "rg1", "cs1", "TestVMRole_IN_0", "nic1", &armnetwork.InterfacesClientGetCloudServiceNetworkInterfaceOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InterfacesClient) GetVirtualMachineScaleSetIPConfiguration

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. Generated from API version 2018-10-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VmssNetworkInterfaceIpConfigGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetVirtualMachineScaleSetIPConfiguration(ctx, "rg1", "vmss1", "2", "nic1", "ip1", &armnetwork.InterfacesClientGetVirtualMachineScaleSetIPConfigurationOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InterfacesClient) GetVirtualMachineScaleSetNetworkInterface

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. Generated from API version 2018-10-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VmssNetworkInterfaceGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetVirtualMachineScaleSetNetworkInterface(ctx, "rg1", "vmss1", "1", "nic1", &armnetwork.InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*InterfacesClient) NewListAllPager

NewListAllPager - Gets all network interfaces in a subscription. Generated from API version 2022-05-01 options - InterfacesClientListAllOptions contains the optional parameters for the InterfacesClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*InterfacesClient) NewListCloudServiceNetworkInterfacesPager

func (client *InterfacesClient) NewListCloudServiceNetworkInterfacesPager(resourceGroupName string, cloudServiceName string, options *InterfacesClientListCloudServiceNetworkInterfacesOptions) *runtime.Pager[InterfacesClientListCloudServiceNetworkInterfacesResponse]

NewListCloudServiceNetworkInterfacesPager - Gets all network interfaces in a cloud service. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CloudServiceNetworkInterfaceList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListCloudServiceNetworkInterfacesPager("rg1", "cs1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*InterfacesClient) NewListCloudServiceRoleInstanceNetworkInterfacesPager

func (client *InterfacesClient) NewListCloudServiceRoleInstanceNetworkInterfacesPager(resourceGroupName string, cloudServiceName string, roleInstanceName string, options *InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesOptions) *runtime.Pager[InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResponse]

NewListCloudServiceRoleInstanceNetworkInterfacesPager - Gets information about all network interfaces in a role instance in a cloud service. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CloudServiceRoleInstanceNetworkInterfaceList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListCloudServiceRoleInstanceNetworkInterfacesPager("rg1", "cs1", "TestVMRole_IN_0", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*InterfacesClient) NewListPager

func (client *InterfacesClient) NewListPager(resourceGroupName string, options *InterfacesClientListOptions) *runtime.Pager[InterfacesClientListResponse]

NewListPager - Gets all network interfaces in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - InterfacesClientListOptions contains the optional parameters for the InterfacesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*InterfacesClient) NewListVirtualMachineScaleSetIPConfigurationsPager

func (client *InterfacesClient) NewListVirtualMachineScaleSetIPConfigurationsPager(resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, options *InterfacesClientListVirtualMachineScaleSetIPConfigurationsOptions) *runtime.Pager[InterfacesClientListVirtualMachineScaleSetIPConfigurationsResponse]

NewListVirtualMachineScaleSetIPConfigurationsPager - Get the specified network interface ip configuration in a virtual machine scale set. Generated from API version 2018-10-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VmssNetworkInterfaceIpConfigList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListVirtualMachineScaleSetIPConfigurationsPager("rg1", "vmss1", "2", "nic1", &armnetwork.InterfacesClientListVirtualMachineScaleSetIPConfigurationsOptions{Expand: nil})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*InterfacesClient) NewListVirtualMachineScaleSetNetworkInterfacesPager

func (client *InterfacesClient) NewListVirtualMachineScaleSetNetworkInterfacesPager(resourceGroupName string, virtualMachineScaleSetName string, options *InterfacesClientListVirtualMachineScaleSetNetworkInterfacesOptions) *runtime.Pager[InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResponse]

NewListVirtualMachineScaleSetNetworkInterfacesPager - Gets all network interfaces in a virtual machine scale set. Generated from API version 2018-10-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VmssNetworkInterfaceList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListVirtualMachineScaleSetNetworkInterfacesPager("rg1", "vmss1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*InterfacesClient) NewListVirtualMachineScaleSetVMNetworkInterfacesPager

func (client *InterfacesClient) NewListVirtualMachineScaleSetVMNetworkInterfacesPager(resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, options *InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesOptions) *runtime.Pager[InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResponse]

NewListVirtualMachineScaleSetVMNetworkInterfacesPager - Gets information about all network interfaces in a virtual machine in a virtual machine scale set. Generated from API version 2018-10-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VmssVmNetworkInterfaceList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListVirtualMachineScaleSetVMNetworkInterfacesPager("rg1", "vmss1", "1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*InterfacesClient) UpdateTags

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkInterfaceUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-nic", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type InterfacesClientBeginCreateOrUpdateOptions

type InterfacesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

InterfacesClientBeginCreateOrUpdateOptions contains the optional parameters for the InterfacesClient.BeginCreateOrUpdate method.

type InterfacesClientBeginDeleteOptions

type InterfacesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

InterfacesClientBeginDeleteOptions contains the optional parameters for the InterfacesClient.BeginDelete method.

type InterfacesClientBeginGetEffectiveRouteTableOptions

type InterfacesClientBeginGetEffectiveRouteTableOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

InterfacesClientBeginGetEffectiveRouteTableOptions contains the optional parameters for the InterfacesClient.BeginGetEffectiveRouteTable method.

type InterfacesClientBeginListEffectiveNetworkSecurityGroupsOptions

type InterfacesClientBeginListEffectiveNetworkSecurityGroupsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

InterfacesClientBeginListEffectiveNetworkSecurityGroupsOptions contains the optional parameters for the InterfacesClient.BeginListEffectiveNetworkSecurityGroups method.

type InterfacesClientCreateOrUpdateResponse

type InterfacesClientCreateOrUpdateResponse struct {
	Interface
}

InterfacesClientCreateOrUpdateResponse contains the response from method InterfacesClient.CreateOrUpdate.

type InterfacesClientDeleteResponse

type InterfacesClientDeleteResponse struct {
}

InterfacesClientDeleteResponse contains the response from method InterfacesClient.Delete.

type InterfacesClientGetCloudServiceNetworkInterfaceOptions

type InterfacesClientGetCloudServiceNetworkInterfaceOptions struct {
	// Expands referenced resources.
	Expand *string
}

InterfacesClientGetCloudServiceNetworkInterfaceOptions contains the optional parameters for the InterfacesClient.GetCloudServiceNetworkInterface method.

type InterfacesClientGetCloudServiceNetworkInterfaceResponse

type InterfacesClientGetCloudServiceNetworkInterfaceResponse struct {
	Interface
}

InterfacesClientGetCloudServiceNetworkInterfaceResponse contains the response from method InterfacesClient.GetCloudServiceNetworkInterface.

type InterfacesClientGetEffectiveRouteTableResponse

type InterfacesClientGetEffectiveRouteTableResponse struct {
	EffectiveRouteListResult
}

InterfacesClientGetEffectiveRouteTableResponse contains the response from method InterfacesClient.GetEffectiveRouteTable.

type InterfacesClientGetOptions

type InterfacesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

InterfacesClientGetOptions contains the optional parameters for the InterfacesClient.Get method.

type InterfacesClientGetResponse

type InterfacesClientGetResponse struct {
	Interface
}

InterfacesClientGetResponse contains the response from method InterfacesClient.Get.

type InterfacesClientGetVirtualMachineScaleSetIPConfigurationOptions

type InterfacesClientGetVirtualMachineScaleSetIPConfigurationOptions struct {
	// Expands referenced resources.
	Expand *string
}

InterfacesClientGetVirtualMachineScaleSetIPConfigurationOptions contains the optional parameters for the InterfacesClient.GetVirtualMachineScaleSetIPConfiguration method.

type InterfacesClientGetVirtualMachineScaleSetIPConfigurationResponse

type InterfacesClientGetVirtualMachineScaleSetIPConfigurationResponse struct {
	InterfaceIPConfiguration
}

InterfacesClientGetVirtualMachineScaleSetIPConfigurationResponse contains the response from method InterfacesClient.GetVirtualMachineScaleSetIPConfiguration.

type InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceOptions

type InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceOptions struct {
	// Expands referenced resources.
	Expand *string
}

InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceOptions contains the optional parameters for the InterfacesClient.GetVirtualMachineScaleSetNetworkInterface method.

type InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResponse

type InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResponse struct {
	Interface
}

InterfacesClientGetVirtualMachineScaleSetNetworkInterfaceResponse contains the response from method InterfacesClient.GetVirtualMachineScaleSetNetworkInterface.

type InterfacesClientListAllOptions

type InterfacesClientListAllOptions struct {
}

InterfacesClientListAllOptions contains the optional parameters for the InterfacesClient.ListAll method.

type InterfacesClientListAllResponse

type InterfacesClientListAllResponse struct {
	InterfaceListResult
}

InterfacesClientListAllResponse contains the response from method InterfacesClient.ListAll.

type InterfacesClientListCloudServiceNetworkInterfacesOptions

type InterfacesClientListCloudServiceNetworkInterfacesOptions struct {
}

InterfacesClientListCloudServiceNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListCloudServiceNetworkInterfaces method.

type InterfacesClientListCloudServiceNetworkInterfacesResponse

type InterfacesClientListCloudServiceNetworkInterfacesResponse struct {
	InterfaceListResult
}

InterfacesClientListCloudServiceNetworkInterfacesResponse contains the response from method InterfacesClient.ListCloudServiceNetworkInterfaces.

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesOptions

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesOptions struct {
}

InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListCloudServiceRoleInstanceNetworkInterfaces method.

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResponse

type InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResponse struct {
	InterfaceListResult
}

InterfacesClientListCloudServiceRoleInstanceNetworkInterfacesResponse contains the response from method InterfacesClient.ListCloudServiceRoleInstanceNetworkInterfaces.

type InterfacesClientListEffectiveNetworkSecurityGroupsResponse

type InterfacesClientListEffectiveNetworkSecurityGroupsResponse struct {
	EffectiveNetworkSecurityGroupListResult
}

InterfacesClientListEffectiveNetworkSecurityGroupsResponse contains the response from method InterfacesClient.ListEffectiveNetworkSecurityGroups.

type InterfacesClientListOptions

type InterfacesClientListOptions struct {
}

InterfacesClientListOptions contains the optional parameters for the InterfacesClient.List method.

type InterfacesClientListResponse

type InterfacesClientListResponse struct {
	InterfaceListResult
}

InterfacesClientListResponse contains the response from method InterfacesClient.List.

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsOptions

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsOptions struct {
	// Expands referenced resources.
	Expand *string
}

InterfacesClientListVirtualMachineScaleSetIPConfigurationsOptions contains the optional parameters for the InterfacesClient.ListVirtualMachineScaleSetIPConfigurations method.

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsResponse

type InterfacesClientListVirtualMachineScaleSetIPConfigurationsResponse struct {
	InterfaceIPConfigurationListResult
}

InterfacesClientListVirtualMachineScaleSetIPConfigurationsResponse contains the response from method InterfacesClient.ListVirtualMachineScaleSetIPConfigurations.

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesOptions

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesOptions struct {
}

InterfacesClientListVirtualMachineScaleSetNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListVirtualMachineScaleSetNetworkInterfaces method.

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResponse

type InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResponse struct {
	InterfaceListResult
}

InterfacesClientListVirtualMachineScaleSetNetworkInterfacesResponse contains the response from method InterfacesClient.ListVirtualMachineScaleSetNetworkInterfaces.

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesOptions

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesOptions struct {
}

InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesOptions contains the optional parameters for the InterfacesClient.ListVirtualMachineScaleSetVMNetworkInterfaces method.

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResponse

type InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResponse struct {
	InterfaceListResult
}

InterfacesClientListVirtualMachineScaleSetVMNetworkInterfacesResponse contains the response from method InterfacesClient.ListVirtualMachineScaleSetVMNetworkInterfaces.

type InterfacesClientUpdateTagsOptions

type InterfacesClientUpdateTagsOptions struct {
}

InterfacesClientUpdateTagsOptions contains the optional parameters for the InterfacesClient.UpdateTags method.

type InterfacesClientUpdateTagsResponse

type InterfacesClientUpdateTagsResponse struct {
	Interface
}

InterfacesClientUpdateTagsResponse contains the response from method InterfacesClient.UpdateTags.

type IsGlobal

type IsGlobal string

IsGlobal - Flag if global mesh is supported.

const (
	IsGlobalFalse IsGlobal = "False"
	IsGlobalTrue  IsGlobal = "True"
)

func PossibleIsGlobalValues

func PossibleIsGlobalValues() []IsGlobal

PossibleIsGlobalValues returns the possible values for the IsGlobal const type.

type IsWorkloadProtected

type IsWorkloadProtected string

IsWorkloadProtected - Value indicating whether the IP address is DDoS workload protected or not.

const (
	IsWorkloadProtectedFalse IsWorkloadProtected = "False"
	IsWorkloadProtectedTrue  IsWorkloadProtected = "True"
)

func PossibleIsWorkloadProtectedValues

func PossibleIsWorkloadProtectedValues() []IsWorkloadProtected

PossibleIsWorkloadProtectedValues returns the possible values for the IsWorkloadProtected const type.

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.

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.

func (*ListHubRouteTablesResult) UnmarshalJSON

func (l *ListHubRouteTablesResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListHubVirtualNetworkConnectionsResult) UnmarshalJSON

func (l *ListHubVirtualNetworkConnectionsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListP2SVPNGatewaysResult) UnmarshalJSON

func (l *ListP2SVPNGatewaysResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListP2SVPNGatewaysResult.

type ListRouteMapsResult

type ListRouteMapsResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of RouteMaps.
	Value []*RouteMap `json:"value,omitempty"`
}

ListRouteMapsResult - List of RouteMaps and a URL nextLink to get the next set of results.

func (ListRouteMapsResult) MarshalJSON

func (l ListRouteMapsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListRouteMapsResult.

func (*ListRouteMapsResult) UnmarshalJSON

func (l *ListRouteMapsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListRouteMapsResult.

type ListRoutingIntentResult

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

func (l ListRoutingIntentResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListRoutingIntentResult.

func (*ListRoutingIntentResult) UnmarshalJSON

func (l *ListRoutingIntentResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVPNConnectionsResult) UnmarshalJSON

func (l *ListVPNConnectionsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVPNGatewayNatRulesResult) UnmarshalJSON

func (l *ListVPNGatewayNatRulesResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVPNGatewaysResult) UnmarshalJSON

func (l *ListVPNGatewaysResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListVPNGatewaysResult.

type ListVPNServerConfigurationPolicyGroupsResult

type ListVPNServerConfigurationPolicyGroupsResult struct {
	// URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`

	// List of VpnServerConfigurationPolicyGroups.
	Value []*VPNServerConfigurationPolicyGroup `json:"value,omitempty"`
}

ListVPNServerConfigurationPolicyGroupsResult - Result of the request to list VpnServerConfigurationPolicyGroups. It contains a list of VpnServerConfigurationPolicyGroups and a URL nextLink to get the next set of results.

func (ListVPNServerConfigurationPolicyGroupsResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ListVPNServerConfigurationPolicyGroupsResult.

func (*ListVPNServerConfigurationPolicyGroupsResult) UnmarshalJSON

func (l *ListVPNServerConfigurationPolicyGroupsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListVPNServerConfigurationPolicyGroupsResult.

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.

func (*ListVPNServerConfigurationsResult) UnmarshalJSON

func (l *ListVPNServerConfigurationsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVPNSiteLinkConnectionsResult) UnmarshalJSON

func (l *ListVPNSiteLinkConnectionsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVPNSiteLinksResult) UnmarshalJSON

func (l *ListVPNSiteLinksResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVPNSitesResult) UnmarshalJSON

func (l *ListVPNSitesResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVirtualHubBgpConnectionResults) UnmarshalJSON

func (l *ListVirtualHubBgpConnectionResults) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVirtualHubIPConfigurationResults) UnmarshalJSON

func (l *ListVirtualHubIPConfigurationResults) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVirtualHubRouteTableV2SResult) UnmarshalJSON

func (l *ListVirtualHubRouteTableV2SResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVirtualHubsResult) UnmarshalJSON

func (l *ListVirtualHubsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVirtualNetworkGatewayNatRulesResult) UnmarshalJSON

func (l *ListVirtualNetworkGatewayNatRulesResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ListVirtualWANsResult) UnmarshalJSON

func (l *ListVirtualWANsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*LoadBalancer) UnmarshalJSON

func (l *LoadBalancer) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (LoadBalancerBackendAddress) MarshalJSON

func (l LoadBalancerBackendAddress) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerBackendAddress.

func (*LoadBalancerBackendAddress) UnmarshalJSON

func (l *LoadBalancerBackendAddress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LoadBalancerBackendAddress.

type LoadBalancerBackendAddressAdminState

type LoadBalancerBackendAddressAdminState string

LoadBalancerBackendAddressAdminState - A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.

const (
	LoadBalancerBackendAddressAdminStateDown  LoadBalancerBackendAddressAdminState = "Down"
	LoadBalancerBackendAddressAdminStateDrain LoadBalancerBackendAddressAdminState = "Drain"
	LoadBalancerBackendAddressAdminStateNone  LoadBalancerBackendAddressAdminState = "None"
	LoadBalancerBackendAddressAdminStateUp    LoadBalancerBackendAddressAdminState = "Up"
)

func PossibleLoadBalancerBackendAddressAdminStateValues

func PossibleLoadBalancerBackendAddressAdminStateValues() []LoadBalancerBackendAddressAdminState

PossibleLoadBalancerBackendAddressAdminStateValues returns the possible values for the LoadBalancerBackendAddressAdminState const type.

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

MarshalJSON implements the json.Marshaller interface for type LoadBalancerBackendAddressPoolListResult.

func (*LoadBalancerBackendAddressPoolListResult) UnmarshalJSON

func (l *LoadBalancerBackendAddressPoolListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

BeginCreateOrUpdate - Creates or updates a load balancer backend address pool. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerBackendAddressPoolsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "testrg", "lb", "backend", armnetwork.BackendAddressPool{
	Properties: &armnetwork.BackendAddressPoolPropertiesFormat{
		LoadBalancerBackendAddresses: []*armnetwork.LoadBalancerBackendAddress{
			{
				Name: to.Ptr("address1"),
				Properties: &armnetwork.LoadBalancerBackendAddressPropertiesFormat{
					IPAddress: to.Ptr("10.0.0.4"),
					VirtualNetwork: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb"),
					},
				},
			},
			{
				Name: to.Ptr("address2"),
				Properties: &armnetwork.LoadBalancerBackendAddressPropertiesFormat{
					IPAddress: to.Ptr("10.0.0.5"),
					VirtualNetwork: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb"),
					},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LoadBalancerBackendAddressPoolsClient) BeginDelete

BeginDelete - Deletes the specified load balancer backend address pool. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerBackendAddressPoolDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerBackendAddressPoolsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "testrg", "lb", "backend", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*LoadBalancerBackendAddressPoolsClient) Get

Get - Gets load balancer backend address pool. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (LoadBalancerBackendAddressPoolGet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerBackendAddressPoolGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerBackendAddressPoolsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "testrg", "lb", "backend", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (LoadBalancerWithBackendAddressPoolWithBackendAddresses)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerBackendAddressPoolsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "testrg", "lb", "backend", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LoadBalancerBackendAddressPoolsClient) NewListPager

NewListPager - Gets all the load balancer backed address pools. Generated from API version 2022-05-01 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 (LoadBalancerBackendAddressPoolList)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerBackendAddressPoolList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerBackendAddressPoolsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "lb", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

Example (LoadBalancerWithBackendAddressPoolContainingBackendAddresses)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerBackendAddressPoolsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "lb", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type LoadBalancerBackendAddressPoolsClientBeginCreateOrUpdateOptions

type LoadBalancerBackendAddressPoolsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LoadBalancerBackendAddressPoolsClientBeginCreateOrUpdateOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.BeginCreateOrUpdate method.

type LoadBalancerBackendAddressPoolsClientBeginDeleteOptions

type LoadBalancerBackendAddressPoolsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LoadBalancerBackendAddressPoolsClientBeginDeleteOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.BeginDelete method.

type LoadBalancerBackendAddressPoolsClientCreateOrUpdateResponse

type LoadBalancerBackendAddressPoolsClientCreateOrUpdateResponse struct {
	BackendAddressPool
}

LoadBalancerBackendAddressPoolsClientCreateOrUpdateResponse contains the response from method LoadBalancerBackendAddressPoolsClient.CreateOrUpdate.

type LoadBalancerBackendAddressPoolsClientDeleteResponse

type LoadBalancerBackendAddressPoolsClientDeleteResponse struct {
}

LoadBalancerBackendAddressPoolsClientDeleteResponse contains the response from method LoadBalancerBackendAddressPoolsClient.Delete.

type LoadBalancerBackendAddressPoolsClientGetOptions

type LoadBalancerBackendAddressPoolsClientGetOptions struct {
}

LoadBalancerBackendAddressPoolsClientGetOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.Get method.

type LoadBalancerBackendAddressPoolsClientGetResponse

type LoadBalancerBackendAddressPoolsClientGetResponse struct {
	BackendAddressPool
}

LoadBalancerBackendAddressPoolsClientGetResponse contains the response from method LoadBalancerBackendAddressPoolsClient.Get.

type LoadBalancerBackendAddressPoolsClientListOptions

type LoadBalancerBackendAddressPoolsClientListOptions struct {
}

LoadBalancerBackendAddressPoolsClientListOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.List method.

type LoadBalancerBackendAddressPoolsClientListResponse

type LoadBalancerBackendAddressPoolsClientListResponse struct {
	LoadBalancerBackendAddressPoolListResult
}

LoadBalancerBackendAddressPoolsClientListResponse contains the response from method LoadBalancerBackendAddressPoolsClient.List.

type LoadBalancerBackendAddressPropertiesFormat

type LoadBalancerBackendAddressPropertiesFormat struct {
	// A list of administrative states which once set can override health probe so that Load Balancer will always forward new
	// connections to backend, or deny new connections and reset existing connections.
	AdminState *LoadBalancerBackendAddressAdminState `json:"adminState,omitempty"`

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

MarshalJSON implements the json.Marshaller interface for type LoadBalancerBackendAddressPropertiesFormat.

func (*LoadBalancerBackendAddressPropertiesFormat) UnmarshalJSON

func (l *LoadBalancerBackendAddressPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type LoadBalancerFrontendIPConfigurationListResult.

func (*LoadBalancerFrontendIPConfigurationListResult) UnmarshalJSON

func (l *LoadBalancerFrontendIPConfigurationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

Get - Gets load balancer frontend IP configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerFrontendIPConfigurationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerFrontendIPConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "testrg", "lb", "frontend", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LoadBalancerFrontendIPConfigurationsClient) NewListPager

NewListPager - Gets all the load balancer frontend IP configurations. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerFrontendIPConfigurationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerFrontendIPConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "lb", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type LoadBalancerFrontendIPConfigurationsClientGetOptions

type LoadBalancerFrontendIPConfigurationsClientGetOptions struct {
}

LoadBalancerFrontendIPConfigurationsClientGetOptions contains the optional parameters for the LoadBalancerFrontendIPConfigurationsClient.Get method.

type LoadBalancerFrontendIPConfigurationsClientGetResponse

type LoadBalancerFrontendIPConfigurationsClientGetResponse struct {
	FrontendIPConfiguration
}

LoadBalancerFrontendIPConfigurationsClientGetResponse contains the response from method LoadBalancerFrontendIPConfigurationsClient.Get.

type LoadBalancerFrontendIPConfigurationsClientListOptions

type LoadBalancerFrontendIPConfigurationsClientListOptions struct {
}

LoadBalancerFrontendIPConfigurationsClientListOptions contains the optional parameters for the LoadBalancerFrontendIPConfigurationsClient.List method.

type LoadBalancerFrontendIPConfigurationsClientListResponse

type LoadBalancerFrontendIPConfigurationsClientListResponse struct {
	LoadBalancerFrontendIPConfigurationListResult
}

LoadBalancerFrontendIPConfigurationsClientListResponse contains the response 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.

func (*LoadBalancerListResult) UnmarshalJSON

func (l *LoadBalancerListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*LoadBalancerLoadBalancingRuleListResult) UnmarshalJSON

func (l *LoadBalancerLoadBalancingRuleListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

Get - Gets the specified load balancer load balancing rule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerLoadBalancingRuleGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerLoadBalancingRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "testrg", "lb1", "rule1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LoadBalancerLoadBalancingRulesClient) NewListPager

NewListPager - Gets all the load balancing rules in a load balancer. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerLoadBalancingRuleList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerLoadBalancingRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "lb1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type LoadBalancerLoadBalancingRulesClientGetOptions

type LoadBalancerLoadBalancingRulesClientGetOptions struct {
}

LoadBalancerLoadBalancingRulesClientGetOptions contains the optional parameters for the LoadBalancerLoadBalancingRulesClient.Get method.

type LoadBalancerLoadBalancingRulesClientGetResponse

type LoadBalancerLoadBalancingRulesClientGetResponse struct {
	LoadBalancingRule
}

LoadBalancerLoadBalancingRulesClientGetResponse contains the response from method LoadBalancerLoadBalancingRulesClient.Get.

type LoadBalancerLoadBalancingRulesClientListOptions

type LoadBalancerLoadBalancingRulesClientListOptions struct {
}

LoadBalancerLoadBalancingRulesClientListOptions contains the optional parameters for the LoadBalancerLoadBalancingRulesClient.List method.

type LoadBalancerLoadBalancingRulesClientListResponse

type LoadBalancerLoadBalancingRulesClientListResponse struct {
	LoadBalancerLoadBalancingRuleListResult
}

LoadBalancerLoadBalancingRulesClientListResponse contains the response 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, error)

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) NewListPager

NewListPager - Gets associated load balancer network interfaces. Generated from API version 2022-05-01 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 (LoadBalancerNetworkInterfaceListSimple)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerNetworkInterfaceListSimple.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerNetworkInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "lb", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

Example (LoadBalancerNetworkInterfaceListVmss)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerNetworkInterfaceListVmss.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerNetworkInterfacesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "lb", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type LoadBalancerNetworkInterfacesClientListOptions

type LoadBalancerNetworkInterfacesClientListOptions struct {
}

LoadBalancerNetworkInterfacesClientListOptions contains the optional parameters for the LoadBalancerNetworkInterfacesClient.List method.

type LoadBalancerNetworkInterfacesClientListResponse

type LoadBalancerNetworkInterfacesClientListResponse struct {
	InterfaceListResult
}

LoadBalancerNetworkInterfacesClientListResponse contains the response 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.

func (*LoadBalancerOutboundRuleListResult) UnmarshalJSON

func (l *LoadBalancerOutboundRuleListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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, error)

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerOutboundRuleGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerOutboundRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "testrg", "lb1", "rule1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LoadBalancerOutboundRulesClient) NewListPager

NewListPager - Gets all the outbound rules in a load balancer. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerOutboundRuleList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerOutboundRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "lb1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type LoadBalancerOutboundRulesClientGetOptions

type LoadBalancerOutboundRulesClientGetOptions struct {
}

LoadBalancerOutboundRulesClientGetOptions contains the optional parameters for the LoadBalancerOutboundRulesClient.Get method.

type LoadBalancerOutboundRulesClientGetResponse

type LoadBalancerOutboundRulesClientGetResponse struct {
	OutboundRule
}

LoadBalancerOutboundRulesClientGetResponse contains the response from method LoadBalancerOutboundRulesClient.Get.

type LoadBalancerOutboundRulesClientListOptions

type LoadBalancerOutboundRulesClientListOptions struct {
}

LoadBalancerOutboundRulesClientListOptions contains the optional parameters for the LoadBalancerOutboundRulesClient.List method.

type LoadBalancerOutboundRulesClientListResponse

type LoadBalancerOutboundRulesClientListResponse struct {
	LoadBalancerOutboundRuleListResult
}

LoadBalancerOutboundRulesClientListResponse contains the response 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.

func (*LoadBalancerProbeListResult) UnmarshalJSON

func (l *LoadBalancerProbeListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerProbeGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerProbesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "testrg", "lb", "probe1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LoadBalancerProbesClient) NewListPager

func (client *LoadBalancerProbesClient) NewListPager(resourceGroupName string, loadBalancerName string, options *LoadBalancerProbesClientListOptions) *runtime.Pager[LoadBalancerProbesClientListResponse]

NewListPager - Gets all the load balancer probes. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerProbeList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancerProbesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testrg", "lb", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type LoadBalancerProbesClientGetOptions

type LoadBalancerProbesClientGetOptions struct {
}

LoadBalancerProbesClientGetOptions contains the optional parameters for the LoadBalancerProbesClient.Get method.

type LoadBalancerProbesClientGetResponse

type LoadBalancerProbesClientGetResponse struct {
	Probe
}

LoadBalancerProbesClientGetResponse contains the response from method LoadBalancerProbesClient.Get.

type LoadBalancerProbesClientListOptions

type LoadBalancerProbesClientListOptions struct {
}

LoadBalancerProbesClientListOptions contains the optional parameters for the LoadBalancerProbesClient.List method.

type LoadBalancerProbesClientListResponse

type LoadBalancerProbesClientListResponse struct {
	LoadBalancerProbeListResult
}

LoadBalancerProbesClientListResponse contains the response 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.

func (*LoadBalancerPropertiesFormat) UnmarshalJSON

func (l *LoadBalancerPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (LoadBalancerSKU) MarshalJSON

func (l LoadBalancerSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancerSKU.

func (*LoadBalancerSKU) UnmarshalJSON

func (l *LoadBalancerSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LoadBalancerSKU.

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.

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.

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.

func (*LoadBalancerVipSwapRequest) UnmarshalJSON

func (l *LoadBalancerVipSwapRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (LoadBalancerVipSwapRequestFrontendIPConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type LoadBalancerVipSwapRequestFrontendIPConfiguration.

func (*LoadBalancerVipSwapRequestFrontendIPConfiguration) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type LoadBalancerVipSwapRequestFrontendIPConfiguration.

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.

func (LoadBalancerVipSwapRequestFrontendIPConfigurationProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type LoadBalancerVipSwapRequestFrontendIPConfigurationProperties.

func (*LoadBalancerVipSwapRequestFrontendIPConfigurationProperties) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type LoadBalancerVipSwapRequestFrontendIPConfigurationProperties.

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, error)

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) (*runtime.Poller[LoadBalancersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a load balancer. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateLoadBalancer)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "lb", armnetwork.LoadBalancer{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.LoadBalancerPropertiesFormat{
		BackendAddressPools: []*armnetwork.BackendAddressPool{
			{
				Name:       to.Ptr("be-lb"),
				Properties: &armnetwork.BackendAddressPoolPropertiesFormat{},
			}},
		FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
			{
				Name: to.Ptr("fe-lb"),
				Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"),
					},
				},
			}},
		InboundNatPools: []*armnetwork.InboundNatPool{},
		InboundNatRules: []*armnetwork.InboundNatRule{
			{
				Name: to.Ptr("in-nat-rule"),
				Properties: &armnetwork.InboundNatRulePropertiesFormat{
					BackendPort:      to.Ptr[int32](3389),
					EnableFloatingIP: to.Ptr(true),
					EnableTCPReset:   to.Ptr(false),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](3389),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					Protocol:             to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		LoadBalancingRules: []*armnetwork.LoadBalancingRule{
			{
				Name: to.Ptr("rulelb"),
				Properties: &armnetwork.LoadBalancingRulePropertiesFormat{
					BackendAddressPool: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"),
					},
					BackendPort:      to.Ptr[int32](80),
					EnableFloatingIP: to.Ptr(true),
					EnableTCPReset:   to.Ptr(false),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](80),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					LoadDistribution:     to.Ptr(armnetwork.LoadDistributionDefault),
					Probe: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"),
					},
					Protocol: to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		Probes: []*armnetwork.Probe{
			{
				Name: to.Ptr("probe-lb"),
				Properties: &armnetwork.ProbePropertiesFormat{
					IntervalInSeconds: to.Ptr[int32](15),
					NumberOfProbes:    to.Ptr[int32](2),
					Port:              to.Ptr[int32](80),
					ProbeThreshold:    to.Ptr[int32](1),
					RequestPath:       to.Ptr("healthcheck.aspx"),
					Protocol:          to.Ptr(armnetwork.ProbeProtocolHTTP),
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateLoadBalancerWithFrontendIpInZone1)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerCreateWithZones.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "lb", armnetwork.LoadBalancer{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.LoadBalancerPropertiesFormat{
		BackendAddressPools: []*armnetwork.BackendAddressPool{
			{
				Name:       to.Ptr("be-lb"),
				Properties: &armnetwork.BackendAddressPoolPropertiesFormat{},
			}},
		FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
			{
				Name: to.Ptr("fe-lb"),
				Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"),
					},
				},
				Zones: []*string{
					to.Ptr("1")},
			}},
		InboundNatPools: []*armnetwork.InboundNatPool{},
		InboundNatRules: []*armnetwork.InboundNatRule{
			{
				Name: to.Ptr("in-nat-rule"),
				Properties: &armnetwork.InboundNatRulePropertiesFormat{
					BackendPort:      to.Ptr[int32](3389),
					EnableFloatingIP: to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](3389),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					Protocol:             to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		LoadBalancingRules: []*armnetwork.LoadBalancingRule{
			{
				Name: to.Ptr("rulelb"),
				Properties: &armnetwork.LoadBalancingRulePropertiesFormat{
					BackendAddressPool: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"),
					},
					BackendPort:      to.Ptr[int32](80),
					EnableFloatingIP: to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](80),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					LoadDistribution:     to.Ptr(armnetwork.LoadDistributionDefault),
					Probe: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"),
					},
					Protocol: to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		OutboundRules: []*armnetwork.OutboundRule{},
		Probes: []*armnetwork.Probe{
			{
				Name: to.Ptr("probe-lb"),
				Properties: &armnetwork.ProbePropertiesFormat{
					IntervalInSeconds: to.Ptr[int32](15),
					NumberOfProbes:    to.Ptr[int32](2),
					Port:              to.Ptr[int32](80),
					ProbeThreshold:    to.Ptr[int32](1),
					RequestPath:       to.Ptr("healthcheck.aspx"),
					Protocol:          to.Ptr(armnetwork.ProbeProtocolHTTP),
				},
			}},
	},
	SKU: &armnetwork.LoadBalancerSKU{
		Name: to.Ptr(armnetwork.LoadBalancerSKUNameStandard),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateLoadBalancerWithGatewayLoadBalancerConsumerConfigured)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerCreateGatewayLoadBalancerConsumer.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "lb", armnetwork.LoadBalancer{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.LoadBalancerPropertiesFormat{
		BackendAddressPools: []*armnetwork.BackendAddressPool{
			{
				Name:       to.Ptr("be-lb"),
				Properties: &armnetwork.BackendAddressPoolPropertiesFormat{},
			}},
		FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
			{
				Name: to.Ptr("fe-lb"),
				Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
					GatewayLoadBalancer: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider"),
					},
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"),
					},
				},
			}},
		InboundNatPools: []*armnetwork.InboundNatPool{},
		InboundNatRules: []*armnetwork.InboundNatRule{
			{
				Name: to.Ptr("in-nat-rule"),
				Properties: &armnetwork.InboundNatRulePropertiesFormat{
					BackendPort:      to.Ptr[int32](3389),
					EnableFloatingIP: to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](3389),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					Protocol:             to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		LoadBalancingRules: []*armnetwork.LoadBalancingRule{
			{
				Name: to.Ptr("rulelb"),
				Properties: &armnetwork.LoadBalancingRulePropertiesFormat{
					BackendAddressPool: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"),
					},
					BackendPort:      to.Ptr[int32](80),
					EnableFloatingIP: to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](80),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					LoadDistribution:     to.Ptr(armnetwork.LoadDistributionDefault),
					Probe: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"),
					},
					Protocol: to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		OutboundRules: []*armnetwork.OutboundRule{},
		Probes: []*armnetwork.Probe{
			{
				Name: to.Ptr("probe-lb"),
				Properties: &armnetwork.ProbePropertiesFormat{
					IntervalInSeconds: to.Ptr[int32](15),
					NumberOfProbes:    to.Ptr[int32](2),
					Port:              to.Ptr[int32](80),
					ProbeThreshold:    to.Ptr[int32](1),
					RequestPath:       to.Ptr("healthcheck.aspx"),
					Protocol:          to.Ptr(armnetwork.ProbeProtocolHTTP),
				},
			}},
	},
	SKU: &armnetwork.LoadBalancerSKU{
		Name: to.Ptr(armnetwork.LoadBalancerSKUNameStandard),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateLoadBalancerWithGatewayLoadBalancerProviderConfiguredWithOneBackendPool)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithOneBackendPool.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "lb", armnetwork.LoadBalancer{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.LoadBalancerPropertiesFormat{
		BackendAddressPools: []*armnetwork.BackendAddressPool{
			{
				Name: to.Ptr("be-lb"),
				Properties: &armnetwork.BackendAddressPoolPropertiesFormat{
					TunnelInterfaces: []*armnetwork.GatewayLoadBalancerTunnelInterface{
						{
							Type:       to.Ptr(armnetwork.GatewayLoadBalancerTunnelInterfaceTypeInternal),
							Identifier: to.Ptr[int32](900),
							Port:       to.Ptr[int32](15000),
							Protocol:   to.Ptr(armnetwork.GatewayLoadBalancerTunnelProtocolVXLAN),
						},
						{
							Type:       to.Ptr(armnetwork.GatewayLoadBalancerTunnelInterfaceTypeInternal),
							Identifier: to.Ptr[int32](901),
							Port:       to.Ptr[int32](15001),
							Protocol:   to.Ptr(armnetwork.GatewayLoadBalancerTunnelProtocolVXLAN),
						}},
				},
			}},
		FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
			{
				Name: to.Ptr("fe-lb"),
				Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"),
					},
				},
			}},
		InboundNatPools: []*armnetwork.InboundNatPool{},
		LoadBalancingRules: []*armnetwork.LoadBalancingRule{
			{
				Name: to.Ptr("rulelb"),
				Properties: &armnetwork.LoadBalancingRulePropertiesFormat{
					BackendAddressPools: []*armnetwork.SubResource{
						{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"),
						}},
					BackendPort:      to.Ptr[int32](0),
					EnableFloatingIP: to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](0),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					LoadDistribution:     to.Ptr(armnetwork.LoadDistributionDefault),
					Probe: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"),
					},
					Protocol: to.Ptr(armnetwork.TransportProtocolAll),
				},
			}},
		OutboundRules: []*armnetwork.OutboundRule{},
		Probes: []*armnetwork.Probe{
			{
				Name: to.Ptr("probe-lb"),
				Properties: &armnetwork.ProbePropertiesFormat{
					IntervalInSeconds: to.Ptr[int32](15),
					NumberOfProbes:    to.Ptr[int32](2),
					Port:              to.Ptr[int32](80),
					ProbeThreshold:    to.Ptr[int32](1),
					RequestPath:       to.Ptr("healthcheck.aspx"),
					Protocol:          to.Ptr(armnetwork.ProbeProtocolHTTP),
				},
			}},
	},
	SKU: &armnetwork.LoadBalancerSKU{
		Name: to.Ptr(armnetwork.LoadBalancerSKUName("Premium")),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateLoadBalancerWithGatewayLoadBalancerProviderConfiguredWithTwoBackendPool)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithTwoBackendPool.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "lb", armnetwork.LoadBalancer{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.LoadBalancerPropertiesFormat{
		BackendAddressPools: []*armnetwork.BackendAddressPool{
			{
				Name:       to.Ptr("be-lb1"),
				Properties: &armnetwork.BackendAddressPoolPropertiesFormat{},
			},
			{
				Name:       to.Ptr("be-lb2"),
				Properties: &armnetwork.BackendAddressPoolPropertiesFormat{},
			}},
		FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
			{
				Name: to.Ptr("fe-lb"),
				Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"),
					},
				},
			}},
		InboundNatPools: []*armnetwork.InboundNatPool{},
		LoadBalancingRules: []*armnetwork.LoadBalancingRule{
			{
				Name: to.Ptr("rulelb"),
				Properties: &armnetwork.LoadBalancingRulePropertiesFormat{
					BackendAddressPool: &armnetwork.SubResource{},
					BackendAddressPools: []*armnetwork.SubResource{
						{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1"),
						},
						{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2"),
						}},
					BackendPort:      to.Ptr[int32](0),
					EnableFloatingIP: to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](0),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					LoadDistribution:     to.Ptr(armnetwork.LoadDistributionDefault),
					Probe: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"),
					},
					Protocol: to.Ptr(armnetwork.TransportProtocolAll),
				},
			}},
		OutboundRules: []*armnetwork.OutboundRule{},
		Probes: []*armnetwork.Probe{
			{
				Name: to.Ptr("probe-lb"),
				Properties: &armnetwork.ProbePropertiesFormat{
					IntervalInSeconds: to.Ptr[int32](15),
					NumberOfProbes:    to.Ptr[int32](2),
					Port:              to.Ptr[int32](80),
					ProbeThreshold:    to.Ptr[int32](1),
					RequestPath:       to.Ptr("healthcheck.aspx"),
					Protocol:          to.Ptr(armnetwork.ProbeProtocolHTTP),
				},
			}},
	},
	SKU: &armnetwork.LoadBalancerSKU{
		Name: to.Ptr(armnetwork.LoadBalancerSKUName("Premium")),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateLoadBalancerWithGlobalTierAndOneRegionalLoadBalancerInItsBackendPool)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerCreateGlobalTier.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "lb", armnetwork.LoadBalancer{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.LoadBalancerPropertiesFormat{
		BackendAddressPools: []*armnetwork.BackendAddressPool{
			{
				Name: to.Ptr("be-lb"),
				Properties: &armnetwork.BackendAddressPoolPropertiesFormat{
					LoadBalancerBackendAddresses: []*armnetwork.LoadBalancerBackendAddress{
						{
							Name: to.Ptr("regional-lb1-address"),
							Properties: &armnetwork.LoadBalancerBackendAddressPropertiesFormat{
								LoadBalancerFrontendIPConfiguration: &armnetwork.SubResource{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb"),
								},
							},
						}},
				},
			}},
		FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
			{
				Name: to.Ptr("fe-lb"),
				Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"),
					},
				},
			}},
		LoadBalancingRules: []*armnetwork.LoadBalancingRule{
			{
				Name: to.Ptr("rulelb"),
				Properties: &armnetwork.LoadBalancingRulePropertiesFormat{
					BackendAddressPool: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"),
					},
					BackendPort:      to.Ptr[int32](80),
					EnableFloatingIP: to.Ptr(false),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](80),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					LoadDistribution:     to.Ptr(armnetwork.LoadDistributionDefault),
					Probe: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"),
					},
					Protocol: to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		Probes: []*armnetwork.Probe{
			{
				Name: to.Ptr("probe-lb"),
				Properties: &armnetwork.ProbePropertiesFormat{
					IntervalInSeconds: to.Ptr[int32](15),
					NumberOfProbes:    to.Ptr[int32](2),
					Port:              to.Ptr[int32](80),
					ProbeThreshold:    to.Ptr[int32](1),
					RequestPath:       to.Ptr("healthcheck.aspx"),
					Protocol:          to.Ptr(armnetwork.ProbeProtocolHTTP),
				},
			}},
	},
	SKU: &armnetwork.LoadBalancerSKU{
		Name: to.Ptr(armnetwork.LoadBalancerSKUNameStandard),
		Tier: to.Ptr(armnetwork.LoadBalancerSKUTierGlobal),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateLoadBalancerWithInboundNatPool)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerCreateWithInboundNatPool.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "lb", armnetwork.LoadBalancer{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.LoadBalancerPropertiesFormat{
		BackendAddressPools: []*armnetwork.BackendAddressPool{},
		FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
			{
				ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test"),
				Name: to.Ptr("test"),
				Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
					PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet"),
					},
				},
				Zones: []*string{},
			}},
		InboundNatPools: []*armnetwork.InboundNatPool{
			{
				ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test"),
				Name: to.Ptr("test"),
				Properties: &armnetwork.InboundNatPoolPropertiesFormat{
					BackendPort:      to.Ptr[int32](8888),
					EnableFloatingIP: to.Ptr(true),
					EnableTCPReset:   to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test"),
					},
					FrontendPortRangeEnd:   to.Ptr[int32](8085),
					FrontendPortRangeStart: to.Ptr[int32](8080),
					IdleTimeoutInMinutes:   to.Ptr[int32](10),
					Protocol:               to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		InboundNatRules:    []*armnetwork.InboundNatRule{},
		LoadBalancingRules: []*armnetwork.LoadBalancingRule{},
		OutboundRules:      []*armnetwork.OutboundRule{},
		Probes:             []*armnetwork.Probe{},
	},
	SKU: &armnetwork.LoadBalancerSKU{
		Name: to.Ptr(armnetwork.LoadBalancerSKUNameStandard),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateLoadBalancerWithOutboundRules)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerCreateWithOutboundRules.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "lb", armnetwork.LoadBalancer{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.LoadBalancerPropertiesFormat{
		BackendAddressPools: []*armnetwork.BackendAddressPool{
			{
				Name:       to.Ptr("be-lb"),
				Properties: &armnetwork.BackendAddressPoolPropertiesFormat{},
			}},
		FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
			{
				Name: to.Ptr("fe-lb"),
				Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
					PublicIPAddress: &armnetwork.PublicIPAddress{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip"),
					},
				},
			}},
		InboundNatPools: []*armnetwork.InboundNatPool{},
		InboundNatRules: []*armnetwork.InboundNatRule{
			{
				Name: to.Ptr("in-nat-rule"),
				Properties: &armnetwork.InboundNatRulePropertiesFormat{
					BackendPort:      to.Ptr[int32](3389),
					EnableFloatingIP: to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](3389),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					Protocol:             to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		LoadBalancingRules: []*armnetwork.LoadBalancingRule{
			{
				Name: to.Ptr("rulelb"),
				Properties: &armnetwork.LoadBalancingRulePropertiesFormat{
					BackendAddressPool: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"),
					},
					BackendPort:         to.Ptr[int32](80),
					DisableOutboundSnat: to.Ptr(true),
					EnableFloatingIP:    to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](80),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					LoadDistribution:     to.Ptr(armnetwork.LoadDistributionDefault),
					Probe: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"),
					},
					Protocol: to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		OutboundRules: []*armnetwork.OutboundRule{
			{
				Name: to.Ptr("rule1"),
				Properties: &armnetwork.OutboundRulePropertiesFormat{
					BackendAddressPool: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"),
					},
					FrontendIPConfigurations: []*armnetwork.SubResource{
						{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
						}},
					Protocol: to.Ptr(armnetwork.LoadBalancerOutboundRuleProtocolAll),
				},
			}},
		Probes: []*armnetwork.Probe{
			{
				Name: to.Ptr("probe-lb"),
				Properties: &armnetwork.ProbePropertiesFormat{
					IntervalInSeconds: to.Ptr[int32](15),
					NumberOfProbes:    to.Ptr[int32](2),
					Port:              to.Ptr[int32](80),
					ProbeThreshold:    to.Ptr[int32](1),
					RequestPath:       to.Ptr("healthcheck.aspx"),
					Protocol:          to.Ptr(armnetwork.ProbeProtocolHTTP),
				},
			}},
	},
	SKU: &armnetwork.LoadBalancerSKU{
		Name: to.Ptr(armnetwork.LoadBalancerSKUNameStandard),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateLoadBalancerWithStandardSku)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerCreateStandardSku.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "lb", armnetwork.LoadBalancer{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.LoadBalancerPropertiesFormat{
		BackendAddressPools: []*armnetwork.BackendAddressPool{
			{
				Name:       to.Ptr("be-lb"),
				Properties: &armnetwork.BackendAddressPoolPropertiesFormat{},
			}},
		FrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
			{
				Name: to.Ptr("fe-lb"),
				Properties: &armnetwork.FrontendIPConfigurationPropertiesFormat{
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"),
					},
				},
			}},
		InboundNatPools: []*armnetwork.InboundNatPool{},
		InboundNatRules: []*armnetwork.InboundNatRule{
			{
				Name: to.Ptr("in-nat-rule"),
				Properties: &armnetwork.InboundNatRulePropertiesFormat{
					BackendPort:      to.Ptr[int32](3389),
					EnableFloatingIP: to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](3389),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					Protocol:             to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		LoadBalancingRules: []*armnetwork.LoadBalancingRule{
			{
				Name: to.Ptr("rulelb"),
				Properties: &armnetwork.LoadBalancingRulePropertiesFormat{
					BackendAddressPool: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"),
					},
					BackendPort:      to.Ptr[int32](80),
					EnableFloatingIP: to.Ptr(true),
					FrontendIPConfiguration: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
					},
					FrontendPort:         to.Ptr[int32](80),
					IdleTimeoutInMinutes: to.Ptr[int32](15),
					LoadDistribution:     to.Ptr(armnetwork.LoadDistributionDefault),
					Probe: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"),
					},
					Protocol: to.Ptr(armnetwork.TransportProtocolTCP),
				},
			}},
		OutboundRules: []*armnetwork.OutboundRule{},
		Probes: []*armnetwork.Probe{
			{
				Name: to.Ptr("probe-lb"),
				Properties: &armnetwork.ProbePropertiesFormat{
					IntervalInSeconds: to.Ptr[int32](15),
					NumberOfProbes:    to.Ptr[int32](2),
					Port:              to.Ptr[int32](80),
					ProbeThreshold:    to.Ptr[int32](1),
					RequestPath:       to.Ptr("healthcheck.aspx"),
					Protocol:          to.Ptr(armnetwork.ProbeProtocolHTTP),
				},
			}},
	},
	SKU: &armnetwork.LoadBalancerSKU{
		Name: to.Ptr(armnetwork.LoadBalancerSKUNameStandard),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LoadBalancersClient) BeginDelete

func (client *LoadBalancersClient) BeginDelete(ctx context.Context, resourceGroupName string, loadBalancerName string, options *LoadBalancersClientBeginDeleteOptions) (*runtime.Poller[LoadBalancersClientDeleteResponse], error)

BeginDelete - Deletes the specified load balancer. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "lb", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*LoadBalancersClient) BeginListInboundNatRulePortMappings

BeginListInboundNatRulePortMappings - List of inbound NAT rule port mappings. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/QueryInboundNatRulePortMapping.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListInboundNatRulePortMappings(ctx, "rg1", "lb1", "bp1", armnetwork.QueryInboundNatRulePortMappingRequest{
	IPAddress: to.Ptr("10.0.0.4"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LoadBalancersClient) BeginSwapPublicIPAddresses

BeginSwapPublicIPAddresses - Swaps VIPs between two load balancers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancersSwapPublicIpAddresses.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginSwapPublicIPAddresses(ctx, "westus", armnetwork.LoadBalancerVipSwapRequest{
	FrontendIPConfigurations: []*armnetwork.LoadBalancerVipSwapRequestFrontendIPConfiguration{
		{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfe1"),
			Properties: &armnetwork.LoadBalancerVipSwapRequestFrontendIPConfigurationProperties{
				PublicIPAddress: &armnetwork.SubResource{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/pip2"),
				},
			},
		},
		{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb2/frontendIPConfigurations/lbfe2"),
			Properties: &armnetwork.LoadBalancerVipSwapRequestFrontendIPConfigurationProperties{
				PublicIPAddress: &armnetwork.SubResource{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip1"),
				},
			},
		}},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

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. Generated from API version 2022-05-01 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 (GetLoadBalancer)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "lb", &armnetwork.LoadBalancersClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetLoadBalancerWithInboundNatRulePortMapping)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerGetInboundNatRulePortMapping.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "lb", &armnetwork.LoadBalancersClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LoadBalancersClient) NewListAllPager

NewListAllPager - Gets all the load balancers in a subscription. Generated from API version 2022-05-01 options - LoadBalancersClientListAllOptions contains the optional parameters for the LoadBalancersClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*LoadBalancersClient) NewListPager

func (client *LoadBalancersClient) NewListPager(resourceGroupName string, options *LoadBalancersClientListOptions) *runtime.Pager[LoadBalancersClientListResponse]

NewListPager - Gets all the load balancers in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - LoadBalancersClientListOptions contains the optional parameters for the LoadBalancersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LoadBalancerUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLoadBalancersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "lb", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type LoadBalancersClientBeginCreateOrUpdateOptions

type LoadBalancersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LoadBalancersClientBeginCreateOrUpdateOptions contains the optional parameters for the LoadBalancersClient.BeginCreateOrUpdate method.

type LoadBalancersClientBeginDeleteOptions

type LoadBalancersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LoadBalancersClientBeginDeleteOptions contains the optional parameters for the LoadBalancersClient.BeginDelete method.

type LoadBalancersClientBeginListInboundNatRulePortMappingsOptions

type LoadBalancersClientBeginListInboundNatRulePortMappingsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LoadBalancersClientBeginListInboundNatRulePortMappingsOptions contains the optional parameters for the LoadBalancersClient.BeginListInboundNatRulePortMappings method.

type LoadBalancersClientBeginSwapPublicIPAddressesOptions

type LoadBalancersClientBeginSwapPublicIPAddressesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LoadBalancersClientBeginSwapPublicIPAddressesOptions contains the optional parameters for the LoadBalancersClient.BeginSwapPublicIPAddresses method.

type LoadBalancersClientCreateOrUpdateResponse

type LoadBalancersClientCreateOrUpdateResponse struct {
	LoadBalancer
}

LoadBalancersClientCreateOrUpdateResponse contains the response from method LoadBalancersClient.CreateOrUpdate.

type LoadBalancersClientDeleteResponse

type LoadBalancersClientDeleteResponse struct {
}

LoadBalancersClientDeleteResponse contains the response from method LoadBalancersClient.Delete.

type LoadBalancersClientGetOptions

type LoadBalancersClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

LoadBalancersClientGetOptions contains the optional parameters for the LoadBalancersClient.Get method.

type LoadBalancersClientGetResponse

type LoadBalancersClientGetResponse struct {
	LoadBalancer
}

LoadBalancersClientGetResponse contains the response from method LoadBalancersClient.Get.

type LoadBalancersClientListAllOptions

type LoadBalancersClientListAllOptions struct {
}

LoadBalancersClientListAllOptions contains the optional parameters for the LoadBalancersClient.ListAll method.

type LoadBalancersClientListAllResponse

type LoadBalancersClientListAllResponse struct {
	LoadBalancerListResult
}

LoadBalancersClientListAllResponse contains the response from method LoadBalancersClient.ListAll.

type LoadBalancersClientListInboundNatRulePortMappingsResponse

type LoadBalancersClientListInboundNatRulePortMappingsResponse struct {
	BackendAddressInboundNatRulePortMappings
}

LoadBalancersClientListInboundNatRulePortMappingsResponse contains the response from method LoadBalancersClient.ListInboundNatRulePortMappings.

type LoadBalancersClientListOptions

type LoadBalancersClientListOptions struct {
}

LoadBalancersClientListOptions contains the optional parameters for the LoadBalancersClient.List method.

type LoadBalancersClientListResponse

type LoadBalancersClientListResponse struct {
	LoadBalancerListResult
}

LoadBalancersClientListResponse contains the response from method LoadBalancersClient.List.

type LoadBalancersClientSwapPublicIPAddressesResponse

type LoadBalancersClientSwapPublicIPAddressesResponse struct {
}

LoadBalancersClientSwapPublicIPAddressesResponse contains the response from method LoadBalancersClient.SwapPublicIPAddresses.

type LoadBalancersClientUpdateTagsOptions

type LoadBalancersClientUpdateTagsOptions struct {
}

LoadBalancersClientUpdateTagsOptions contains the optional parameters for the LoadBalancersClient.UpdateTags method.

type LoadBalancersClientUpdateTagsResponse

type LoadBalancersClientUpdateTagsResponse struct {
	LoadBalancer
}

LoadBalancersClientUpdateTagsResponse contains the response 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.

func (LoadBalancingRule) MarshalJSON

func (l LoadBalancingRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LoadBalancingRule.

func (*LoadBalancingRule) UnmarshalJSON

func (l *LoadBalancingRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LoadBalancingRule.

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.

func (*LoadBalancingRulePropertiesFormat) UnmarshalJSON

func (l *LoadBalancingRulePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (*LocalNetworkGateway) UnmarshalJSON

func (l *LocalNetworkGateway) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*LocalNetworkGatewayListResult) UnmarshalJSON

func (l *LocalNetworkGatewayListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (LocalNetworkGatewayPropertiesFormat) MarshalJSON

func (l LocalNetworkGatewayPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocalNetworkGatewayPropertiesFormat.

func (*LocalNetworkGatewayPropertiesFormat) UnmarshalJSON

func (l *LocalNetworkGatewayPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LocalNetworkGatewayPropertiesFormat.

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, error)

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

BeginCreateOrUpdate - Creates or updates a local network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LocalNetworkGatewayCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLocalNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "localgw", armnetwork.LocalNetworkGateway{
	Location: to.Ptr("Central US"),
	Properties: &armnetwork.LocalNetworkGatewayPropertiesFormat{
		Fqdn:             to.Ptr("site1.contoso.com"),
		GatewayIPAddress: to.Ptr("11.12.13.14"),
		LocalNetworkAddressSpace: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("10.1.0.0/16")},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LocalNetworkGatewaysClient) BeginDelete

BeginDelete - Deletes the specified local network gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LocalNetworkGatewayDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLocalNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "localgw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LocalNetworkGatewayGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLocalNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "localgw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*LocalNetworkGatewaysClient) NewListPager

NewListPager - Gets all the local network gateways in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - LocalNetworkGatewaysClientListOptions contains the optional parameters for the LocalNetworkGatewaysClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LocalNetworkGatewayList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLocalNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/LocalNetworkGatewayUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewLocalNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "lgw", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type LocalNetworkGatewaysClientBeginCreateOrUpdateOptions

type LocalNetworkGatewaysClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LocalNetworkGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the LocalNetworkGatewaysClient.BeginCreateOrUpdate method.

type LocalNetworkGatewaysClientBeginDeleteOptions

type LocalNetworkGatewaysClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

LocalNetworkGatewaysClientBeginDeleteOptions contains the optional parameters for the LocalNetworkGatewaysClient.BeginDelete method.

type LocalNetworkGatewaysClientCreateOrUpdateResponse

type LocalNetworkGatewaysClientCreateOrUpdateResponse struct {
	LocalNetworkGateway
}

LocalNetworkGatewaysClientCreateOrUpdateResponse contains the response from method LocalNetworkGatewaysClient.CreateOrUpdate.

type LocalNetworkGatewaysClientDeleteResponse

type LocalNetworkGatewaysClientDeleteResponse struct {
}

LocalNetworkGatewaysClientDeleteResponse contains the response from method LocalNetworkGatewaysClient.Delete.

type LocalNetworkGatewaysClientGetOptions

type LocalNetworkGatewaysClientGetOptions struct {
}

LocalNetworkGatewaysClientGetOptions contains the optional parameters for the LocalNetworkGatewaysClient.Get method.

type LocalNetworkGatewaysClientGetResponse

type LocalNetworkGatewaysClientGetResponse struct {
	LocalNetworkGateway
}

LocalNetworkGatewaysClientGetResponse contains the response from method LocalNetworkGatewaysClient.Get.

type LocalNetworkGatewaysClientListOptions

type LocalNetworkGatewaysClientListOptions struct {
}

LocalNetworkGatewaysClientListOptions contains the optional parameters for the LocalNetworkGatewaysClient.List method.

type LocalNetworkGatewaysClientListResponse

type LocalNetworkGatewaysClientListResponse struct {
	LocalNetworkGatewayListResult
}

LocalNetworkGatewaysClientListResponse contains the response from method LocalNetworkGatewaysClient.List.

type LocalNetworkGatewaysClientUpdateTagsOptions

type LocalNetworkGatewaysClientUpdateTagsOptions struct {
}

LocalNetworkGatewaysClientUpdateTagsOptions contains the optional parameters for the LocalNetworkGatewaysClient.UpdateTags method.

type LocalNetworkGatewaysClientUpdateTagsResponse

type LocalNetworkGatewaysClientUpdateTagsResponse struct {
	LocalNetworkGateway
}

LocalNetworkGatewaysClientUpdateTagsResponse contains the response 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.

func (LogSpecification) MarshalJSON

func (l LogSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LogSpecification.

func (*LogSpecification) UnmarshalJSON

func (l *LogSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LogSpecification.

type ManagedRuleEnabledState

type ManagedRuleEnabledState string

ManagedRuleEnabledState - The state of the managed rule. Defaults to Disabled if not specified.

const (
	ManagedRuleEnabledStateDisabled ManagedRuleEnabledState = "Disabled"
	ManagedRuleEnabledStateEnabled  ManagedRuleEnabledState = "Enabled"
)

func PossibleManagedRuleEnabledStateValues

func PossibleManagedRuleEnabledStateValues() []ManagedRuleEnabledState

PossibleManagedRuleEnabledStateValues returns the possible values for the ManagedRuleEnabledState const type.

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.

func (*ManagedRuleGroupOverride) UnmarshalJSON

func (m *ManagedRuleGroupOverride) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedRuleGroupOverride.

type ManagedRuleOverride

type ManagedRuleOverride struct {
	// REQUIRED; Identifier for the managed rule.
	RuleID *string `json:"ruleId,omitempty"`

	// Describes the override action to be applied when rule matches.
	Action *ActionType `json:"action,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.

func (ManagedRuleOverride) MarshalJSON

func (m ManagedRuleOverride) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedRuleOverride.

func (*ManagedRuleOverride) UnmarshalJSON

func (m *ManagedRuleOverride) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedRuleOverride.

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.

func (*ManagedRuleSet) UnmarshalJSON

func (m *ManagedRuleSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ManagedRulesDefinition) UnmarshalJSON

func (m *ManagedRulesDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ManagedServiceIdentity) UnmarshalJSON

func (m *ManagedServiceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedServiceIdentity.

type ManagementClient

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

func NewManagementClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagementClient, error)

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.

BeginDeleteBastionShareableLink - Deletes the Bastion Shareable Links for all the VMs specified in the request. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGeneratevirtualwanvpnserverconfigurationvpnprofile(ctx, "rg1", "wan1", armnetwork.VirtualWanVPNProfileParameters{
	AuthenticationMethod:             to.Ptr(armnetwork.AuthenticationMethodEAPTLS),
	VPNServerConfigurationResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagementClient) BeginGetActiveSessions

func (client *ManagementClient) BeginGetActiveSessions(ctx context.Context, resourceGroupName string, bastionHostName string, options *ManagementClientBeginGetActiveSessionsOptions) (*runtime.Poller[*runtime.Pager[ManagementClientGetActiveSessionsResponse]], error)

BeginGetActiveSessions - Returns the list of currently active sessions on the Bastion. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/BastionSessionsList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetActiveSessions(ctx, "rg1", "bastionhosttenant", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
for res.More() {
	nextResult, err := res.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

BeginPutBastionShareableLink - Creates a Bastion Shareable Links for all the VMs specified in the request. Generated from API version 2022-05-01 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

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. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CheckDnsNameAvailability.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CheckDNSNameAvailability(ctx, "westus", "testdns", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagementClient) ExpressRouteProviderPort

ExpressRouteProviderPort - Retrieves detail of a provider port. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 providerport - The name of the provider port. options - ManagementClientExpressRouteProviderPortOptions contains the optional parameters for the ManagementClient.ExpressRouteProviderPort method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/expressRouteProviderPort.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ExpressRouteProviderPort(ctx, "abc", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagementClient) ListActiveConnectivityConfigurations

func (client *ManagementClient) ListActiveConnectivityConfigurations(ctx context.Context, resourceGroupName string, networkManagerName string, parameters ActiveConfigurationParameter, options *ManagementClientListActiveConnectivityConfigurationsOptions) (ManagementClientListActiveConnectivityConfigurationsResponse, error)

ListActiveConnectivityConfigurations - Lists active connectivity configurations in a network manager. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. parameters - Active Configuration Parameter. options - ManagementClientListActiveConnectivityConfigurationsOptions contains the optional parameters for the ManagementClient.ListActiveConnectivityConfigurations method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerActiveConnectivityConfigurationsList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListActiveConnectivityConfigurations(ctx, "myResourceGroup", "testNetworkManager", armnetwork.ActiveConfigurationParameter{
	Regions: []*string{
		to.Ptr("westus")},
	SkipToken: to.Ptr("fakeSkipTokenCode"),
}, &armnetwork.ManagementClientListActiveConnectivityConfigurationsOptions{Top: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagementClient) ListActiveSecurityAdminRules

func (client *ManagementClient) ListActiveSecurityAdminRules(ctx context.Context, resourceGroupName string, networkManagerName string, parameters ActiveConfigurationParameter, options *ManagementClientListActiveSecurityAdminRulesOptions) (ManagementClientListActiveSecurityAdminRulesResponse, error)

ListActiveSecurityAdminRules - Lists active security admin rules in a network manager. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. parameters - Active Configuration Parameter. options - ManagementClientListActiveSecurityAdminRulesOptions contains the optional parameters for the ManagementClient.ListActiveSecurityAdminRules method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerActiveSecurityAdminRulesList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListActiveSecurityAdminRules(ctx, "myResourceGroup", "testNetworkManager", armnetwork.ActiveConfigurationParameter{
	Regions: []*string{
		to.Ptr("westus")},
	SkipToken: to.Ptr("fakeSkipTokenCode"),
}, &armnetwork.ManagementClientListActiveSecurityAdminRulesOptions{Top: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagementClient) ListNetworkManagerEffectiveConnectivityConfigurations

func (client *ManagementClient) ListNetworkManagerEffectiveConnectivityConfigurations(ctx context.Context, resourceGroupName string, virtualNetworkName string, parameters QueryRequestOptions, options *ManagementClientListNetworkManagerEffectiveConnectivityConfigurationsOptions) (ManagementClientListNetworkManagerEffectiveConnectivityConfigurationsResponse, error)

ListNetworkManagerEffectiveConnectivityConfigurations - List all effective connectivity configurations applied on a virtual network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. parameters - Parameters supplied to list correct page. options - ManagementClientListNetworkManagerEffectiveConnectivityConfigurationsOptions contains the optional parameters for the ManagementClient.ListNetworkManagerEffectiveConnectivityConfigurations method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerEffectiveConnectivityConfigurationsList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListNetworkManagerEffectiveConnectivityConfigurations(ctx, "myResourceGroup", "testVirtualNetwork", armnetwork.QueryRequestOptions{
	SkipToken: to.Ptr("FakeSkipTokenCode"),
}, &armnetwork.ManagementClientListNetworkManagerEffectiveConnectivityConfigurationsOptions{Top: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagementClient) ListNetworkManagerEffectiveSecurityAdminRules

func (client *ManagementClient) ListNetworkManagerEffectiveSecurityAdminRules(ctx context.Context, resourceGroupName string, virtualNetworkName string, parameters QueryRequestOptions, options *ManagementClientListNetworkManagerEffectiveSecurityAdminRulesOptions) (ManagementClientListNetworkManagerEffectiveSecurityAdminRulesResponse, error)

ListNetworkManagerEffectiveSecurityAdminRules - List all effective security admin rules applied on a virtual network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. parameters - Parameters supplied to list correct page. options - ManagementClientListNetworkManagerEffectiveSecurityAdminRulesOptions contains the optional parameters for the ManagementClient.ListNetworkManagerEffectiveSecurityAdminRules method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerEffectiveSecurityAdminRulesList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.ListNetworkManagerEffectiveSecurityAdminRules(ctx, "myResourceGroup", "testVirtualNetwork", armnetwork.QueryRequestOptions{
	SkipToken: to.Ptr("FakeSkipTokenCode"),
}, &armnetwork.ManagementClientListNetworkManagerEffectiveSecurityAdminRulesOptions{Top: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagementClient) NewDisconnectActiveSessionsPager

func (client *ManagementClient) NewDisconnectActiveSessionsPager(resourceGroupName string, bastionHostName string, sessionIDs SessionIDs, options *ManagementClientDisconnectActiveSessionsOptions) *runtime.Pager[ManagementClientDisconnectActiveSessionsResponse]

NewDisconnectActiveSessionsPager - Returns the list of currently active sessions on the Bastion. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/BastionSessionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewDisconnectActiveSessionsPager("rg1", "bastionhosttenant", armnetwork.SessionIDs{}, nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ManagementClient) NewGetBastionShareableLinkPager

func (client *ManagementClient) NewGetBastionShareableLinkPager(resourceGroupName string, bastionHostName string, bslRequest BastionShareableLinkListRequest, options *ManagementClientGetBastionShareableLinkOptions) *runtime.Pager[ManagementClientGetBastionShareableLinkResponse]

NewGetBastionShareableLinkPager - Return the Bastion Shareable Links for all the VMs specified in the request. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/BastionShareableLinkGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewGetBastionShareableLinkPager("rg1", "bastionhosttenant", armnetwork.BastionShareableLinkListRequest{
	VMs: []*armnetwork.BastionShareableLink{
		{
			VM: &armnetwork.VM{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1"),
			},
		},
		{
			VM: &armnetwork.VM{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2"),
			},
		}},
}, nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ManagementClient) SupportedSecurityProviders

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualWanSupportedSecurityProviders.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.SupportedSecurityProviders(ctx, "rg1", "wan1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ManagementClientBeginDeleteBastionShareableLinkOptions

type ManagementClientBeginDeleteBastionShareableLinkOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ManagementClientBeginDeleteBastionShareableLinkOptions contains the optional parameters for the ManagementClient.BeginDeleteBastionShareableLink method.

type ManagementClientBeginGeneratevirtualwanvpnserverconfigurationvpnprofileOptions

type ManagementClientBeginGeneratevirtualwanvpnserverconfigurationvpnprofileOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ManagementClientBeginGeneratevirtualwanvpnserverconfigurationvpnprofileOptions contains the optional parameters for the ManagementClient.BeginGeneratevirtualwanvpnserverconfigurationvpnprofile method.

type ManagementClientBeginGetActiveSessionsOptions

type ManagementClientBeginGetActiveSessionsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ManagementClientBeginGetActiveSessionsOptions contains the optional parameters for the ManagementClient.BeginGetActiveSessions method.

type ManagementClientBeginPutBastionShareableLinkOptions

type ManagementClientBeginPutBastionShareableLinkOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ManagementClientBeginPutBastionShareableLinkOptions contains the optional parameters for the ManagementClient.BeginPutBastionShareableLink method.

type ManagementClientCheckDNSNameAvailabilityOptions

type ManagementClientCheckDNSNameAvailabilityOptions struct {
}

ManagementClientCheckDNSNameAvailabilityOptions contains the optional parameters for the ManagementClient.CheckDNSNameAvailability method.

type ManagementClientCheckDNSNameAvailabilityResponse

type ManagementClientCheckDNSNameAvailabilityResponse struct {
	DNSNameAvailabilityResult
}

ManagementClientCheckDNSNameAvailabilityResponse contains the response from method ManagementClient.CheckDNSNameAvailability.

type ManagementClientDeleteBastionShareableLinkResponse

type ManagementClientDeleteBastionShareableLinkResponse struct {
}

ManagementClientDeleteBastionShareableLinkResponse contains the response from method ManagementClient.DeleteBastionShareableLink.

type ManagementClientDisconnectActiveSessionsOptions

type ManagementClientDisconnectActiveSessionsOptions struct {
}

ManagementClientDisconnectActiveSessionsOptions contains the optional parameters for the ManagementClient.DisconnectActiveSessions method.

type ManagementClientDisconnectActiveSessionsResponse

type ManagementClientDisconnectActiveSessionsResponse struct {
	BastionSessionDeleteResult
}

ManagementClientDisconnectActiveSessionsResponse contains the response from method ManagementClient.DisconnectActiveSessions.

type ManagementClientExpressRouteProviderPortOptions

type ManagementClientExpressRouteProviderPortOptions struct {
}

ManagementClientExpressRouteProviderPortOptions contains the optional parameters for the ManagementClient.ExpressRouteProviderPort method.

type ManagementClientExpressRouteProviderPortResponse

type ManagementClientExpressRouteProviderPortResponse struct {
	ExpressRouteProviderPort
}

ManagementClientExpressRouteProviderPortResponse contains the response from method ManagementClient.ExpressRouteProviderPort.

type ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResponse

type ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResponse struct {
	VPNProfileResponse
}

ManagementClientGeneratevirtualwanvpnserverconfigurationvpnprofileResponse contains the response from method ManagementClient.Generatevirtualwanvpnserverconfigurationvpnprofile.

type ManagementClientGetActiveSessionsResponse

type ManagementClientGetActiveSessionsResponse struct {
	BastionActiveSessionListResult
}

ManagementClientGetActiveSessionsResponse contains the response from method ManagementClient.GetActiveSessions.

type ManagementClientGetBastionShareableLinkOptions

type ManagementClientGetBastionShareableLinkOptions struct {
}

ManagementClientGetBastionShareableLinkOptions contains the optional parameters for the ManagementClient.GetBastionShareableLink method.

type ManagementClientGetBastionShareableLinkResponse

type ManagementClientGetBastionShareableLinkResponse struct {
	BastionShareableLinkListResult
}

ManagementClientGetBastionShareableLinkResponse contains the response from method ManagementClient.GetBastionShareableLink.

type ManagementClientListActiveConnectivityConfigurationsOptions

type ManagementClientListActiveConnectivityConfigurationsOptions struct {
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

ManagementClientListActiveConnectivityConfigurationsOptions contains the optional parameters for the ManagementClient.ListActiveConnectivityConfigurations method.

type ManagementClientListActiveConnectivityConfigurationsResponse

type ManagementClientListActiveConnectivityConfigurationsResponse struct {
	ActiveConnectivityConfigurationsListResult
}

ManagementClientListActiveConnectivityConfigurationsResponse contains the response from method ManagementClient.ListActiveConnectivityConfigurations.

type ManagementClientListActiveSecurityAdminRulesOptions

type ManagementClientListActiveSecurityAdminRulesOptions struct {
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

ManagementClientListActiveSecurityAdminRulesOptions contains the optional parameters for the ManagementClient.ListActiveSecurityAdminRules method.

type ManagementClientListActiveSecurityAdminRulesResponse

type ManagementClientListActiveSecurityAdminRulesResponse struct {
	ActiveSecurityAdminRulesListResult
}

ManagementClientListActiveSecurityAdminRulesResponse contains the response from method ManagementClient.ListActiveSecurityAdminRules.

type ManagementClientListNetworkManagerEffectiveConnectivityConfigurationsOptions

type ManagementClientListNetworkManagerEffectiveConnectivityConfigurationsOptions struct {
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

ManagementClientListNetworkManagerEffectiveConnectivityConfigurationsOptions contains the optional parameters for the ManagementClient.ListNetworkManagerEffectiveConnectivityConfigurations method.

type ManagementClientListNetworkManagerEffectiveConnectivityConfigurationsResponse

type ManagementClientListNetworkManagerEffectiveConnectivityConfigurationsResponse struct {
	ManagerEffectiveConnectivityConfigurationListResult
}

ManagementClientListNetworkManagerEffectiveConnectivityConfigurationsResponse contains the response from method ManagementClient.ListNetworkManagerEffectiveConnectivityConfigurations.

type ManagementClientListNetworkManagerEffectiveSecurityAdminRulesOptions

type ManagementClientListNetworkManagerEffectiveSecurityAdminRulesOptions struct {
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

ManagementClientListNetworkManagerEffectiveSecurityAdminRulesOptions contains the optional parameters for the ManagementClient.ListNetworkManagerEffectiveSecurityAdminRules method.

type ManagementClientListNetworkManagerEffectiveSecurityAdminRulesResponse

type ManagementClientListNetworkManagerEffectiveSecurityAdminRulesResponse struct {
	ManagerEffectiveSecurityAdminRulesListResult
}

ManagementClientListNetworkManagerEffectiveSecurityAdminRulesResponse contains the response from method ManagementClient.ListNetworkManagerEffectiveSecurityAdminRules.

type ManagementClientPutBastionShareableLinkResponse

type ManagementClientPutBastionShareableLinkResponse struct {
	BastionShareableLinkListResult
}

ManagementClientPutBastionShareableLinkResponse contains the response from method ManagementClient.PutBastionShareableLink.

type ManagementClientSupportedSecurityProvidersOptions

type ManagementClientSupportedSecurityProvidersOptions struct {
}

ManagementClientSupportedSecurityProvidersOptions contains the optional parameters for the ManagementClient.SupportedSecurityProviders method.

type ManagementClientSupportedSecurityProvidersResponse

type ManagementClientSupportedSecurityProvidersResponse struct {
	VirtualWanSecurityProviders
}

ManagementClientSupportedSecurityProvidersResponse contains the response from method ManagementClient.SupportedSecurityProviders.

type ManagementGroupNetworkManagerConnectionsClient

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

ManagementGroupNetworkManagerConnectionsClient contains the methods for the ManagementGroupNetworkManagerConnections group. Don't use this type directly, use NewManagementGroupNetworkManagerConnectionsClient() instead.

func NewManagementGroupNetworkManagerConnectionsClient

func NewManagementGroupNetworkManagerConnectionsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagementGroupNetworkManagerConnectionsClient, error)

NewManagementGroupNetworkManagerConnectionsClient creates a new instance of ManagementGroupNetworkManagerConnectionsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ManagementGroupNetworkManagerConnectionsClient) CreateOrUpdate

CreateOrUpdate - Create a network manager connection on this management group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 managementGroupID - The management group Id which uniquely identify the Microsoft Azure management group. networkManagerConnectionName - Name for the network manager connection. parameters - Network manager connection to be created/updated. options - ManagementGroupNetworkManagerConnectionsClientCreateOrUpdateOptions contains the optional parameters for the ManagementGroupNetworkManagerConnectionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectionManagementGroupPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementGroupNetworkManagerConnectionsClient(cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "managementGroupA", "TestNMConnection", armnetwork.ManagerConnection{
	Properties: &armnetwork.ManagerConnectionProperties{
		NetworkManagerID: to.Ptr("/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagementGroupNetworkManagerConnectionsClient) Delete

Delete - Delete specified pending connection created by this management group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 managementGroupID - The management group Id which uniquely identify the Microsoft Azure management group. networkManagerConnectionName - Name for the network manager connection. options - ManagementGroupNetworkManagerConnectionsClientDeleteOptions contains the optional parameters for the ManagementGroupNetworkManagerConnectionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectionManagementGroupDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementGroupNetworkManagerConnectionsClient(cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx, "managementGroupA", "TestNMConnection", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*ManagementGroupNetworkManagerConnectionsClient) Get

Get - Get a specified connection created by this management group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 managementGroupID - The management group Id which uniquely identify the Microsoft Azure management group. networkManagerConnectionName - Name for the network manager connection. options - ManagementGroupNetworkManagerConnectionsClientGetOptions contains the optional parameters for the ManagementGroupNetworkManagerConnectionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectionManagementGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementGroupNetworkManagerConnectionsClient(cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "managementGroupA", "TestNMConnection", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagementGroupNetworkManagerConnectionsClient) NewListPager

NewListPager - List all network manager connections created by this management group. Generated from API version 2022-05-01 managementGroupID - The management group Id which uniquely identify the Microsoft Azure management group. options - ManagementGroupNetworkManagerConnectionsClientListOptions contains the optional parameters for the ManagementGroupNetworkManagerConnectionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectionManagementGroupList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagementGroupNetworkManagerConnectionsClient(cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("managementGroupA", &armnetwork.ManagementGroupNetworkManagerConnectionsClientListOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ManagementGroupNetworkManagerConnectionsClientCreateOrUpdateOptions

type ManagementGroupNetworkManagerConnectionsClientCreateOrUpdateOptions struct {
}

ManagementGroupNetworkManagerConnectionsClientCreateOrUpdateOptions contains the optional parameters for the ManagementGroupNetworkManagerConnectionsClient.CreateOrUpdate method.

type ManagementGroupNetworkManagerConnectionsClientCreateOrUpdateResponse

type ManagementGroupNetworkManagerConnectionsClientCreateOrUpdateResponse struct {
	ManagerConnection
}

ManagementGroupNetworkManagerConnectionsClientCreateOrUpdateResponse contains the response from method ManagementGroupNetworkManagerConnectionsClient.CreateOrUpdate.

type ManagementGroupNetworkManagerConnectionsClientDeleteOptions

type ManagementGroupNetworkManagerConnectionsClientDeleteOptions struct {
}

ManagementGroupNetworkManagerConnectionsClientDeleteOptions contains the optional parameters for the ManagementGroupNetworkManagerConnectionsClient.Delete method.

type ManagementGroupNetworkManagerConnectionsClientDeleteResponse

type ManagementGroupNetworkManagerConnectionsClientDeleteResponse struct {
}

ManagementGroupNetworkManagerConnectionsClientDeleteResponse contains the response from method ManagementGroupNetworkManagerConnectionsClient.Delete.

type ManagementGroupNetworkManagerConnectionsClientGetOptions

type ManagementGroupNetworkManagerConnectionsClientGetOptions struct {
}

ManagementGroupNetworkManagerConnectionsClientGetOptions contains the optional parameters for the ManagementGroupNetworkManagerConnectionsClient.Get method.

type ManagementGroupNetworkManagerConnectionsClientGetResponse

type ManagementGroupNetworkManagerConnectionsClientGetResponse struct {
	ManagerConnection
}

ManagementGroupNetworkManagerConnectionsClientGetResponse contains the response from method ManagementGroupNetworkManagerConnectionsClient.Get.

type ManagementGroupNetworkManagerConnectionsClientListOptions

type ManagementGroupNetworkManagerConnectionsClientListOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

ManagementGroupNetworkManagerConnectionsClientListOptions contains the optional parameters for the ManagementGroupNetworkManagerConnectionsClient.List method.

type ManagementGroupNetworkManagerConnectionsClientListResponse

type ManagementGroupNetworkManagerConnectionsClientListResponse struct {
	ManagerConnectionListResult
}

ManagementGroupNetworkManagerConnectionsClientListResponse contains the response from method ManagementGroupNetworkManagerConnectionsClient.List.

type Manager

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

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

	// The network manager properties
	Properties *ManagerProperties `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; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

Manager - The Managed Network resource

func (Manager) MarshalJSON

func (m Manager) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Manager.

func (*Manager) UnmarshalJSON

func (m *Manager) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Manager.

type ManagerCommit

type ManagerCommit struct {
	// REQUIRED; Commit Type.
	CommitType *ConfigurationType `json:"commitType,omitempty"`

	// REQUIRED; List of target locations.
	TargetLocations []*string `json:"targetLocations,omitempty"`

	// List of configuration ids.
	ConfigurationIDs []*string `json:"configurationIds,omitempty"`

	// READ-ONLY; Commit Id.
	CommitID *string `json:"commitId,omitempty" azure:"ro"`
}

ManagerCommit - Network Manager Commit.

func (ManagerCommit) MarshalJSON

func (m ManagerCommit) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerCommit.

func (*ManagerCommit) UnmarshalJSON

func (m *ManagerCommit) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerCommit.

type ManagerCommitsClient

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

ManagerCommitsClient contains the methods for the NetworkManagerCommits group. Don't use this type directly, use NewManagerCommitsClient() instead.

func NewManagerCommitsClient

func NewManagerCommitsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagerCommitsClient, error)

NewManagerCommitsClient creates a new instance of ManagerCommitsClient 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 (*ManagerCommitsClient) BeginPost

func (client *ManagerCommitsClient) BeginPost(ctx context.Context, resourceGroupName string, networkManagerName string, parameters ManagerCommit, options *ManagerCommitsClientBeginPostOptions) (*runtime.Poller[ManagerCommitsClientPostResponse], error)

BeginPost - Post a Network Manager Commit. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. parameters - Parameters supplied to specify which Managed Network commit is. options - ManagerCommitsClientBeginPostOptions contains the optional parameters for the ManagerCommitsClient.BeginPost method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerCommitPost.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagerCommitsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginPost(ctx, "resoureGroupSample", "testNetworkManager", armnetwork.ManagerCommit{
	CommitType: to.Ptr(armnetwork.ConfigurationTypeSecurityAdmin),
	ConfigurationIDs: []*string{
		to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resoureGroupSample/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/SampleSecurityAdminConfig")},
	TargetLocations: []*string{
		to.Ptr("useast")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

type ManagerCommitsClientBeginPostOptions

type ManagerCommitsClientBeginPostOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ManagerCommitsClientBeginPostOptions contains the optional parameters for the ManagerCommitsClient.BeginPost method.

type ManagerCommitsClientPostResponse

type ManagerCommitsClientPostResponse struct {
	ManagerCommit
}

ManagerCommitsClientPostResponse contains the response from method ManagerCommitsClient.Post.

type ManagerConnection

type ManagerConnection struct {
	// The scope connection properties
	Properties *ManagerConnectionProperties `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 ID.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

ManagerConnection - The Network Manager Connection resource

func (ManagerConnection) MarshalJSON

func (m ManagerConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerConnection.

func (*ManagerConnection) UnmarshalJSON

func (m *ManagerConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerConnection.

type ManagerConnectionListResult

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

	// List of network manager connections.
	Value []*ManagerConnection `json:"value,omitempty"`
}

ManagerConnectionListResult - List of network manager connections.

func (ManagerConnectionListResult) MarshalJSON

func (m ManagerConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerConnectionListResult.

func (*ManagerConnectionListResult) UnmarshalJSON

func (m *ManagerConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerConnectionListResult.

type ManagerConnectionProperties

type ManagerConnectionProperties struct {
	// A description of the network manager connection.
	Description *string `json:"description,omitempty"`

	// Network Manager Id.
	NetworkManagerID *string `json:"networkManagerId,omitempty"`

	// READ-ONLY; Connection state.
	ConnectionState *ScopeConnectionState `json:"connectionState,omitempty" azure:"ro"`
}

ManagerConnectionProperties - Information about the network manager connection.

func (ManagerConnectionProperties) MarshalJSON

func (m ManagerConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerConnectionProperties.

func (*ManagerConnectionProperties) UnmarshalJSON

func (m *ManagerConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerConnectionProperties.

type ManagerDeploymentStatus

type ManagerDeploymentStatus struct {
	// Commit Time.
	CommitTime *time.Time `json:"commitTime,omitempty"`

	// List of configuration ids.
	ConfigurationIDs []*string `json:"configurationIds,omitempty"`

	// Deployment Status.
	DeploymentStatus *DeploymentStatus `json:"deploymentStatus,omitempty"`

	// Configuration Deployment Type.
	DeploymentType *ConfigurationType `json:"deploymentType,omitempty"`

	// Error Message.
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Region Name.
	Region *string `json:"region,omitempty"`
}

ManagerDeploymentStatus - Network Manager Deployment Status.

func (ManagerDeploymentStatus) MarshalJSON

func (m ManagerDeploymentStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerDeploymentStatus.

func (*ManagerDeploymentStatus) UnmarshalJSON

func (m *ManagerDeploymentStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerDeploymentStatus.

type ManagerDeploymentStatusClient

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

ManagerDeploymentStatusClient contains the methods for the NetworkManagerDeploymentStatus group. Don't use this type directly, use NewManagerDeploymentStatusClient() instead.

func NewManagerDeploymentStatusClient

func NewManagerDeploymentStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagerDeploymentStatusClient, error)

NewManagerDeploymentStatusClient creates a new instance of ManagerDeploymentStatusClient 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 (*ManagerDeploymentStatusClient) List

List - Post to List of Network Manager Deployment Status. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. parameters - Parameters supplied to specify which Managed Network deployment status is. options - ManagerDeploymentStatusClientListOptions contains the optional parameters for the ManagerDeploymentStatusClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerDeploymentStatusList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagerDeploymentStatusClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx, "resoureGroupSample", "testNetworkManager", armnetwork.ManagerDeploymentStatusParameter{
	DeploymentTypes: []*armnetwork.ConfigurationType{
		to.Ptr(armnetwork.ConfigurationTypeConnectivity),
		to.Ptr(armnetwork.ConfigurationType("AdminPolicy"))},
	Regions: []*string{
		to.Ptr("eastus"),
		to.Ptr("westus")},
	SkipToken: to.Ptr("FakeSkipTokenCode"),
}, &armnetwork.ManagerDeploymentStatusClientListOptions{Top: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ManagerDeploymentStatusClientListOptions

type ManagerDeploymentStatusClientListOptions struct {
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

ManagerDeploymentStatusClientListOptions contains the optional parameters for the ManagerDeploymentStatusClient.List method.

type ManagerDeploymentStatusClientListResponse

type ManagerDeploymentStatusClientListResponse struct {
	ManagerDeploymentStatusListResult
}

ManagerDeploymentStatusClientListResponse contains the response from method ManagerDeploymentStatusClient.List.

type ManagerDeploymentStatusListResult

type ManagerDeploymentStatusListResult struct {
	// When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current
	// request) to retrieve the next page of data.
	SkipToken *string `json:"skipToken,omitempty"`

	// Gets a page of Network Manager Deployment Status
	Value []*ManagerDeploymentStatus `json:"value,omitempty"`
}

ManagerDeploymentStatusListResult - A list of Network Manager Deployment Status

func (ManagerDeploymentStatusListResult) MarshalJSON

func (m ManagerDeploymentStatusListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerDeploymentStatusListResult.

func (*ManagerDeploymentStatusListResult) UnmarshalJSON

func (m *ManagerDeploymentStatusListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerDeploymentStatusListResult.

type ManagerDeploymentStatusParameter

type ManagerDeploymentStatusParameter struct {
	// List of deployment types.
	DeploymentTypes []*ConfigurationType `json:"deploymentTypes,omitempty"`

	// List of locations.
	Regions []*string `json:"regions,omitempty"`

	// Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
	SkipToken *string `json:"skipToken,omitempty"`
}

ManagerDeploymentStatusParameter - Network Manager Deployment Status Parameter.

func (ManagerDeploymentStatusParameter) MarshalJSON

func (m ManagerDeploymentStatusParameter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerDeploymentStatusParameter.

func (*ManagerDeploymentStatusParameter) UnmarshalJSON

func (m *ManagerDeploymentStatusParameter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerDeploymentStatusParameter.

type ManagerEffectiveConnectivityConfigurationListResult

type ManagerEffectiveConnectivityConfigurationListResult struct {
	// When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current
	// request) to retrieve the next page of data.
	SkipToken *string `json:"skipToken,omitempty"`

	// Gets a page of NetworkManagerEffectiveConnectivityConfiguration
	Value []*EffectiveConnectivityConfiguration `json:"value,omitempty"`
}

ManagerEffectiveConnectivityConfigurationListResult - Result of the request to list networkManagerEffectiveConnectivityConfiguration. It contains a list of groups and a skiptoken to get the next set of results.

func (ManagerEffectiveConnectivityConfigurationListResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ManagerEffectiveConnectivityConfigurationListResult.

func (*ManagerEffectiveConnectivityConfigurationListResult) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerEffectiveConnectivityConfigurationListResult.

type ManagerEffectiveSecurityAdminRulesListResult

type ManagerEffectiveSecurityAdminRulesListResult struct {
	// When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current
	// request) to retrieve the next page of data.
	SkipToken *string `json:"skipToken,omitempty"`

	// Gets a page of NetworkManagerEffectiveSecurityAdminRules
	Value []EffectiveBaseSecurityAdminRuleClassification `json:"value,omitempty"`
}

ManagerEffectiveSecurityAdminRulesListResult - Result of the request to list networkManagerEffectiveSecurityAdminRules. It contains a list of groups and a skiptoken to get the next set of results.

func (ManagerEffectiveSecurityAdminRulesListResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ManagerEffectiveSecurityAdminRulesListResult.

func (*ManagerEffectiveSecurityAdminRulesListResult) UnmarshalJSON

func (m *ManagerEffectiveSecurityAdminRulesListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerEffectiveSecurityAdminRulesListResult.

type ManagerListResult

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

	// Gets a page of NetworkManager
	Value []*Manager `json:"value,omitempty"`
}

ManagerListResult - Result of the request to list NetworkManager. It contains a list of network managers and a URL link to get the next set of results.

func (ManagerListResult) MarshalJSON

func (m ManagerListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerListResult.

func (*ManagerListResult) UnmarshalJSON

func (m *ManagerListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerListResult.

type ManagerProperties

type ManagerProperties struct {
	// REQUIRED; Scope Access.
	NetworkManagerScopeAccesses []*ConfigurationType `json:"networkManagerScopeAccesses,omitempty"`

	// REQUIRED; Scope of Network Manager.
	NetworkManagerScopes *ManagerPropertiesNetworkManagerScopes `json:"networkManagerScopes,omitempty"`

	// A description of the network manager.
	Description *string `json:"description,omitempty"`

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

ManagerProperties - Properties of Managed Network

func (ManagerProperties) MarshalJSON

func (m ManagerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerProperties.

func (*ManagerProperties) UnmarshalJSON

func (m *ManagerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerProperties.

type ManagerPropertiesNetworkManagerScopes

type ManagerPropertiesNetworkManagerScopes struct {
	// List of management groups.
	ManagementGroups []*string `json:"managementGroups,omitempty"`

	// List of subscriptions.
	Subscriptions []*string `json:"subscriptions,omitempty"`

	// READ-ONLY; List of cross tenant scopes.
	CrossTenantScopes []*CrossTenantScopes `json:"crossTenantScopes,omitempty" azure:"ro"`
}

ManagerPropertiesNetworkManagerScopes - Scope of Network Manager.

func (ManagerPropertiesNetworkManagerScopes) MarshalJSON

func (m ManagerPropertiesNetworkManagerScopes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerPropertiesNetworkManagerScopes.

func (*ManagerPropertiesNetworkManagerScopes) UnmarshalJSON

func (m *ManagerPropertiesNetworkManagerScopes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerPropertiesNetworkManagerScopes.

type ManagerSecurityGroupItem

type ManagerSecurityGroupItem struct {
	// REQUIRED; Network manager group Id.
	NetworkGroupID *string `json:"networkGroupId,omitempty"`
}

ManagerSecurityGroupItem - Network manager security group item.

func (ManagerSecurityGroupItem) MarshalJSON

func (m ManagerSecurityGroupItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagerSecurityGroupItem.

func (*ManagerSecurityGroupItem) UnmarshalJSON

func (m *ManagerSecurityGroupItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagerSecurityGroupItem.

type ManagersClient

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

ManagersClient contains the methods for the NetworkManagers group. Don't use this type directly, use NewManagersClient() instead.

func NewManagersClient

func NewManagersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagersClient, error)

NewManagersClient creates a new instance of ManagersClient 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 (*ManagersClient) BeginDelete

func (client *ManagersClient) BeginDelete(ctx context.Context, resourceGroupName string, networkManagerName string, options *ManagersClientBeginDeleteOptions) (*runtime.Poller[ManagersClientDeleteResponse], error)

BeginDelete - Deletes a network manager. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. options - ManagersClientBeginDeleteOptions contains the optional parameters for the ManagersClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagersClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testNetworkManager", &armnetwork.ManagersClientBeginDeleteOptions{Force: to.Ptr(false)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ManagersClient) CreateOrUpdate

func (client *ManagersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkManagerName string, parameters Manager, options *ManagersClientCreateOrUpdateOptions) (ManagersClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a Network Manager. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. parameters - Parameters supplied to specify which network manager is. options - ManagersClientCreateOrUpdateOptions contains the optional parameters for the ManagersClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagersClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "TestNetworkManager", armnetwork.Manager{
	Properties: &armnetwork.ManagerProperties{
		Description: to.Ptr("My Test Network Manager"),
		NetworkManagerScopeAccesses: []*armnetwork.ConfigurationType{
			to.Ptr(armnetwork.ConfigurationTypeConnectivity)},
		NetworkManagerScopes: &armnetwork.ManagerPropertiesNetworkManagerScopes{
			ManagementGroups: []*string{
				to.Ptr("/Microsoft.Management/testmg")},
			Subscriptions: []*string{
				to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000")},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagersClient) Get

func (client *ManagersClient) Get(ctx context.Context, resourceGroupName string, networkManagerName string, options *ManagersClientGetOptions) (ManagersClientGetResponse, error)

Get - Gets the specified Network Manager. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. options - ManagersClientGetOptions contains the optional parameters for the ManagersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagersClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testNetworkManager", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ManagersClient) NewListBySubscriptionPager

NewListBySubscriptionPager - List all network managers in a subscription. Generated from API version 2022-05-01 options - ManagersClientListBySubscriptionOptions contains the optional parameters for the ManagersClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagersClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListBySubscriptionPager(&armnetwork.ManagersClientListBySubscriptionOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ManagersClient) NewListPager

func (client *ManagersClient) NewListPager(resourceGroupName string, options *ManagersClientListOptions) *runtime.Pager[ManagersClientListResponse]

NewListPager - List network managers in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - ManagersClientListOptions contains the optional parameters for the ManagersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagersClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", &armnetwork.ManagersClientListOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ManagersClient) Patch

func (client *ManagersClient) Patch(ctx context.Context, resourceGroupName string, networkManagerName string, parameters PatchObject, options *ManagersClientPatchOptions) (ManagersClientPatchResponse, error)

Patch - Patch NetworkManager. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. parameters - Parameters supplied to specify which network manager is. options - ManagersClientPatchOptions contains the optional parameters for the ManagersClient.Patch method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerPatch.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewManagersClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Patch(ctx, "rg1", "testNetworkManager", armnetwork.PatchObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ManagersClientBeginDeleteOptions

type ManagersClientBeginDeleteOptions struct {
	// Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service
	// will do a cleanup deployment in the background, prior to the delete.
	Force *bool
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ManagersClientBeginDeleteOptions contains the optional parameters for the ManagersClient.BeginDelete method.

type ManagersClientCreateOrUpdateOptions

type ManagersClientCreateOrUpdateOptions struct {
}

ManagersClientCreateOrUpdateOptions contains the optional parameters for the ManagersClient.CreateOrUpdate method.

type ManagersClientCreateOrUpdateResponse

type ManagersClientCreateOrUpdateResponse struct {
	Manager
}

ManagersClientCreateOrUpdateResponse contains the response from method ManagersClient.CreateOrUpdate.

type ManagersClientDeleteResponse

type ManagersClientDeleteResponse struct {
}

ManagersClientDeleteResponse contains the response from method ManagersClient.Delete.

type ManagersClientGetOptions

type ManagersClientGetOptions struct {
}

ManagersClientGetOptions contains the optional parameters for the ManagersClient.Get method.

type ManagersClientGetResponse

type ManagersClientGetResponse struct {
	Manager
}

ManagersClientGetResponse contains the response from method ManagersClient.Get.

type ManagersClientListBySubscriptionOptions

type ManagersClientListBySubscriptionOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

ManagersClientListBySubscriptionOptions contains the optional parameters for the ManagersClient.ListBySubscription method.

type ManagersClientListBySubscriptionResponse

type ManagersClientListBySubscriptionResponse struct {
	ManagerListResult
}

ManagersClientListBySubscriptionResponse contains the response from method ManagersClient.ListBySubscription.

type ManagersClientListOptions

type ManagersClientListOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

ManagersClientListOptions contains the optional parameters for the ManagersClient.List method.

type ManagersClientListResponse

type ManagersClientListResponse struct {
	ManagerListResult
}

ManagersClientListResponse contains the response from method ManagersClient.List.

type ManagersClientPatchOptions

type ManagersClientPatchOptions struct {
}

ManagersClientPatchOptions contains the optional parameters for the ManagersClient.Patch method.

type ManagersClientPatchResponse

type ManagersClientPatchResponse struct {
	Manager
}

ManagersClientPatchResponse contains the response from method ManagersClient.Patch.

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.

func (*MatchCondition) UnmarshalJSON

func (m *MatchCondition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (MatchVariable) MarshalJSON

func (m MatchVariable) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MatchVariable.

func (*MatchVariable) UnmarshalJSON

func (m *MatchVariable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MatchVariable.

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.

func (MatchedRule) MarshalJSON

func (m MatchedRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MatchedRule.

func (*MatchedRule) UnmarshalJSON

func (m *MatchedRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MatchedRule.

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.

func (*MetricSpecification) UnmarshalJSON

func (m *MetricSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*NatGateway) UnmarshalJSON

func (n *NatGateway) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*NatGatewayListResult) UnmarshalJSON

func (n *NatGatewayListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*NatGatewayPropertiesFormat) UnmarshalJSON

func (n *NatGatewayPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NatGatewayPropertiesFormat.

type NatGatewaySKU

type NatGatewaySKU struct {
	// Name of Nat Gateway SKU.
	Name *NatGatewaySKUName `json:"name,omitempty"`
}

NatGatewaySKU - SKU of nat gateway.

func (NatGatewaySKU) MarshalJSON

func (n NatGatewaySKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NatGatewaySKU.

func (*NatGatewaySKU) UnmarshalJSON

func (n *NatGatewaySKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NatGatewaySKU.

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.

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, error)

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) (*runtime.Poller[NatGatewaysClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a nat gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NatGatewayCreateOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewNatGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-natgateway", armnetwork.NatGateway{
	Location: to.Ptr("westus"),
	Properties: &armnetwork.NatGatewayPropertiesFormat{
		PublicIPAddresses: []*armnetwork.SubResource{
			{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"),
			}},
		PublicIPPrefixes: []*armnetwork.SubResource{
			{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"),
			}},
	},
	SKU: &armnetwork.NatGatewaySKU{
		Name: to.Ptr(armnetwork.NatGatewaySKUNameStandard),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*NatGatewaysClient) BeginDelete

func (client *NatGatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, natGatewayName string, options *NatGatewaysClientBeginDeleteOptions) (*runtime.Poller[NatGatewaysClientDeleteResponse], error)

BeginDelete - Deletes the specified nat gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NatGatewayDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewNatGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-natGateway", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NatGatewayGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewNatGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "test-natGateway", &armnetwork.NatGatewaysClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*NatGatewaysClient) NewListAllPager

NewListAllPager - Gets all the Nat Gateways in a subscription. Generated from API version 2022-05-01 options - NatGatewaysClientListAllOptions contains the optional parameters for the NatGatewaysClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NatGatewayListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewNatGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*NatGatewaysClient) NewListPager

func (client *NatGatewaysClient) NewListPager(resourceGroupName string, options *NatGatewaysClientListOptions) *runtime.Pager[NatGatewaysClientListResponse]

NewListPager - Gets all nat gateways in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - NatGatewaysClientListOptions contains the optional parameters for the NatGatewaysClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NatGatewayList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewNatGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NatGatewayUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewNatGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-natGateway", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type NatGatewaysClientBeginCreateOrUpdateOptions

type NatGatewaysClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NatGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the NatGatewaysClient.BeginCreateOrUpdate method.

type NatGatewaysClientBeginDeleteOptions

type NatGatewaysClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NatGatewaysClientBeginDeleteOptions contains the optional parameters for the NatGatewaysClient.BeginDelete method.

type NatGatewaysClientCreateOrUpdateResponse

type NatGatewaysClientCreateOrUpdateResponse struct {
	NatGateway
}

NatGatewaysClientCreateOrUpdateResponse contains the response from method NatGatewaysClient.CreateOrUpdate.

type NatGatewaysClientDeleteResponse

type NatGatewaysClientDeleteResponse struct {
}

NatGatewaysClientDeleteResponse contains the response from method NatGatewaysClient.Delete.

type NatGatewaysClientGetOptions

type NatGatewaysClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

NatGatewaysClientGetOptions contains the optional parameters for the NatGatewaysClient.Get method.

type NatGatewaysClientGetResponse

type NatGatewaysClientGetResponse struct {
	NatGateway
}

NatGatewaysClientGetResponse contains the response from method NatGatewaysClient.Get.

type NatGatewaysClientListAllOptions

type NatGatewaysClientListAllOptions struct {
}

NatGatewaysClientListAllOptions contains the optional parameters for the NatGatewaysClient.ListAll method.

type NatGatewaysClientListAllResponse

type NatGatewaysClientListAllResponse struct {
	NatGatewayListResult
}

NatGatewaysClientListAllResponse contains the response from method NatGatewaysClient.ListAll.

type NatGatewaysClientListOptions

type NatGatewaysClientListOptions struct {
}

NatGatewaysClientListOptions contains the optional parameters for the NatGatewaysClient.List method.

type NatGatewaysClientListResponse

type NatGatewaysClientListResponse struct {
	NatGatewayListResult
}

NatGatewaysClientListResponse contains the response from method NatGatewaysClient.List.

type NatGatewaysClientUpdateTagsOptions

type NatGatewaysClientUpdateTagsOptions struct {
}

NatGatewaysClientUpdateTagsOptions contains the optional parameters for the NatGatewaysClient.UpdateTags method.

type NatGatewaysClientUpdateTagsResponse

type NatGatewaysClientUpdateTagsResponse struct {
	NatGateway
}

NatGatewaysClientUpdateTagsResponse contains the response 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

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

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.

func (NatRulePortMapping) MarshalJSON

func (n NatRulePortMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NatRulePortMapping.

func (*NatRulePortMapping) UnmarshalJSON

func (n *NatRulePortMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NatRulePortMapping.

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, error)

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) (*runtime.Poller[NatRulesClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NatRulePut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "gateway1", "natRule1", armnetwork.VPNGatewayNatRule{
	Properties: &armnetwork.VPNGatewayNatRuleProperties{
		Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
		ExternalMappings: []*armnetwork.VPNNatRuleMapping{
			{
				AddressSpace: to.Ptr("192.168.21.0/24"),
			}},
		InternalMappings: []*armnetwork.VPNNatRuleMapping{
			{
				AddressSpace: to.Ptr("10.4.0.0/24"),
			}},
		IPConfigurationID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default"),
		Mode:              to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*NatRulesClient) BeginDelete

func (client *NatRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, gatewayName string, natRuleName string, options *NatRulesClientBeginDeleteOptions) (*runtime.Poller[NatRulesClientDeleteResponse], error)

BeginDelete - Deletes a nat rule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NatRuleDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "gateway1", "natRule1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NatRuleGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "gateway1", "natRule1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*NatRulesClient) NewListByVPNGatewayPager

func (client *NatRulesClient) NewListByVPNGatewayPager(resourceGroupName string, gatewayName string, options *NatRulesClientListByVPNGatewayOptions) *runtime.Pager[NatRulesClientListByVPNGatewayResponse]

NewListByVPNGatewayPager - Retrieves all nat rules for a particular virtual wan vpn gateway. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NatRuleList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByVPNGatewayPager("rg1", "gateway1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type NatRulesClientBeginCreateOrUpdateOptions

type NatRulesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NatRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the NatRulesClient.BeginCreateOrUpdate method.

type NatRulesClientBeginDeleteOptions

type NatRulesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NatRulesClientBeginDeleteOptions contains the optional parameters for the NatRulesClient.BeginDelete method.

type NatRulesClientCreateOrUpdateResponse

type NatRulesClientCreateOrUpdateResponse struct {
	VPNGatewayNatRule
}

NatRulesClientCreateOrUpdateResponse contains the response from method NatRulesClient.CreateOrUpdate.

type NatRulesClientDeleteResponse

type NatRulesClientDeleteResponse struct {
}

NatRulesClientDeleteResponse contains the response from method NatRulesClient.Delete.

type NatRulesClientGetOptions

type NatRulesClientGetOptions struct {
}

NatRulesClientGetOptions contains the optional parameters for the NatRulesClient.Get method.

type NatRulesClientGetResponse

type NatRulesClientGetResponse struct {
	VPNGatewayNatRule
}

NatRulesClientGetResponse contains the response from method NatRulesClient.Get.

type NatRulesClientListByVPNGatewayOptions

type NatRulesClientListByVPNGatewayOptions struct {
}

NatRulesClientListByVPNGatewayOptions contains the optional parameters for the NatRulesClient.ListByVPNGateway method.

type NatRulesClientListByVPNGatewayResponse

type NatRulesClientListByVPNGatewayResponse struct {
	ListVPNGatewayNatRulesResult
}

NatRulesClientListByVPNGatewayResponse contains the response from method NatRulesClient.ListByVPNGateway.

type NetworkIntentPolicyBasedService

type NetworkIntentPolicyBasedService string

NetworkIntentPolicyBasedService - Network intent policy based services.

const (
	NetworkIntentPolicyBasedServiceAll            NetworkIntentPolicyBasedService = "All"
	NetworkIntentPolicyBasedServiceAllowRulesOnly NetworkIntentPolicyBasedService = "AllowRulesOnly"
	NetworkIntentPolicyBasedServiceNone           NetworkIntentPolicyBasedService = "None"
)

func PossibleNetworkIntentPolicyBasedServiceValues

func PossibleNetworkIntentPolicyBasedServiceValues() []NetworkIntentPolicyBasedService

PossibleNetworkIntentPolicyBasedServiceValues returns the possible values for the NetworkIntentPolicyBasedService const type.

type NetworkInterfaceAuxiliaryMode

type NetworkInterfaceAuxiliaryMode string

NetworkInterfaceAuxiliaryMode - Auxiliary mode of Network Interface resource.

const (
	NetworkInterfaceAuxiliaryModeFloating       NetworkInterfaceAuxiliaryMode = "Floating"
	NetworkInterfaceAuxiliaryModeMaxConnections NetworkInterfaceAuxiliaryMode = "MaxConnections"
	NetworkInterfaceAuxiliaryModeNone           NetworkInterfaceAuxiliaryMode = "None"
)

func PossibleNetworkInterfaceAuxiliaryModeValues

func PossibleNetworkInterfaceAuxiliaryModeValues() []NetworkInterfaceAuxiliaryMode

PossibleNetworkInterfaceAuxiliaryModeValues returns the possible values for the NetworkInterfaceAuxiliaryMode const type.

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.

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.

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.

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.

func (NextHopParameters) MarshalJSON

func (n NextHopParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NextHopParameters.

func (*NextHopParameters) UnmarshalJSON

func (n *NextHopParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NextHopParameters.

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.

func (NextHopResult) MarshalJSON

func (n NextHopResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NextHopResult.

func (*NextHopResult) UnmarshalJSON

func (n *NextHopResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NextHopResult.

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.

type NextStep

type NextStep string

NextStep - Supported next step behaviors after a rule is applied to a matched route

const (
	NextStepContinue  NextStep = "Continue"
	NextStepTerminate NextStep = "Terminate"
	NextStepUnknown   NextStep = "Unknown"
)

func PossibleNextStepValues

func PossibleNextStepValues() []NextStep

PossibleNextStepValues returns the possible values for the NextStep const type.

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.

func (O365BreakOutCategoryPolicies) MarshalJSON

func (o O365BreakOutCategoryPolicies) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type O365BreakOutCategoryPolicies.

func (*O365BreakOutCategoryPolicies) UnmarshalJSON

func (o *O365BreakOutCategoryPolicies) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type O365BreakOutCategoryPolicies.

type O365PolicyProperties

type O365PolicyProperties struct {
	// Office365 breakout categories.
	BreakOutCategories *O365BreakOutCategoryPolicies `json:"breakOutCategories,omitempty"`
}

O365PolicyProperties - The Office365 breakout policy.

func (O365PolicyProperties) MarshalJSON

func (o O365PolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type O365PolicyProperties.

func (*O365PolicyProperties) UnmarshalJSON

func (o *O365PolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type O365PolicyProperties.

type Office365PolicyProperties

type Office365PolicyProperties struct {
	// Office 365 breakout categories.
	BreakOutCategories *BreakOutCategoryPolicies `json:"breakOutCategories,omitempty"`
}

Office365PolicyProperties - Network Virtual Appliance Sku Properties.

func (Office365PolicyProperties) MarshalJSON

func (o Office365PolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Office365PolicyProperties.

func (*Office365PolicyProperties) UnmarshalJSON

func (o *Office365PolicyProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Office365PolicyProperties.

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.

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.

func (Operation) MarshalJSON

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

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.

func (OperationDisplay) MarshalJSON

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

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.

func (*OperationListResult) UnmarshalJSON

func (o *OperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationPropertiesFormat

type OperationPropertiesFormat struct {
	// Specification of the service.
	ServiceSpecification *OperationPropertiesFormatServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationPropertiesFormat - Description of operation properties format.

func (OperationPropertiesFormat) MarshalJSON

func (o OperationPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationPropertiesFormat.

func (*OperationPropertiesFormat) UnmarshalJSON

func (o *OperationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationPropertiesFormat.

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

MarshalJSON implements the json.Marshaller interface for type OperationPropertiesFormatServiceSpecification.

func (*OperationPropertiesFormatServiceSpecification) UnmarshalJSON

func (o *OperationPropertiesFormatServiceSpecification) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) NewListPager

NewListPager - Lists all of the available Network Rest API operations. Generated from API version 2022-05-01 options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/OperationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewOperationsClient(cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type OperationsClientListOptions

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse

type OperationsClientListResponse struct {
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OrderBy

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 *FirewallPolicyIDPSQuerySortOrder `json:"order,omitempty"`
}

OrderBy - Describes a column to sort

func (OrderBy) MarshalJSON

func (o OrderBy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OrderBy.

func (*OrderBy) UnmarshalJSON

func (o *OrderBy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OrderBy.

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.

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.

func (OutboundRule) MarshalJSON

func (o OutboundRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundRule.

func (*OutboundRule) UnmarshalJSON

func (o *OutboundRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OutboundRule.

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.

func (*OutboundRulePropertiesFormat) UnmarshalJSON

func (o *OutboundRulePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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

func (o OwaspCrsExclusionEntry) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OwaspCrsExclusionEntry.

func (*OwaspCrsExclusionEntry) UnmarshalJSON

func (o *OwaspCrsExclusionEntry) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

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.

func (P2SConnectionConfiguration) MarshalJSON

func (p P2SConnectionConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type P2SConnectionConfiguration.

func (*P2SConnectionConfiguration) UnmarshalJSON

func (p *P2SConnectionConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type P2SConnectionConfiguration.

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; List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.
	ConfigurationPolicyGroupAssociations []*SubResource `json:"configurationPolicyGroupAssociations,omitempty" azure:"ro"`

	// READ-ONLY; List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.
	PreviousConfigurationPolicyGroupAssociations []*VPNServerConfigurationPolicyGroup `json:"previousConfigurationPolicyGroupAssociations,omitempty" azure:"ro"`

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

P2SConnectionConfigurationProperties - Parameters for P2SConnectionConfiguration.

func (P2SConnectionConfigurationProperties) MarshalJSON

func (p P2SConnectionConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type P2SConnectionConfigurationProperties.

func (*P2SConnectionConfigurationProperties) UnmarshalJSON

func (p *P2SConnectionConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type P2SConnectionConfigurationProperties.

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.

func (P2SVPNConnectionHealth) MarshalJSON

func (p P2SVPNConnectionHealth) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type P2SVPNConnectionHealth.

func (*P2SVPNConnectionHealth) UnmarshalJSON

func (p *P2SVPNConnectionHealth) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type P2SVPNConnectionHealth.

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.

func (*P2SVPNConnectionHealthRequest) UnmarshalJSON

func (p *P2SVPNConnectionHealthRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*P2SVPNConnectionRequest) UnmarshalJSON

func (p *P2SVPNConnectionRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*P2SVPNGateway) UnmarshalJSON

func (p *P2SVPNGateway) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*P2SVPNGatewayProperties) UnmarshalJSON

func (p *P2SVPNGatewayProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[P2SVPNGatewaysClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2SVpnGatewayPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "p2sVpnGateway1", armnetwork.P2SVPNGateway{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.P2SVPNGatewayProperties{
		CustomDNSServers: []*string{
			to.Ptr("1.1.1.1"),
			to.Ptr("2.2.2.2")},
		IsRoutingPreferenceInternet: to.Ptr(false),
		P2SConnectionConfigurations: []*armnetwork.P2SConnectionConfiguration{
			{
				ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1"),
				Name: to.Ptr("P2SConnectionConfig1"),
				Properties: &armnetwork.P2SConnectionConfigurationProperties{
					RoutingConfiguration: &armnetwork.RoutingConfiguration{
						AssociatedRouteTable: &armnetwork.SubResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
						},
						PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
							IDs: []*armnetwork.SubResource{
								{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
								},
								{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2"),
								},
								{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3"),
								}},
							Labels: []*string{
								to.Ptr("label1"),
								to.Ptr("label2")},
						},
						VnetRoutes: &armnetwork.VnetRoute{
							StaticRoutes: []*armnetwork.StaticRoute{},
						},
					},
					VPNClientAddressPool: &armnetwork.AddressSpace{
						AddressPrefixes: []*string{
							to.Ptr("101.3.0.0/16")},
					},
				},
			}},
		VirtualHub: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
		},
		VPNGatewayScaleUnit: to.Ptr[int32](1),
		VPNServerConfiguration: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*P2SVPNGatewaysClient) BeginDelete

BeginDelete - Deletes a virtual wan p2s vpn gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2SVpnGatewayDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "p2sVpnGateway1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*P2SVPNGatewaysClient) BeginDisconnectP2SVPNConnections

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. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDisconnectP2SVPNConnections(ctx, "p2s-vpn-gateway-test", "p2svpngateway", armnetwork.P2SVPNConnectionRequest{
	VPNConnectionIDs: []*string{
		to.Ptr("vpnconnId1"),
		to.Ptr("vpnconnId2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*P2SVPNGatewaysClient) BeginGenerateVPNProfile

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. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2SVpnGatewayGenerateVpnProfile.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGenerateVPNProfile(ctx, "rg1", "p2sVpnGateway1", armnetwork.P2SVPNProfileParameters{
	AuthenticationMethod: to.Ptr(armnetwork.AuthenticationMethodEAPTLS),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*P2SVPNGatewaysClient) BeginGetP2SVPNConnectionHealth

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. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. gatewayName - The name of the P2SVpnGateway. options - P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginGetP2SVPNConnectionHealth method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2SVpnGatewayGetConnectionHealth.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetP2SVPNConnectionHealth(ctx, "rg1", "p2sVpnGateway1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*P2SVPNGatewaysClient) BeginGetP2SVPNConnectionHealthDetailed

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. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetP2SVPNConnectionHealthDetailed(ctx, "p2s-vpn-gateway-test", "p2svpngateway", armnetwork.P2SVPNConnectionHealthRequest{
	OutputBlobSasURL: to.Ptr("https://blobcortextesturl.blob.core.windows.net/folderforconfig/p2sconnectionhealths?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b"),
	VPNUserNamesFilter: []*string{
		to.Ptr("vpnUser1"),
		to.Ptr("vpnUser2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*P2SVPNGatewaysClient) BeginReset

BeginReset - Resets the primary of the p2s vpn gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2SVpnGatewayReset.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginReset(ctx, "rg1", "p2sVpnGateway1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*P2SVPNGatewaysClient) BeginUpdateTags

func (client *P2SVPNGatewaysClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, gatewayName string, p2SVPNGatewayParameters TagsObject, options *P2SVPNGatewaysClientBeginUpdateTagsOptions) (*runtime.Poller[P2SVPNGatewaysClientUpdateTagsResponse], error)

BeginUpdateTags - Updates virtual wan p2s vpn gateway tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2SVpnGatewayUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdateTags(ctx, "rg1", "p2sVpnGateway1", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2SVpnGatewayGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "p2sVpnGateway1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*P2SVPNGatewaysClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all the P2SVpnGateways in a resource group. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the P2SVpnGateway. options - P2SVPNGatewaysClientListByResourceGroupOptions contains the optional parameters for the P2SVPNGatewaysClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2SVpnGatewayListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*P2SVPNGatewaysClient) NewListPager

NewListPager - Lists all the P2SVpnGateways in a subscription. Generated from API version 2022-05-01 options - P2SVPNGatewaysClientListOptions contains the optional parameters for the P2SVPNGatewaysClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/P2SVpnGatewayList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewP2SVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type P2SVPNGatewaysClientBeginCreateOrUpdateOptions

type P2SVPNGatewaysClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

P2SVPNGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginCreateOrUpdate method.

type P2SVPNGatewaysClientBeginDeleteOptions

type P2SVPNGatewaysClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

P2SVPNGatewaysClientBeginDeleteOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginDelete method.

type P2SVPNGatewaysClientBeginDisconnectP2SVPNConnectionsOptions

type P2SVPNGatewaysClientBeginDisconnectP2SVPNConnectionsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

P2SVPNGatewaysClientBeginDisconnectP2SVPNConnectionsOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginDisconnectP2SVPNConnections method.

type P2SVPNGatewaysClientBeginGenerateVPNProfileOptions

type P2SVPNGatewaysClientBeginGenerateVPNProfileOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

P2SVPNGatewaysClientBeginGenerateVPNProfileOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginGenerateVPNProfile method.

type P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthDetailedOptions

type P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthDetailedOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthDetailedOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginGetP2SVPNConnectionHealthDetailed method.

type P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthOptions

type P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

P2SVPNGatewaysClientBeginGetP2SVPNConnectionHealthOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginGetP2SVPNConnectionHealth method.

type P2SVPNGatewaysClientBeginResetOptions

type P2SVPNGatewaysClientBeginResetOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

P2SVPNGatewaysClientBeginResetOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginReset method.

type P2SVPNGatewaysClientBeginUpdateTagsOptions

type P2SVPNGatewaysClientBeginUpdateTagsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

P2SVPNGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the P2SVPNGatewaysClient.BeginUpdateTags method.

type P2SVPNGatewaysClientCreateOrUpdateResponse

type P2SVPNGatewaysClientCreateOrUpdateResponse struct {
	P2SVPNGateway
}

P2SVPNGatewaysClientCreateOrUpdateResponse contains the response from method P2SVPNGatewaysClient.CreateOrUpdate.

type P2SVPNGatewaysClientDeleteResponse

type P2SVPNGatewaysClientDeleteResponse struct {
}

P2SVPNGatewaysClientDeleteResponse contains the response from method P2SVPNGatewaysClient.Delete.

type P2SVPNGatewaysClientDisconnectP2SVPNConnectionsResponse

type P2SVPNGatewaysClientDisconnectP2SVPNConnectionsResponse struct {
}

P2SVPNGatewaysClientDisconnectP2SVPNConnectionsResponse contains the response from method P2SVPNGatewaysClient.DisconnectP2SVPNConnections.

type P2SVPNGatewaysClientGenerateVPNProfileResponse

type P2SVPNGatewaysClientGenerateVPNProfileResponse struct {
	VPNProfileResponse
}

P2SVPNGatewaysClientGenerateVPNProfileResponse contains the response from method P2SVPNGatewaysClient.GenerateVPNProfile.

type P2SVPNGatewaysClientGetOptions

type P2SVPNGatewaysClientGetOptions struct {
}

P2SVPNGatewaysClientGetOptions contains the optional parameters for the P2SVPNGatewaysClient.Get method.

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResponse

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResponse struct {
	P2SVPNConnectionHealth
}

P2SVPNGatewaysClientGetP2SVPNConnectionHealthDetailedResponse contains the response from method P2SVPNGatewaysClient.GetP2SVPNConnectionHealthDetailed.

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthResponse

type P2SVPNGatewaysClientGetP2SVPNConnectionHealthResponse struct {
	P2SVPNGateway
}

P2SVPNGatewaysClientGetP2SVPNConnectionHealthResponse contains the response from method P2SVPNGatewaysClient.GetP2SVPNConnectionHealth.

type P2SVPNGatewaysClientGetResponse

type P2SVPNGatewaysClientGetResponse struct {
	P2SVPNGateway
}

P2SVPNGatewaysClientGetResponse contains the response from method P2SVPNGatewaysClient.Get.

type P2SVPNGatewaysClientListByResourceGroupOptions

type P2SVPNGatewaysClientListByResourceGroupOptions struct {
}

P2SVPNGatewaysClientListByResourceGroupOptions contains the optional parameters for the P2SVPNGatewaysClient.ListByResourceGroup method.

type P2SVPNGatewaysClientListByResourceGroupResponse

type P2SVPNGatewaysClientListByResourceGroupResponse struct {
	ListP2SVPNGatewaysResult
}

P2SVPNGatewaysClientListByResourceGroupResponse contains the response from method P2SVPNGatewaysClient.ListByResourceGroup.

type P2SVPNGatewaysClientListOptions

type P2SVPNGatewaysClientListOptions struct {
}

P2SVPNGatewaysClientListOptions contains the optional parameters for the P2SVPNGatewaysClient.List method.

type P2SVPNGatewaysClientListResponse

type P2SVPNGatewaysClientListResponse struct {
	ListP2SVPNGatewaysResult
}

P2SVPNGatewaysClientListResponse contains the response from method P2SVPNGatewaysClient.List.

type P2SVPNGatewaysClientResetResponse

type P2SVPNGatewaysClientResetResponse struct {
	P2SVPNGateway
}

P2SVPNGatewaysClientResetResponse contains the response from method P2SVPNGatewaysClient.Reset.

type P2SVPNGatewaysClientUpdateTagsResponse

type P2SVPNGatewaysClientUpdateTagsResponse struct {
	P2SVPNGateway
}

P2SVPNGatewaysClientUpdateTagsResponse contains the response 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.

func (P2SVPNProfileParameters) MarshalJSON

func (p P2SVPNProfileParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type P2SVPNProfileParameters.

func (*P2SVPNProfileParameters) UnmarshalJSON

func (p *P2SVPNProfileParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type P2SVPNProfileParameters.

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.

func (PacketCapture) MarshalJSON

func (p PacketCapture) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCapture.

func (*PacketCapture) UnmarshalJSON

func (p *PacketCapture) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCapture.

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.

func (PacketCaptureFilter) MarshalJSON

func (p PacketCaptureFilter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCaptureFilter.

func (*PacketCaptureFilter) UnmarshalJSON

func (p *PacketCaptureFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCaptureFilter.

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.

func (*PacketCaptureListResult) UnmarshalJSON

func (p *PacketCaptureListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCaptureListResult.

type PacketCaptureMachineScope

type PacketCaptureMachineScope struct {
	// List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.
	Exclude []*string `json:"exclude,omitempty"`

	// List of AzureVMSS instances to run packet capture on.
	Include []*string `json:"include,omitempty"`
}

PacketCaptureMachineScope - A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS.

func (PacketCaptureMachineScope) MarshalJSON

func (p PacketCaptureMachineScope) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCaptureMachineScope.

func (*PacketCaptureMachineScope) UnmarshalJSON

func (p *PacketCaptureMachineScope) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCaptureMachineScope.

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 AzureVM and AzureVMSS as target type are 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"`

	// A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are
	// empty, then the packet capture will run on all instances of AzureVMSS.
	Scope *PacketCaptureMachineScope `json:"scope,omitempty"`

	// Target type of the resource provided.
	TargetType *PacketCaptureTargetType `json:"targetType,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.

func (*PacketCaptureParameters) UnmarshalJSON

func (p *PacketCaptureParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PacketCaptureResult) MarshalJSON

func (p PacketCaptureResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCaptureResult.

func (*PacketCaptureResult) UnmarshalJSON

func (p *PacketCaptureResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCaptureResult.

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 AzureVM and AzureVMSS as target type are 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"`

	// A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are
	// empty, then the packet capture will run on all instances of AzureVMSS.
	Scope *PacketCaptureMachineScope `json:"scope,omitempty"`

	// Target type of the resource provided.
	TargetType *PacketCaptureTargetType `json:"targetType,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.

func (*PacketCaptureResultProperties) UnmarshalJSON

func (p *PacketCaptureResultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PacketCaptureStorageLocation) MarshalJSON

func (p PacketCaptureStorageLocation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCaptureStorageLocation.

func (*PacketCaptureStorageLocation) UnmarshalJSON

func (p *PacketCaptureStorageLocation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCaptureStorageLocation.

type PacketCaptureTargetType

type PacketCaptureTargetType string

PacketCaptureTargetType - Target type of the resource provided.

const (
	PacketCaptureTargetTypeAzureVM   PacketCaptureTargetType = "AzureVM"
	PacketCaptureTargetTypeAzureVMSS PacketCaptureTargetType = "AzureVMSS"
)

func PossiblePacketCaptureTargetTypeValues

func PossiblePacketCaptureTargetTypeValues() []PacketCaptureTargetType

PossiblePacketCaptureTargetTypeValues returns the possible values for the PacketCaptureTargetType const type.

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, error)

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) (*runtime.Poller[PacketCapturesClientCreateResponse], error)

BeginCreate - Create and start a packet capture on the specified VM. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherPacketCaptureCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPacketCapturesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreate(ctx, "rg1", "nw1", "pc1", armnetwork.PacketCapture{
	Properties: &armnetwork.PacketCaptureParameters{
		BytesToCapturePerPacket: to.Ptr[int64](10000),
		Filters: []*armnetwork.PacketCaptureFilter{
			{
				LocalIPAddress: to.Ptr("10.0.0.4"),
				LocalPort:      to.Ptr("80"),
				Protocol:       to.Ptr(armnetwork.PcProtocolTCP),
			}},
		StorageLocation: &armnetwork.PacketCaptureStorageLocation{
			FilePath:    to.Ptr("D:\\capture\\pc1.cap"),
			StorageID:   to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore"),
			StoragePath: to.Ptr("https://mytestaccountname.blob.core.windows.net/capture/pc1.cap"),
		},
		Target:               to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
		TimeLimitInSeconds:   to.Ptr[int32](100),
		TotalBytesPerSession: to.Ptr[int64](100000),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*PacketCapturesClient) BeginDelete

func (client *PacketCapturesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkWatcherName string, packetCaptureName string, options *PacketCapturesClientBeginDeleteOptions) (*runtime.Poller[PacketCapturesClientDeleteResponse], error)

BeginDelete - Deletes the specified packet capture session. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherPacketCaptureDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPacketCapturesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "nw1", "pc1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*PacketCapturesClient) BeginGetStatus

func (client *PacketCapturesClient) BeginGetStatus(ctx context.Context, resourceGroupName string, networkWatcherName string, packetCaptureName string, options *PacketCapturesClientBeginGetStatusOptions) (*runtime.Poller[PacketCapturesClientGetStatusResponse], error)

BeginGetStatus - Query the status of a running packet capture session. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherPacketCaptureQueryStatus.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPacketCapturesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetStatus(ctx, "rg1", "nw1", "pc1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PacketCapturesClient) BeginStop

func (client *PacketCapturesClient) BeginStop(ctx context.Context, resourceGroupName string, networkWatcherName string, packetCaptureName string, options *PacketCapturesClientBeginStopOptions) (*runtime.Poller[PacketCapturesClientStopResponse], error)

BeginStop - Stops a specified packet capture session. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherPacketCaptureStop.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPacketCapturesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStop(ctx, "rg1", "nw1", "pc1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherPacketCaptureGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPacketCapturesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "nw1", "pc1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PacketCapturesClient) NewListPager

func (client *PacketCapturesClient) NewListPager(resourceGroupName string, networkWatcherName string, options *PacketCapturesClientListOptions) *runtime.Pager[PacketCapturesClientListResponse]

NewListPager - Lists all packet capture sessions within the specified resource group. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherPacketCapturesList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPacketCapturesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "nw1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type PacketCapturesClientBeginCreateOptions

type PacketCapturesClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PacketCapturesClientBeginCreateOptions contains the optional parameters for the PacketCapturesClient.BeginCreate method.

type PacketCapturesClientBeginDeleteOptions

type PacketCapturesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PacketCapturesClientBeginDeleteOptions contains the optional parameters for the PacketCapturesClient.BeginDelete method.

type PacketCapturesClientBeginGetStatusOptions

type PacketCapturesClientBeginGetStatusOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PacketCapturesClientBeginGetStatusOptions contains the optional parameters for the PacketCapturesClient.BeginGetStatus method.

type PacketCapturesClientBeginStopOptions

type PacketCapturesClientBeginStopOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PacketCapturesClientBeginStopOptions contains the optional parameters for the PacketCapturesClient.BeginStop method.

type PacketCapturesClientCreateResponse

type PacketCapturesClientCreateResponse struct {
	PacketCaptureResult
}

PacketCapturesClientCreateResponse contains the response from method PacketCapturesClient.Create.

type PacketCapturesClientDeleteResponse

type PacketCapturesClientDeleteResponse struct {
}

PacketCapturesClientDeleteResponse contains the response from method PacketCapturesClient.Delete.

type PacketCapturesClientGetOptions

type PacketCapturesClientGetOptions struct {
}

PacketCapturesClientGetOptions contains the optional parameters for the PacketCapturesClient.Get method.

type PacketCapturesClientGetResponse

type PacketCapturesClientGetResponse struct {
	PacketCaptureResult
}

PacketCapturesClientGetResponse contains the response from method PacketCapturesClient.Get.

type PacketCapturesClientGetStatusResponse

type PacketCapturesClientGetStatusResponse struct {
	PacketCaptureQueryStatusResult
}

PacketCapturesClientGetStatusResponse contains the response from method PacketCapturesClient.GetStatus.

type PacketCapturesClientListOptions

type PacketCapturesClientListOptions struct {
}

PacketCapturesClientListOptions contains the optional parameters for the PacketCapturesClient.List method.

type PacketCapturesClientListResponse

type PacketCapturesClientListResponse struct {
	PacketCaptureListResult
}

PacketCapturesClientListResponse contains the response from method PacketCapturesClient.List.

type PacketCapturesClientStopResponse

type PacketCapturesClientStopResponse struct {
}

PacketCapturesClientStopResponse contains the response from method PacketCapturesClient.Stop.

type Parameter

type Parameter struct {
	// List of AS paths.
	AsPath []*string `json:"asPath,omitempty"`

	// List of BGP communities.
	Community []*string `json:"community,omitempty"`

	// List of route prefixes.
	RoutePrefix []*string `json:"routePrefix,omitempty"`
}

Parameters for an Action.

func (Parameter) MarshalJSON

func (p Parameter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Parameter.

func (*Parameter) UnmarshalJSON

func (p *Parameter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Parameter.

type PatchObject

type PatchObject struct {
	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`
}

PatchObject - Object for patch operations.

func (PatchObject) MarshalJSON

func (p PatchObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PatchObject.

func (*PatchObject) UnmarshalJSON

func (p *PatchObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PatchObject.

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.

func (*PatchRouteFilter) UnmarshalJSON

func (p *PatchRouteFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PatchRouteFilterRule) MarshalJSON

func (p PatchRouteFilterRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PatchRouteFilterRule.

func (*PatchRouteFilterRule) UnmarshalJSON

func (p *PatchRouteFilterRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PatchRouteFilterRule.

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.

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.

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.

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.

func (PeerExpressRouteCircuitConnection) MarshalJSON

func (p PeerExpressRouteCircuitConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeerExpressRouteCircuitConnection.

func (*PeerExpressRouteCircuitConnection) UnmarshalJSON

func (p *PeerExpressRouteCircuitConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PeerExpressRouteCircuitConnection.

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

MarshalJSON implements the json.Marshaller interface for type PeerExpressRouteCircuitConnectionListResult.

func (*PeerExpressRouteCircuitConnectionListResult) UnmarshalJSON

func (p *PeerExpressRouteCircuitConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PeerExpressRouteCircuitConnectionPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type PeerExpressRouteCircuitConnectionPropertiesFormat.

func (*PeerExpressRouteCircuitConnectionPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type PeerExpressRouteCircuitConnectionPropertiesFormat.

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, error)

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

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PeerExpressRouteCircuitConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPeerExpressRouteCircuitConnectionsClient("subid1", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "ExpressRouteARMCircuitA", "AzurePrivatePeering", "60aee347-e889-4a42-8c1b-0aae8b1e4013", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PeerExpressRouteCircuitConnectionsClient) NewListPager

NewListPager - Gets all global reach peer connections associated with a private peering in an express route circuit. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PeerExpressRouteCircuitConnectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPeerExpressRouteCircuitConnectionsClient("subid1", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "ExpressRouteARMCircuitA", "AzurePrivatePeering", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type PeerExpressRouteCircuitConnectionsClientGetOptions

type PeerExpressRouteCircuitConnectionsClientGetOptions struct {
}

PeerExpressRouteCircuitConnectionsClientGetOptions contains the optional parameters for the PeerExpressRouteCircuitConnectionsClient.Get method.

type PeerExpressRouteCircuitConnectionsClientGetResponse

type PeerExpressRouteCircuitConnectionsClientGetResponse struct {
	PeerExpressRouteCircuitConnection
}

PeerExpressRouteCircuitConnectionsClientGetResponse contains the response from method PeerExpressRouteCircuitConnectionsClient.Get.

type PeerExpressRouteCircuitConnectionsClientListOptions

type PeerExpressRouteCircuitConnectionsClientListOptions struct {
}

PeerExpressRouteCircuitConnectionsClientListOptions contains the optional parameters for the PeerExpressRouteCircuitConnectionsClient.List method.

type PeerExpressRouteCircuitConnectionsClientListResponse

type PeerExpressRouteCircuitConnectionsClientListResponse struct {
	PeerExpressRouteCircuitConnectionListResult
}

PeerExpressRouteCircuitConnectionsClientListResponse contains the response 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.

func (PeerRoute) MarshalJSON

func (p PeerRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PeerRoute.

func (*PeerRoute) UnmarshalJSON

func (p *PeerRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PeerRoute.

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.

func (*PeerRouteList) UnmarshalJSON

func (p *PeerRouteList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (PolicySettings) MarshalJSON

func (p PolicySettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PolicySettings.

func (*PolicySettings) UnmarshalJSON

func (p *PolicySettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PolicySettings.

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.

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.

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.

func (*PrepareNetworkPoliciesRequest) UnmarshalJSON

func (p *PrepareNetworkPoliciesRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PrivateDNSZoneConfig) MarshalJSON

func (p PrivateDNSZoneConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateDNSZoneConfig.

func (*PrivateDNSZoneConfig) UnmarshalJSON

func (p *PrivateDNSZoneConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateDNSZoneConfig.

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.

func (PrivateDNSZoneGroup) MarshalJSON

func (p PrivateDNSZoneGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateDNSZoneGroup.

func (*PrivateDNSZoneGroup) UnmarshalJSON

func (p *PrivateDNSZoneGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateDNSZoneGroup.

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.

func (*PrivateDNSZoneGroupListResult) UnmarshalJSON

func (p *PrivateDNSZoneGroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*PrivateDNSZoneGroupPropertiesFormat) UnmarshalJSON

func (p *PrivateDNSZoneGroupPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[PrivateDNSZoneGroupsClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointDnsZoneGroupCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateDNSZoneGroupsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testPe", "testPdnsgroup", armnetwork.PrivateDNSZoneGroup{
	Properties: &armnetwork.PrivateDNSZoneGroupPropertiesFormat{
		PrivateDNSZoneConfigs: []*armnetwork.PrivateDNSZoneConfig{
			{
				Properties: &armnetwork.PrivateDNSZonePropertiesFormat{
					PrivateDNSZoneID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com"),
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PrivateDNSZoneGroupsClient) BeginDelete

func (client *PrivateDNSZoneGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, privateEndpointName string, privateDNSZoneGroupName string, options *PrivateDNSZoneGroupsClientBeginDeleteOptions) (*runtime.Poller[PrivateDNSZoneGroupsClientDeleteResponse], error)

BeginDelete - Deletes the specified private dns zone group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointDnsZoneGroupDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateDNSZoneGroupsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testPe", "testPdnsgroup", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointDnsZoneGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateDNSZoneGroupsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testPe", "testPdnsgroup", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PrivateDNSZoneGroupsClient) NewListPager

func (client *PrivateDNSZoneGroupsClient) NewListPager(privateEndpointName string, resourceGroupName string, options *PrivateDNSZoneGroupsClientListOptions) *runtime.Pager[PrivateDNSZoneGroupsClientListResponse]

NewListPager - Gets all private dns zone groups in a private endpoint. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointDnsZoneGroupList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateDNSZoneGroupsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("testPe", "rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type PrivateDNSZoneGroupsClientBeginCreateOrUpdateOptions

type PrivateDNSZoneGroupsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateDNSZoneGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.BeginCreateOrUpdate method.

type PrivateDNSZoneGroupsClientBeginDeleteOptions

type PrivateDNSZoneGroupsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateDNSZoneGroupsClientBeginDeleteOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.BeginDelete method.

type PrivateDNSZoneGroupsClientCreateOrUpdateResponse

type PrivateDNSZoneGroupsClientCreateOrUpdateResponse struct {
	PrivateDNSZoneGroup
}

PrivateDNSZoneGroupsClientCreateOrUpdateResponse contains the response from method PrivateDNSZoneGroupsClient.CreateOrUpdate.

type PrivateDNSZoneGroupsClientDeleteResponse

type PrivateDNSZoneGroupsClientDeleteResponse struct {
}

PrivateDNSZoneGroupsClientDeleteResponse contains the response from method PrivateDNSZoneGroupsClient.Delete.

type PrivateDNSZoneGroupsClientGetOptions

type PrivateDNSZoneGroupsClientGetOptions struct {
}

PrivateDNSZoneGroupsClientGetOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.Get method.

type PrivateDNSZoneGroupsClientGetResponse

type PrivateDNSZoneGroupsClientGetResponse struct {
	PrivateDNSZoneGroup
}

PrivateDNSZoneGroupsClientGetResponse contains the response from method PrivateDNSZoneGroupsClient.Get.

type PrivateDNSZoneGroupsClientListOptions

type PrivateDNSZoneGroupsClientListOptions struct {
}

PrivateDNSZoneGroupsClientListOptions contains the optional parameters for the PrivateDNSZoneGroupsClient.List method.

type PrivateDNSZoneGroupsClientListResponse

type PrivateDNSZoneGroupsClientListResponse struct {
	PrivateDNSZoneGroupListResult
}

PrivateDNSZoneGroupsClientListResponse contains the response 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.

func (*PrivateDNSZonePropertiesFormat) UnmarshalJSON

func (p *PrivateDNSZonePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*PrivateEndpoint) UnmarshalJSON

func (p *PrivateEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PrivateEndpointConnection) MarshalJSON

func (p PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON

func (p *PrivateEndpointConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnection.

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.

func (*PrivateEndpointConnectionListResult) UnmarshalJSON

func (p *PrivateEndpointConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PrivateEndpointConnectionProperties) MarshalJSON

func (p PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

func (*PrivateEndpointConnectionProperties) UnmarshalJSON

func (p *PrivateEndpointConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionProperties.

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.

func (PrivateEndpointIPConfiguration) MarshalJSON

func (p PrivateEndpointIPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointIPConfiguration.

func (*PrivateEndpointIPConfiguration) UnmarshalJSON

func (p *PrivateEndpointIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointIPConfiguration.

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.

func (PrivateEndpointIPConfigurationProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointIPConfigurationProperties.

func (*PrivateEndpointIPConfigurationProperties) UnmarshalJSON

func (p *PrivateEndpointIPConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointIPConfigurationProperties.

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.

func (*PrivateEndpointListResult) UnmarshalJSON

func (p *PrivateEndpointListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*PrivateEndpointProperties) UnmarshalJSON

func (p *PrivateEndpointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[PrivateEndpointsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an private endpoint in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreatePrivateEndpoint)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateEndpointsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testPe", armnetwork.PrivateEndpoint{
	Location: to.Ptr("eastus2euap"),
	Properties: &armnetwork.PrivateEndpointProperties{
		CustomNetworkInterfaceName: to.Ptr("testPeNic"),
		IPConfigurations: []*armnetwork.PrivateEndpointIPConfiguration{
			{
				Name: to.Ptr("pestaticconfig"),
				Properties: &armnetwork.PrivateEndpointIPConfigurationProperties{
					GroupID:          to.Ptr("file"),
					MemberName:       to.Ptr("file"),
					PrivateIPAddress: to.Ptr("192.168.0.6"),
				},
			}},
		PrivateLinkServiceConnections: []*armnetwork.PrivateLinkServiceConnection{
			{
				Properties: &armnetwork.PrivateLinkServiceConnectionProperties{
					GroupIDs: []*string{
						to.Ptr("groupIdFromResource")},
					PrivateLinkServiceID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls"),
					RequestMessage:       to.Ptr("Please approve my connection."),
				},
			}},
		Subnet: &armnetwork.Subnet{
			ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreatePrivateEndpointWithApplicationSecurityGroups)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointCreateWithASG.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateEndpointsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testPe", armnetwork.PrivateEndpoint{
	Location: to.Ptr("eastus2euap"),
	Properties: &armnetwork.PrivateEndpointProperties{
		ApplicationSecurityGroups: []*armnetwork.ApplicationSecurityGroup{
			{
				ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/applicationSecurityGroup/asg1"),
			}},
		PrivateLinkServiceConnections: []*armnetwork.PrivateLinkServiceConnection{
			{
				Properties: &armnetwork.PrivateLinkServiceConnectionProperties{
					GroupIDs: []*string{
						to.Ptr("groupIdFromResource")},
					PrivateLinkServiceID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls"),
					RequestMessage:       to.Ptr("Please approve my connection."),
				},
			}},
		Subnet: &armnetwork.Subnet{
			ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreatePrivateEndpointWithManualApprovalConnection)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointCreateForManualApproval.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateEndpointsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testPe", armnetwork.PrivateEndpoint{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.PrivateEndpointProperties{
		CustomNetworkInterfaceName: to.Ptr("testPeNic"),
		IPConfigurations: []*armnetwork.PrivateEndpointIPConfiguration{
			{
				Name: to.Ptr("pestaticconfig"),
				Properties: &armnetwork.PrivateEndpointIPConfigurationProperties{
					GroupID:          to.Ptr("file"),
					MemberName:       to.Ptr("file"),
					PrivateIPAddress: to.Ptr("192.168.0.5"),
				},
			}},
		ManualPrivateLinkServiceConnections: []*armnetwork.PrivateLinkServiceConnection{
			{
				Properties: &armnetwork.PrivateLinkServiceConnectionProperties{
					GroupIDs: []*string{
						to.Ptr("groupIdFromResource")},
					PrivateLinkServiceID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls"),
					RequestMessage:       to.Ptr("Please manually approve my connection."),
				},
			}},
		Subnet: &armnetwork.Subnet{
			ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PrivateEndpointsClient) BeginDelete

func (client *PrivateEndpointsClient) BeginDelete(ctx context.Context, resourceGroupName string, privateEndpointName string, options *PrivateEndpointsClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointsClientDeleteResponse], error)

BeginDelete - Deletes the specified private endpoint. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateEndpointsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testPe", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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 (GetPrivateEndpoint)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateEndpointsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testPe", &armnetwork.PrivateEndpointsClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetPrivateEndpointWithApplicationSecurityGroups)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointGetWithASG.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateEndpointsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testPe", &armnetwork.PrivateEndpointsClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetPrivateEndpointWithManualApprovalConnection)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointGetForManualApproval.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateEndpointsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testPe", &armnetwork.PrivateEndpointsClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PrivateEndpointsClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Gets all private endpoints in a subscription. Generated from API version 2022-05-01 options - PrivateEndpointsClientListBySubscriptionOptions contains the optional parameters for the PrivateEndpointsClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateEndpointsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListBySubscriptionPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PrivateEndpointsClient) NewListPager

NewListPager - Gets all private endpoints in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - PrivateEndpointsClientListOptions contains the optional parameters for the PrivateEndpointsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateEndpointList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateEndpointsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type PrivateEndpointsClientBeginCreateOrUpdateOptions

type PrivateEndpointsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointsClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointsClient.BeginCreateOrUpdate method.

type PrivateEndpointsClientBeginDeleteOptions

type PrivateEndpointsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateEndpointsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointsClient.BeginDelete method.

type PrivateEndpointsClientCreateOrUpdateResponse

type PrivateEndpointsClientCreateOrUpdateResponse struct {
	PrivateEndpoint
}

PrivateEndpointsClientCreateOrUpdateResponse contains the response from method PrivateEndpointsClient.CreateOrUpdate.

type PrivateEndpointsClientDeleteResponse

type PrivateEndpointsClientDeleteResponse struct {
}

PrivateEndpointsClientDeleteResponse contains the response from method PrivateEndpointsClient.Delete.

type PrivateEndpointsClientGetOptions

type PrivateEndpointsClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

PrivateEndpointsClientGetOptions contains the optional parameters for the PrivateEndpointsClient.Get method.

type PrivateEndpointsClientGetResponse

type PrivateEndpointsClientGetResponse struct {
	PrivateEndpoint
}

PrivateEndpointsClientGetResponse contains the response from method PrivateEndpointsClient.Get.

type PrivateEndpointsClientListBySubscriptionOptions

type PrivateEndpointsClientListBySubscriptionOptions struct {
}

PrivateEndpointsClientListBySubscriptionOptions contains the optional parameters for the PrivateEndpointsClient.ListBySubscription method.

type PrivateEndpointsClientListBySubscriptionResponse

type PrivateEndpointsClientListBySubscriptionResponse struct {
	PrivateEndpointListResult
}

PrivateEndpointsClientListBySubscriptionResponse contains the response from method PrivateEndpointsClient.ListBySubscription.

type PrivateEndpointsClientListOptions

type PrivateEndpointsClientListOptions struct {
}

PrivateEndpointsClientListOptions contains the optional parameters for the PrivateEndpointsClient.List method.

type PrivateEndpointsClientListResponse

type PrivateEndpointsClientListResponse struct {
	PrivateEndpointListResult
}

PrivateEndpointsClientListResponse contains the response 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.

func (*PrivateLinkService) UnmarshalJSON

func (p *PrivateLinkService) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PrivateLinkServiceConnection) MarshalJSON

func (p PrivateLinkServiceConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceConnection.

func (*PrivateLinkServiceConnection) UnmarshalJSON

func (p *PrivateLinkServiceConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceConnection.

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.

func (*PrivateLinkServiceConnectionProperties) UnmarshalJSON

func (p *PrivateLinkServiceConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PrivateLinkServiceConnectionState) MarshalJSON

func (p PrivateLinkServiceConnectionState) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceConnectionState.

func (*PrivateLinkServiceConnectionState) UnmarshalJSON

func (p *PrivateLinkServiceConnectionState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceConnectionState.

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.

func (PrivateLinkServiceIPConfiguration) MarshalJSON

func (p PrivateLinkServiceIPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceIPConfiguration.

func (*PrivateLinkServiceIPConfiguration) UnmarshalJSON

func (p *PrivateLinkServiceIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceIPConfiguration.

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.

func (PrivateLinkServiceIPConfigurationProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceIPConfigurationProperties.

func (*PrivateLinkServiceIPConfigurationProperties) UnmarshalJSON

func (p *PrivateLinkServiceIPConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceIPConfigurationProperties.

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.

func (*PrivateLinkServiceListResult) UnmarshalJSON

func (p *PrivateLinkServiceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*PrivateLinkServiceProperties) UnmarshalJSON

func (p *PrivateLinkServiceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServicePropertiesAutoApproval.

func (*PrivateLinkServicePropertiesAutoApproval) UnmarshalJSON

func (p *PrivateLinkServicePropertiesAutoApproval) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

func (p PrivateLinkServicePropertiesVisibility) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServicePropertiesVisibility.

func (*PrivateLinkServicePropertiesVisibility) UnmarshalJSON

func (p *PrivateLinkServicePropertiesVisibility) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PrivateLinkServiceVisibility) MarshalJSON

func (p PrivateLinkServiceVisibility) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceVisibility.

func (*PrivateLinkServiceVisibility) UnmarshalJSON

func (p *PrivateLinkServiceVisibility) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceVisibility.

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, error)

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

BeginCheckPrivateLinkServiceVisibility - Checks whether the subscription is visible to private link service. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CheckPrivateLinkServiceVisibility.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCheckPrivateLinkServiceVisibility(ctx, "westus", armnetwork.CheckPrivateLinkServiceVisibilityRequest{
	PrivateLinkServiceAlias: to.Ptr("mypls.00000000-0000-0000-0000-000000000000.azure.privatelinkservice"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PrivateLinkServicesClient) BeginCheckPrivateLinkServiceVisibilityByResourceGroup

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCheckPrivateLinkServiceVisibilityByResourceGroup(ctx, "westus", "rg1", armnetwork.CheckPrivateLinkServiceVisibilityRequest{
	PrivateLinkServiceAlias: to.Ptr("mypls.00000000-0000-0000-0000-000000000000.azure.privatelinkservice"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PrivateLinkServicesClient) BeginCreateOrUpdate

BeginCreateOrUpdate - Creates or updates an private link service in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateLinkServiceCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testPls", armnetwork.PrivateLinkService{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.PrivateLinkServiceProperties{
		AutoApproval: &armnetwork.PrivateLinkServicePropertiesAutoApproval{
			Subscriptions: []*string{
				to.Ptr("subscription1"),
				to.Ptr("subscription2")},
		},
		Fqdns: []*string{
			to.Ptr("fqdn1"),
			to.Ptr("fqdn2"),
			to.Ptr("fqdn3")},
		IPConfigurations: []*armnetwork.PrivateLinkServiceIPConfiguration{
			{
				Name: to.Ptr("fe-lb"),
				Properties: &armnetwork.PrivateLinkServiceIPConfigurationProperties{
					PrivateIPAddress:          to.Ptr("10.0.1.4"),
					PrivateIPAddressVersion:   to.Ptr(armnetwork.IPVersionIPv4),
					PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodStatic),
					Subnet: &armnetwork.Subnet{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"),
					},
				},
			}},
		LoadBalancerFrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
			{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"),
			}},
		Visibility: &armnetwork.PrivateLinkServicePropertiesVisibility{
			Subscriptions: []*string{
				to.Ptr("subscription1"),
				to.Ptr("subscription2"),
				to.Ptr("subscription3")},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PrivateLinkServicesClient) BeginDelete

BeginDelete - Deletes the specified private link service. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateLinkServiceDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testPls", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*PrivateLinkServicesClient) BeginDeletePrivateEndpointConnection

BeginDeletePrivateEndpointConnection - Delete private end point connection for a private link service in a subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDeletePrivateEndpointConnection(ctx, "rg1", "testPls", "testPlePeConnection", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*PrivateLinkServicesClient) Get

Get - Gets the specified private link service by resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateLinkServiceGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testPls", &armnetwork.PrivateLinkServicesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetPrivateEndpointConnection(ctx, "rg1", "testPls", "testPlePeConnection", &armnetwork.PrivateLinkServicesClientGetPrivateEndpointConnectionOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PrivateLinkServicesClient) NewListAutoApprovedPrivateLinkServicesByResourceGroupPager

NewListAutoApprovedPrivateLinkServicesByResourceGroupPager - 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAutoApprovedPrivateLinkServicesByResourceGroupPager("regionName", "rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PrivateLinkServicesClient) NewListAutoApprovedPrivateLinkServicesPager

NewListAutoApprovedPrivateLinkServicesPager - 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. Generated from API version 2022-05-01 location - The location of the domain name. options - PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesOptions contains the optional parameters for the PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServices method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AutoApprovedPrivateLinkServicesGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAutoApprovedPrivateLinkServicesPager("regionName", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PrivateLinkServicesClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Gets all private link service in a subscription. Generated from API version 2022-05-01 options - PrivateLinkServicesClientListBySubscriptionOptions contains the optional parameters for the PrivateLinkServicesClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateLinkServiceListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListBySubscriptionPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PrivateLinkServicesClient) NewListPager

NewListPager - Gets all private link services in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - PrivateLinkServicesClientListOptions contains the optional parameters for the PrivateLinkServicesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateLinkServiceList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PrivateLinkServicesClient) NewListPrivateEndpointConnectionsPager

NewListPrivateEndpointConnectionsPager - Gets all private end point connections for a specific private link service. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPrivateEndpointConnectionsPager("rg1", "testPls", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PrivateLinkServicesClient) UpdatePrivateEndpointConnection

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPrivateLinkServicesClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdatePrivateEndpointConnection(ctx, "rg1", "testPls", "testPlePeConnection", armnetwork.PrivateEndpointConnection{
	Name: to.Ptr("testPlePeConnection"),
	Properties: &armnetwork.PrivateEndpointConnectionProperties{
		PrivateEndpoint: &armnetwork.PrivateEndpoint{
			ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe"),
		},
		PrivateLinkServiceConnectionState: &armnetwork.PrivateLinkServiceConnectionState{
			Description: to.Ptr("approved it for some reason."),
			Status:      to.Ptr("Approved"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityByResourceGroupOptions

type PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityByResourceGroupOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityByResourceGroupOptions contains the optional parameters for the PrivateLinkServicesClient.BeginCheckPrivateLinkServiceVisibilityByResourceGroup method.

type PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityOptions

type PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateLinkServicesClientBeginCheckPrivateLinkServiceVisibilityOptions contains the optional parameters for the PrivateLinkServicesClient.BeginCheckPrivateLinkServiceVisibility method.

type PrivateLinkServicesClientBeginCreateOrUpdateOptions

type PrivateLinkServicesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateLinkServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the PrivateLinkServicesClient.BeginCreateOrUpdate method.

type PrivateLinkServicesClientBeginDeleteOptions

type PrivateLinkServicesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateLinkServicesClientBeginDeleteOptions contains the optional parameters for the PrivateLinkServicesClient.BeginDelete method.

type PrivateLinkServicesClientBeginDeletePrivateEndpointConnectionOptions

type PrivateLinkServicesClientBeginDeletePrivateEndpointConnectionOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PrivateLinkServicesClientBeginDeletePrivateEndpointConnectionOptions contains the optional parameters for the PrivateLinkServicesClient.BeginDeletePrivateEndpointConnection method.

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResponse

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResponse struct {
	PrivateLinkServiceVisibility
}

PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityByResourceGroupResponse contains the response from method PrivateLinkServicesClient.CheckPrivateLinkServiceVisibilityByResourceGroup.

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResponse

type PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResponse struct {
	PrivateLinkServiceVisibility
}

PrivateLinkServicesClientCheckPrivateLinkServiceVisibilityResponse contains the response from method PrivateLinkServicesClient.CheckPrivateLinkServiceVisibility.

type PrivateLinkServicesClientCreateOrUpdateResponse

type PrivateLinkServicesClientCreateOrUpdateResponse struct {
	PrivateLinkService
}

PrivateLinkServicesClientCreateOrUpdateResponse contains the response from method PrivateLinkServicesClient.CreateOrUpdate.

type PrivateLinkServicesClientDeletePrivateEndpointConnectionResponse

type PrivateLinkServicesClientDeletePrivateEndpointConnectionResponse struct {
}

PrivateLinkServicesClientDeletePrivateEndpointConnectionResponse contains the response from method PrivateLinkServicesClient.DeletePrivateEndpointConnection.

type PrivateLinkServicesClientDeleteResponse

type PrivateLinkServicesClientDeleteResponse struct {
}

PrivateLinkServicesClientDeleteResponse contains the response from method PrivateLinkServicesClient.Delete.

type PrivateLinkServicesClientGetOptions

type PrivateLinkServicesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

PrivateLinkServicesClientGetOptions contains the optional parameters for the PrivateLinkServicesClient.Get method.

type PrivateLinkServicesClientGetPrivateEndpointConnectionOptions

type PrivateLinkServicesClientGetPrivateEndpointConnectionOptions struct {
	// Expands referenced resources.
	Expand *string
}

PrivateLinkServicesClientGetPrivateEndpointConnectionOptions contains the optional parameters for the PrivateLinkServicesClient.GetPrivateEndpointConnection method.

type PrivateLinkServicesClientGetPrivateEndpointConnectionResponse

type PrivateLinkServicesClientGetPrivateEndpointConnectionResponse struct {
	PrivateEndpointConnection
}

PrivateLinkServicesClientGetPrivateEndpointConnectionResponse contains the response from method PrivateLinkServicesClient.GetPrivateEndpointConnection.

type PrivateLinkServicesClientGetResponse

type PrivateLinkServicesClientGetResponse struct {
	PrivateLinkService
}

PrivateLinkServicesClientGetResponse contains the response from method PrivateLinkServicesClient.Get.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupOptions

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupOptions struct {
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupOptions contains the optional parameters for the PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServicesByResourceGroup method.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResponse

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResponse struct {
	AutoApprovedPrivateLinkServicesResult
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesByResourceGroupResponse contains the response from method PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServicesByResourceGroup.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesOptions

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesOptions struct {
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesOptions contains the optional parameters for the PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServices method.

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResponse

type PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResponse struct {
	AutoApprovedPrivateLinkServicesResult
}

PrivateLinkServicesClientListAutoApprovedPrivateLinkServicesResponse contains the response from method PrivateLinkServicesClient.ListAutoApprovedPrivateLinkServices.

type PrivateLinkServicesClientListBySubscriptionOptions

type PrivateLinkServicesClientListBySubscriptionOptions struct {
}

PrivateLinkServicesClientListBySubscriptionOptions contains the optional parameters for the PrivateLinkServicesClient.ListBySubscription method.

type PrivateLinkServicesClientListBySubscriptionResponse

type PrivateLinkServicesClientListBySubscriptionResponse struct {
	PrivateLinkServiceListResult
}

PrivateLinkServicesClientListBySubscriptionResponse contains the response from method PrivateLinkServicesClient.ListBySubscription.

type PrivateLinkServicesClientListOptions

type PrivateLinkServicesClientListOptions struct {
}

PrivateLinkServicesClientListOptions contains the optional parameters for the PrivateLinkServicesClient.List method.

type PrivateLinkServicesClientListPrivateEndpointConnectionsOptions

type PrivateLinkServicesClientListPrivateEndpointConnectionsOptions struct {
}

PrivateLinkServicesClientListPrivateEndpointConnectionsOptions contains the optional parameters for the PrivateLinkServicesClient.ListPrivateEndpointConnections method.

type PrivateLinkServicesClientListPrivateEndpointConnectionsResponse

type PrivateLinkServicesClientListPrivateEndpointConnectionsResponse struct {
	PrivateEndpointConnectionListResult
}

PrivateLinkServicesClientListPrivateEndpointConnectionsResponse contains the response from method PrivateLinkServicesClient.ListPrivateEndpointConnections.

type PrivateLinkServicesClientListResponse

type PrivateLinkServicesClientListResponse struct {
	PrivateLinkServiceListResult
}

PrivateLinkServicesClientListResponse contains the response from method PrivateLinkServicesClient.List.

type PrivateLinkServicesClientUpdatePrivateEndpointConnectionOptions

type PrivateLinkServicesClientUpdatePrivateEndpointConnectionOptions struct {
}

PrivateLinkServicesClientUpdatePrivateEndpointConnectionOptions contains the optional parameters for the PrivateLinkServicesClient.UpdatePrivateEndpointConnection method.

type PrivateLinkServicesClientUpdatePrivateEndpointConnectionResponse

type PrivateLinkServicesClientUpdatePrivateEndpointConnectionResponse struct {
	PrivateEndpointConnection
}

PrivateLinkServicesClientUpdatePrivateEndpointConnectionResponse contains the response 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.

func (Probe) MarshalJSON

func (p Probe) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Probe.

func (*Probe) UnmarshalJSON

func (p *Probe) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type 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 number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint.
	// After failing the number of consecutive probes equal to this value, the
	// endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in
	// rotation.
	ProbeThreshold *int32 `json:"probeThreshold,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.

func (*ProbePropertiesFormat) UnmarshalJSON

func (p *ProbePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

type Profile

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

func (p Profile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Profile.

func (*Profile) UnmarshalJSON

func (p *Profile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Profile.

type ProfileListResult

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

func (p ProfileListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProfileListResult.

func (*ProfileListResult) UnmarshalJSON

func (p *ProfileListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProfileListResult.

type ProfilePropertiesFormat

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

func (p ProfilePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProfilePropertiesFormat.

func (*ProfilePropertiesFormat) UnmarshalJSON

func (p *ProfilePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProfilePropertiesFormat.

type ProfilesClient

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

func NewProfilesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ProfilesClient, error)

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

func (client *ProfilesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkProfileName string, options *ProfilesClientBeginDeleteOptions) (*runtime.Poller[ProfilesClientDeleteResponse], error)

BeginDelete - Deletes the specified network profile. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkProfileDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewProfilesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "networkProfile1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ProfilesClient) CreateOrUpdate

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkProfileCreateConfigOnly.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewProfilesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "networkProfile1", armnetwork.Profile{
	Location: to.Ptr("westus"),
	Properties: &armnetwork.ProfilePropertiesFormat{
		ContainerNetworkInterfaceConfigurations: []*armnetwork.ContainerNetworkInterfaceConfiguration{
			{
				Name: to.Ptr("eth1"),
				Properties: &armnetwork.ContainerNetworkInterfaceConfigurationPropertiesFormat{
					IPConfigurations: []*armnetwork.IPConfigurationProfile{
						{
							Name: to.Ptr("ipconfig1"),
							Properties: &armnetwork.IPConfigurationProfilePropertiesFormat{
								Subnet: &armnetwork.Subnet{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1"),
								},
							},
						}},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ProfilesClient) Get

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. Generated from API version 2022-05-01 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 (GetNetworkProfile)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkProfileGetConfigOnly.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewProfilesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "networkProfile1", &armnetwork.ProfilesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetNetworkProfileWithContainerNetworkInterfaces)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkProfileGetWithContainerNic.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewProfilesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "networkProfile1", &armnetwork.ProfilesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ProfilesClient) NewListAllPager

NewListAllPager - Gets all the network profiles in a subscription. Generated from API version 2022-05-01 options - ProfilesClientListAllOptions contains the optional parameters for the ProfilesClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkProfileListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewProfilesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ProfilesClient) NewListPager

func (client *ProfilesClient) NewListPager(resourceGroupName string, options *ProfilesClientListOptions) *runtime.Pager[ProfilesClientListResponse]

NewListPager - Gets all network profiles in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - ProfilesClientListOptions contains the optional parameters for the ProfilesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkProfileList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewProfilesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ProfilesClient) UpdateTags

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkProfileUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewProfilesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-np", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ProfilesClientBeginDeleteOptions

type ProfilesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ProfilesClientBeginDeleteOptions contains the optional parameters for the ProfilesClient.BeginDelete method.

type ProfilesClientCreateOrUpdateOptions

type ProfilesClientCreateOrUpdateOptions struct {
}

ProfilesClientCreateOrUpdateOptions contains the optional parameters for the ProfilesClient.CreateOrUpdate method.

type ProfilesClientCreateOrUpdateResponse

type ProfilesClientCreateOrUpdateResponse struct {
	Profile
}

ProfilesClientCreateOrUpdateResponse contains the response from method ProfilesClient.CreateOrUpdate.

type ProfilesClientDeleteResponse

type ProfilesClientDeleteResponse struct {
}

ProfilesClientDeleteResponse contains the response from method ProfilesClient.Delete.

type ProfilesClientGetOptions

type ProfilesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

ProfilesClientGetOptions contains the optional parameters for the ProfilesClient.Get method.

type ProfilesClientGetResponse

type ProfilesClientGetResponse struct {
	Profile
}

ProfilesClientGetResponse contains the response from method ProfilesClient.Get.

type ProfilesClientListAllOptions

type ProfilesClientListAllOptions struct {
}

ProfilesClientListAllOptions contains the optional parameters for the ProfilesClient.ListAll method.

type ProfilesClientListAllResponse

type ProfilesClientListAllResponse struct {
	ProfileListResult
}

ProfilesClientListAllResponse contains the response from method ProfilesClient.ListAll.

type ProfilesClientListOptions

type ProfilesClientListOptions struct {
}

ProfilesClientListOptions contains the optional parameters for the ProfilesClient.List method.

type ProfilesClientListResponse

type ProfilesClientListResponse struct {
	ProfileListResult
}

ProfilesClientListResponse contains the response from method ProfilesClient.List.

type ProfilesClientUpdateTagsOptions

type ProfilesClientUpdateTagsOptions struct {
}

ProfilesClientUpdateTagsOptions contains the optional parameters for the ProfilesClient.UpdateTags method.

type ProfilesClientUpdateTagsResponse

type ProfilesClientUpdateTagsResponse struct {
	Profile
}

ProfilesClientUpdateTagsResponse contains the response 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.

func (*PropagatedRouteTable) UnmarshalJSON

func (p *PropagatedRouteTable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

type ProtocolConfiguration

type ProtocolConfiguration struct {
	// HTTP configuration of the connectivity check.
	HTTPConfiguration *HTTPConfiguration `json:"HTTPConfiguration,omitempty"`
}

ProtocolConfiguration - Configuration of the protocol.

func (ProtocolConfiguration) MarshalJSON

func (p ProtocolConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProtocolConfiguration.

func (*ProtocolConfiguration) UnmarshalJSON

func (p *ProtocolConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProtocolConfiguration.

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.

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.

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.

func (*PublicIPAddress) UnmarshalJSON

func (p *PublicIPAddress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PublicIPAddressDNSSettings) MarshalJSON

func (p PublicIPAddressDNSSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublicIPAddressDNSSettings.

func (*PublicIPAddressDNSSettings) UnmarshalJSON

func (p *PublicIPAddressDNSSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PublicIPAddressDNSSettings.

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.

func (*PublicIPAddressListResult) UnmarshalJSON

func (p *PublicIPAddressListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (*PublicIPAddressPropertiesFormat) UnmarshalJSON

func (p *PublicIPAddressPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PublicIPAddressSKU) MarshalJSON

func (p PublicIPAddressSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublicIPAddressSKU.

func (*PublicIPAddressSKU) UnmarshalJSON

func (p *PublicIPAddressSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PublicIPAddressSKU.

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.

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.

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, error)

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) (*runtime.Poller[PublicIPAddressesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a static or dynamic public IP address. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreatePublicIpAddressAllocationMethod)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpAddressCreateCustomizedValues.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-ip", armnetwork.PublicIPAddress{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.PublicIPAddressPropertiesFormat{
		IdleTimeoutInMinutes:     to.Ptr[int32](10),
		PublicIPAddressVersion:   to.Ptr(armnetwork.IPVersionIPv4),
		PublicIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodStatic),
	},
	SKU: &armnetwork.PublicIPAddressSKU{
		Name: to.Ptr(armnetwork.PublicIPAddressSKUNameStandard),
		Tier: to.Ptr(armnetwork.PublicIPAddressSKUTierGlobal),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreatePublicIpAddressDefaults)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpAddressCreateDefaults.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-ip", armnetwork.PublicIPAddress{
	Location: to.Ptr("eastus"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreatePublicIpAddressDns)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpAddressCreateDns.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-ip", armnetwork.PublicIPAddress{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.PublicIPAddressPropertiesFormat{
		DNSSettings: &armnetwork.PublicIPAddressDNSSettings{
			DomainNameLabel: to.Ptr("dnslbl"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PublicIPAddressesClient) BeginDdosProtectionStatus

BeginDdosProtectionStatus - Gets the Ddos Protection Status of a Public IP Address If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. publicIPAddressName - The name of the public IP address. options - PublicIPAddressesClientBeginDdosProtectionStatusOptions contains the optional parameters for the PublicIPAddressesClient.BeginDdosProtectionStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpAddressGetDdosProtectionStatus.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDdosProtectionStatus(ctx, "rg1", "test-pip", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PublicIPAddressesClient) BeginDelete

func (client *PublicIPAddressesClient) BeginDelete(ctx context.Context, resourceGroupName string, publicIPAddressName string, options *PublicIPAddressesClientBeginDeleteOptions) (*runtime.Poller[PublicIPAddressesClientDeleteResponse], error)

BeginDelete - Deletes the specified public IP address. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpAddressDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-ip", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpAddressGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testDNS-ip", &armnetwork.PublicIPAddressesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CloudServicePublicIpGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetCloudServicePublicIPAddress(ctx, "cs-tester", "cs1", "Test_VM_0", "nic1", "ip1", "pub1", &armnetwork.PublicIPAddressesClientGetCloudServicePublicIPAddressOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2018-10-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VmssPublicIpGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetVirtualMachineScaleSetPublicIPAddress(ctx, "vmss-tester", "vmss1", "1", "nic1", "ip1", "pub1", &armnetwork.PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PublicIPAddressesClient) NewListAllPager

NewListAllPager - Gets all the public IP addresses in a subscription. Generated from API version 2022-05-01 options - PublicIPAddressesClientListAllOptions contains the optional parameters for the PublicIPAddressesClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpAddressListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PublicIPAddressesClient) NewListCloudServicePublicIPAddressesPager

NewListCloudServicePublicIPAddressesPager - Gets information about all public IP addresses on a cloud service level. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CloudServicePublicIpListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListCloudServicePublicIPAddressesPager("cs-tester", "cs1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PublicIPAddressesClient) NewListCloudServiceRoleInstancePublicIPAddressesPager

func (client *PublicIPAddressesClient) NewListCloudServiceRoleInstancePublicIPAddressesPager(resourceGroupName string, cloudServiceName string, roleInstanceName string, networkInterfaceName string, ipConfigurationName string, options *PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesOptions) *runtime.Pager[PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResponse]

NewListCloudServiceRoleInstancePublicIPAddressesPager - Gets information about all public IP addresses in a role instance IP configuration in a cloud service. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CloudServiceRoleInstancePublicIpList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListCloudServiceRoleInstancePublicIPAddressesPager("cs-tester", "cs1", "Test_VM_0", "nic1", "ip1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PublicIPAddressesClient) NewListPager

NewListPager - Gets all public IP addresses in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - PublicIPAddressesClientListOptions contains the optional parameters for the PublicIPAddressesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpAddressList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PublicIPAddressesClient) NewListVirtualMachineScaleSetPublicIPAddressesPager

func (client *PublicIPAddressesClient) NewListVirtualMachineScaleSetPublicIPAddressesPager(resourceGroupName string, virtualMachineScaleSetName string, options *PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesOptions) *runtime.Pager[PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResponse]

NewListVirtualMachineScaleSetPublicIPAddressesPager - Gets information about all public IP addresses on a virtual machine scale set level. Generated from API version 2018-10-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VmssPublicIpListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListVirtualMachineScaleSetPublicIPAddressesPager("vmss-tester", "vmss1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PublicIPAddressesClient) NewListVirtualMachineScaleSetVMPublicIPAddressesPager

func (client *PublicIPAddressesClient) NewListVirtualMachineScaleSetVMPublicIPAddressesPager(resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, ipConfigurationName string, options *PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesOptions) *runtime.Pager[PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResponse]

NewListVirtualMachineScaleSetVMPublicIPAddressesPager - Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set. Generated from API version 2018-10-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VmssVmPublicIpList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListVirtualMachineScaleSetVMPublicIPAddressesPager("vmss-tester", "vmss1", "1", "nic1", "ip1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpAddressUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPAddressesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-ip", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type PublicIPAddressesClientBeginCreateOrUpdateOptions

type PublicIPAddressesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PublicIPAddressesClientBeginCreateOrUpdateOptions contains the optional parameters for the PublicIPAddressesClient.BeginCreateOrUpdate method.

type PublicIPAddressesClientBeginDdosProtectionStatusOptions

type PublicIPAddressesClientBeginDdosProtectionStatusOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PublicIPAddressesClientBeginDdosProtectionStatusOptions contains the optional parameters for the PublicIPAddressesClient.BeginDdosProtectionStatus method.

type PublicIPAddressesClientBeginDeleteOptions

type PublicIPAddressesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PublicIPAddressesClientBeginDeleteOptions contains the optional parameters for the PublicIPAddressesClient.BeginDelete method.

type PublicIPAddressesClientCreateOrUpdateResponse

type PublicIPAddressesClientCreateOrUpdateResponse struct {
	PublicIPAddress
}

PublicIPAddressesClientCreateOrUpdateResponse contains the response from method PublicIPAddressesClient.CreateOrUpdate.

type PublicIPAddressesClientDdosProtectionStatusResponse

type PublicIPAddressesClientDdosProtectionStatusResponse struct {
	PublicIPDdosProtectionStatusResult
}

PublicIPAddressesClientDdosProtectionStatusResponse contains the response from method PublicIPAddressesClient.DdosProtectionStatus.

type PublicIPAddressesClientDeleteResponse

type PublicIPAddressesClientDeleteResponse struct {
}

PublicIPAddressesClientDeleteResponse contains the response from method PublicIPAddressesClient.Delete.

type PublicIPAddressesClientGetCloudServicePublicIPAddressOptions

type PublicIPAddressesClientGetCloudServicePublicIPAddressOptions struct {
	// Expands referenced resources.
	Expand *string
}

PublicIPAddressesClientGetCloudServicePublicIPAddressOptions contains the optional parameters for the PublicIPAddressesClient.GetCloudServicePublicIPAddress method.

type PublicIPAddressesClientGetCloudServicePublicIPAddressResponse

type PublicIPAddressesClientGetCloudServicePublicIPAddressResponse struct {
	PublicIPAddress
}

PublicIPAddressesClientGetCloudServicePublicIPAddressResponse contains the response from method PublicIPAddressesClient.GetCloudServicePublicIPAddress.

type PublicIPAddressesClientGetOptions

type PublicIPAddressesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

PublicIPAddressesClientGetOptions contains the optional parameters for the PublicIPAddressesClient.Get method.

type PublicIPAddressesClientGetResponse

type PublicIPAddressesClientGetResponse struct {
	PublicIPAddress
}

PublicIPAddressesClientGetResponse contains the response from method PublicIPAddressesClient.Get.

type PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressOptions

type PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressOptions struct {
	// Expands referenced resources.
	Expand *string
}

PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressOptions contains the optional parameters for the PublicIPAddressesClient.GetVirtualMachineScaleSetPublicIPAddress method.

type PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResponse

type PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResponse struct {
	PublicIPAddress
}

PublicIPAddressesClientGetVirtualMachineScaleSetPublicIPAddressResponse contains the response from method PublicIPAddressesClient.GetVirtualMachineScaleSetPublicIPAddress.

type PublicIPAddressesClientListAllOptions

type PublicIPAddressesClientListAllOptions struct {
}

PublicIPAddressesClientListAllOptions contains the optional parameters for the PublicIPAddressesClient.ListAll method.

type PublicIPAddressesClientListAllResponse

type PublicIPAddressesClientListAllResponse struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListAllResponse contains the response from method PublicIPAddressesClient.ListAll.

type PublicIPAddressesClientListCloudServicePublicIPAddressesOptions

type PublicIPAddressesClientListCloudServicePublicIPAddressesOptions struct {
}

PublicIPAddressesClientListCloudServicePublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListCloudServicePublicIPAddresses method.

type PublicIPAddressesClientListCloudServicePublicIPAddressesResponse

type PublicIPAddressesClientListCloudServicePublicIPAddressesResponse struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListCloudServicePublicIPAddressesResponse contains the response from method PublicIPAddressesClient.ListCloudServicePublicIPAddresses.

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesOptions

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesOptions struct {
}

PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListCloudServiceRoleInstancePublicIPAddresses method.

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResponse

type PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResponse struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListCloudServiceRoleInstancePublicIPAddressesResponse contains the response from method PublicIPAddressesClient.ListCloudServiceRoleInstancePublicIPAddresses.

type PublicIPAddressesClientListOptions

type PublicIPAddressesClientListOptions struct {
}

PublicIPAddressesClientListOptions contains the optional parameters for the PublicIPAddressesClient.List method.

type PublicIPAddressesClientListResponse

type PublicIPAddressesClientListResponse struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListResponse contains the response from method PublicIPAddressesClient.List.

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesOptions

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesOptions struct {
}

PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListVirtualMachineScaleSetPublicIPAddresses method.

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResponse

type PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResponse struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListVirtualMachineScaleSetPublicIPAddressesResponse contains the response from method PublicIPAddressesClient.ListVirtualMachineScaleSetPublicIPAddresses.

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesOptions

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesOptions struct {
}

PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesOptions contains the optional parameters for the PublicIPAddressesClient.ListVirtualMachineScaleSetVMPublicIPAddresses method.

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResponse

type PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResponse struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListVirtualMachineScaleSetVMPublicIPAddressesResponse contains the response from method PublicIPAddressesClient.ListVirtualMachineScaleSetVMPublicIPAddresses.

type PublicIPAddressesClientUpdateTagsOptions

type PublicIPAddressesClientUpdateTagsOptions struct {
}

PublicIPAddressesClientUpdateTagsOptions contains the optional parameters for the PublicIPAddressesClient.UpdateTags method.

type PublicIPAddressesClientUpdateTagsResponse

type PublicIPAddressesClientUpdateTagsResponse struct {
	PublicIPAddress
}

PublicIPAddressesClientUpdateTagsResponse contains the response from method PublicIPAddressesClient.UpdateTags.

type PublicIPDdosProtectionStatusResult

type PublicIPDdosProtectionStatusResult struct {
	// DDoS protection plan Resource Id of a if IP address is protected through a plan.
	DdosProtectionPlanID *string `json:"ddosProtectionPlanId,omitempty"`

	// Value indicating whether the IP address is DDoS workload protected or not.
	IsWorkloadProtected *IsWorkloadProtected `json:"isWorkloadProtected,omitempty"`

	// IP Address of the Public IP Resource
	PublicIPAddress *string `json:"publicIpAddress,omitempty"`

	// Public IP ARM resource ID
	PublicIPAddressID *string `json:"publicIpAddressId,omitempty"`
}

PublicIPDdosProtectionStatusResult - Response for GetPublicIpAddressDdosProtectionStatusOperation API service call.

func (PublicIPDdosProtectionStatusResult) MarshalJSON

func (p PublicIPDdosProtectionStatusResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublicIPDdosProtectionStatusResult.

func (*PublicIPDdosProtectionStatusResult) UnmarshalJSON

func (p *PublicIPDdosProtectionStatusResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PublicIPDdosProtectionStatusResult.

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.

func (*PublicIPPrefix) UnmarshalJSON

func (p *PublicIPPrefix) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*PublicIPPrefixListResult) UnmarshalJSON

func (p *PublicIPPrefixListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*PublicIPPrefixPropertiesFormat) UnmarshalJSON

func (p *PublicIPPrefixPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (PublicIPPrefixSKU) MarshalJSON

func (p PublicIPPrefixSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublicIPPrefixSKU.

func (*PublicIPPrefixSKU) UnmarshalJSON

func (p *PublicIPPrefixSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PublicIPPrefixSKU.

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.

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.

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, error)

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) (*runtime.Poller[PublicIPPrefixesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a static or dynamic public IP prefix. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreatePublicIpPrefixAllocationMethod)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpPrefixCreateCustomizedValues.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-ipprefix", armnetwork.PublicIPPrefix{
	Location: to.Ptr("westus"),
	Properties: &armnetwork.PublicIPPrefixPropertiesFormat{
		PrefixLength:           to.Ptr[int32](30),
		PublicIPAddressVersion: to.Ptr(armnetwork.IPVersionIPv4),
	},
	SKU: &armnetwork.PublicIPPrefixSKU{
		Name: to.Ptr(armnetwork.PublicIPPrefixSKUNameStandard),
		Tier: to.Ptr(armnetwork.PublicIPPrefixSKUTierRegional),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreatePublicIpPrefixDefaults)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpPrefixCreateDefaults.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-ipprefix", armnetwork.PublicIPPrefix{
	Location: to.Ptr("westus"),
	Properties: &armnetwork.PublicIPPrefixPropertiesFormat{
		PrefixLength: to.Ptr[int32](30),
	},
	SKU: &armnetwork.PublicIPPrefixSKU{
		Name: to.Ptr(armnetwork.PublicIPPrefixSKUNameStandard),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PublicIPPrefixesClient) BeginDelete

func (client *PublicIPPrefixesClient) BeginDelete(ctx context.Context, resourceGroupName string, publicIPPrefixName string, options *PublicIPPrefixesClientBeginDeleteOptions) (*runtime.Poller[PublicIPPrefixesClientDeleteResponse], error)

BeginDelete - Deletes the specified public IP prefix. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpPrefixDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-ipprefix", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpPrefixGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "test-ipprefix", &armnetwork.PublicIPPrefixesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*PublicIPPrefixesClient) NewListAllPager

NewListAllPager - Gets all the public IP prefixes in a subscription. Generated from API version 2022-05-01 options - PublicIPPrefixesClientListAllOptions contains the optional parameters for the PublicIPPrefixesClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpPrefixListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*PublicIPPrefixesClient) NewListPager

NewListPager - Gets all public IP prefixes in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - PublicIPPrefixesClientListOptions contains the optional parameters for the PublicIPPrefixesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpPrefixList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/PublicIpPrefixUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewPublicIPPrefixesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-ipprefix", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type PublicIPPrefixesClientBeginCreateOrUpdateOptions

type PublicIPPrefixesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PublicIPPrefixesClientBeginCreateOrUpdateOptions contains the optional parameters for the PublicIPPrefixesClient.BeginCreateOrUpdate method.

type PublicIPPrefixesClientBeginDeleteOptions

type PublicIPPrefixesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PublicIPPrefixesClientBeginDeleteOptions contains the optional parameters for the PublicIPPrefixesClient.BeginDelete method.

type PublicIPPrefixesClientCreateOrUpdateResponse

type PublicIPPrefixesClientCreateOrUpdateResponse struct {
	PublicIPPrefix
}

PublicIPPrefixesClientCreateOrUpdateResponse contains the response from method PublicIPPrefixesClient.CreateOrUpdate.

type PublicIPPrefixesClientDeleteResponse

type PublicIPPrefixesClientDeleteResponse struct {
}

PublicIPPrefixesClientDeleteResponse contains the response from method PublicIPPrefixesClient.Delete.

type PublicIPPrefixesClientGetOptions

type PublicIPPrefixesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

PublicIPPrefixesClientGetOptions contains the optional parameters for the PublicIPPrefixesClient.Get method.

type PublicIPPrefixesClientGetResponse

type PublicIPPrefixesClientGetResponse struct {
	PublicIPPrefix
}

PublicIPPrefixesClientGetResponse contains the response from method PublicIPPrefixesClient.Get.

type PublicIPPrefixesClientListAllOptions

type PublicIPPrefixesClientListAllOptions struct {
}

PublicIPPrefixesClientListAllOptions contains the optional parameters for the PublicIPPrefixesClient.ListAll method.

type PublicIPPrefixesClientListAllResponse

type PublicIPPrefixesClientListAllResponse struct {
	PublicIPPrefixListResult
}

PublicIPPrefixesClientListAllResponse contains the response from method PublicIPPrefixesClient.ListAll.

type PublicIPPrefixesClientListOptions

type PublicIPPrefixesClientListOptions struct {
}

PublicIPPrefixesClientListOptions contains the optional parameters for the PublicIPPrefixesClient.List method.

type PublicIPPrefixesClientListResponse

type PublicIPPrefixesClientListResponse struct {
	PublicIPPrefixListResult
}

PublicIPPrefixesClientListResponse contains the response from method PublicIPPrefixesClient.List.

type PublicIPPrefixesClientUpdateTagsOptions

type PublicIPPrefixesClientUpdateTagsOptions struct {
}

PublicIPPrefixesClientUpdateTagsOptions contains the optional parameters for the PublicIPPrefixesClient.UpdateTags method.

type PublicIPPrefixesClientUpdateTagsResponse

type PublicIPPrefixesClientUpdateTagsResponse struct {
	PublicIPPrefix
}

PublicIPPrefixesClientUpdateTagsResponse contains the response 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.

func (*QosDefinition) UnmarshalJSON

func (q *QosDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (QosIPRange) MarshalJSON

func (q QosIPRange) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QosIPRange.

func (*QosIPRange) UnmarshalJSON

func (q *QosIPRange) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QosIPRange.

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.

func (QosPortRange) MarshalJSON

func (q QosPortRange) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QosPortRange.

func (*QosPortRange) UnmarshalJSON

func (q *QosPortRange) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QosPortRange.

type QueryInboundNatRulePortMappingRequest

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

func (QueryInboundNatRulePortMappingRequest) MarshalJSON

func (q QueryInboundNatRulePortMappingRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QueryInboundNatRulePortMappingRequest.

func (*QueryInboundNatRulePortMappingRequest) UnmarshalJSON

func (q *QueryInboundNatRulePortMappingRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QueryInboundNatRulePortMappingRequest.

type QueryRequestOptions

type QueryRequestOptions struct {
	// When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current
	// request) to retrieve the next page of data.
	SkipToken *string `json:"skipToken,omitempty"`
}

QueryRequestOptions - Query Request Options

func (QueryRequestOptions) MarshalJSON

func (q QueryRequestOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QueryRequestOptions.

func (*QueryRequestOptions) UnmarshalJSON

func (q *QueryRequestOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QueryRequestOptions.

type QueryResults

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

func (q QueryResults) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QueryResults.

func (*QueryResults) UnmarshalJSON

func (q *QueryResults) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (QueryTroubleshootingParameters) MarshalJSON

func (q QueryTroubleshootingParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QueryTroubleshootingParameters.

func (*QueryTroubleshootingParameters) UnmarshalJSON

func (q *QueryTroubleshootingParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QueryTroubleshootingParameters.

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.

func (RadiusServer) MarshalJSON

func (r RadiusServer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RadiusServer.

func (*RadiusServer) UnmarshalJSON

func (r *RadiusServer) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RadiusServer.

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.

func (*RecordSet) UnmarshalJSON

func (r *RecordSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecordSet.

type ReferencedPublicIPAddress

type ReferencedPublicIPAddress struct {
	// The PublicIPAddress Reference.
	ID *string `json:"id,omitempty"`
}

ReferencedPublicIPAddress - Reference to a public IP address.

func (ReferencedPublicIPAddress) MarshalJSON

func (r ReferencedPublicIPAddress) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReferencedPublicIPAddress.

func (*ReferencedPublicIPAddress) UnmarshalJSON

func (r *ReferencedPublicIPAddress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReferencedPublicIPAddress.

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.

func (*Resource) UnmarshalJSON

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (ResourceNavigationLink) MarshalJSON

func (r ResourceNavigationLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceNavigationLink.

func (*ResourceNavigationLink) UnmarshalJSON

func (r *ResourceNavigationLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceNavigationLink.

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.

func (ResourceNavigationLinkFormat) MarshalJSON

func (r ResourceNavigationLinkFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceNavigationLinkFormat.

func (*ResourceNavigationLinkFormat) UnmarshalJSON

func (r *ResourceNavigationLinkFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceNavigationLinkFormat.

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, error)

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGetResourceNavigationLinks.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewResourceNavigationLinksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx, "rg1", "vnet", "subnet", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ResourceNavigationLinksClientListOptions

type ResourceNavigationLinksClientListOptions struct {
}

ResourceNavigationLinksClientListOptions contains the optional parameters for the ResourceNavigationLinksClient.List method.

type ResourceNavigationLinksClientListResponse

type ResourceNavigationLinksClientListResponse struct {
	ResourceNavigationLinksListResult
}

ResourceNavigationLinksClientListResponse contains the response 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.

func (*ResourceNavigationLinksListResult) UnmarshalJSON

func (r *ResourceNavigationLinksListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ResourceSet) UnmarshalJSON

func (r *ResourceSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (RetentionPolicyParameters) MarshalJSON

func (r RetentionPolicyParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RetentionPolicyParameters.

func (*RetentionPolicyParameters) UnmarshalJSON

func (r *RetentionPolicyParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RetentionPolicyParameters.

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.

func (Route) MarshalJSON

func (r Route) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Route.

func (*Route) UnmarshalJSON

func (r *Route) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Route.

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.

func (*RouteFilter) UnmarshalJSON

func (r *RouteFilter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*RouteFilterListResult) UnmarshalJSON

func (r *RouteFilterListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*RouteFilterPropertiesFormat) UnmarshalJSON

func (r *RouteFilterPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (RouteFilterRule) MarshalJSON

func (r RouteFilterRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteFilterRule.

func (*RouteFilterRule) UnmarshalJSON

func (r *RouteFilterRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RouteFilterRule.

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.

func (*RouteFilterRuleListResult) UnmarshalJSON

func (r *RouteFilterRuleListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*RouteFilterRulePropertiesFormat) UnmarshalJSON

func (r *RouteFilterRulePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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, error)

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) (*runtime.Poller[RouteFilterRulesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a route in the specified route filter. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteFilterRuleCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteFilterRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "filterName", "ruleName", armnetwork.RouteFilterRule{
	Properties: &armnetwork.RouteFilterRulePropertiesFormat{
		Access: to.Ptr(armnetwork.AccessAllow),
		Communities: []*string{
			to.Ptr("12076:5030"),
			to.Ptr("12076:5040")},
		RouteFilterRuleType: to.Ptr(armnetwork.RouteFilterRuleTypeCommunity),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RouteFilterRulesClient) BeginDelete

func (client *RouteFilterRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, routeFilterName string, ruleName string, options *RouteFilterRulesClientBeginDeleteOptions) (*runtime.Poller[RouteFilterRulesClientDeleteResponse], error)

BeginDelete - Deletes the specified rule from a route filter. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteFilterRuleDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteFilterRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "filterName", "ruleName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteFilterRuleGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteFilterRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "filterName", "filterName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RouteFilterRulesClient) NewListByRouteFilterPager

func (client *RouteFilterRulesClient) NewListByRouteFilterPager(resourceGroupName string, routeFilterName string, options *RouteFilterRulesClientListByRouteFilterOptions) *runtime.Pager[RouteFilterRulesClientListByRouteFilterResponse]

NewListByRouteFilterPager - Gets all RouteFilterRules in a route filter. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteFilterRuleListByRouteFilter.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteFilterRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByRouteFilterPager("rg1", "filterName", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type RouteFilterRulesClientBeginCreateOrUpdateOptions

type RouteFilterRulesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RouteFilterRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteFilterRulesClient.BeginCreateOrUpdate method.

type RouteFilterRulesClientBeginDeleteOptions

type RouteFilterRulesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RouteFilterRulesClientBeginDeleteOptions contains the optional parameters for the RouteFilterRulesClient.BeginDelete method.

type RouteFilterRulesClientCreateOrUpdateResponse

type RouteFilterRulesClientCreateOrUpdateResponse struct {
	RouteFilterRule
}

RouteFilterRulesClientCreateOrUpdateResponse contains the response from method RouteFilterRulesClient.CreateOrUpdate.

type RouteFilterRulesClientDeleteResponse

type RouteFilterRulesClientDeleteResponse struct {
}

RouteFilterRulesClientDeleteResponse contains the response from method RouteFilterRulesClient.Delete.

type RouteFilterRulesClientGetOptions

type RouteFilterRulesClientGetOptions struct {
}

RouteFilterRulesClientGetOptions contains the optional parameters for the RouteFilterRulesClient.Get method.

type RouteFilterRulesClientGetResponse

type RouteFilterRulesClientGetResponse struct {
	RouteFilterRule
}

RouteFilterRulesClientGetResponse contains the response from method RouteFilterRulesClient.Get.

type RouteFilterRulesClientListByRouteFilterOptions

type RouteFilterRulesClientListByRouteFilterOptions struct {
}

RouteFilterRulesClientListByRouteFilterOptions contains the optional parameters for the RouteFilterRulesClient.ListByRouteFilter method.

type RouteFilterRulesClientListByRouteFilterResponse

type RouteFilterRulesClientListByRouteFilterResponse struct {
	RouteFilterRuleListResult
}

RouteFilterRulesClientListByRouteFilterResponse contains the response 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, error)

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) (*runtime.Poller[RouteFiltersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a route filter in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteFilterCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteFiltersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "filterName", armnetwork.RouteFilter{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.RouteFilterPropertiesFormat{
		Rules: []*armnetwork.RouteFilterRule{
			{
				Name: to.Ptr("ruleName"),
				Properties: &armnetwork.RouteFilterRulePropertiesFormat{
					Access: to.Ptr(armnetwork.AccessAllow),
					Communities: []*string{
						to.Ptr("12076:5030"),
						to.Ptr("12076:5040")},
					RouteFilterRuleType: to.Ptr(armnetwork.RouteFilterRuleTypeCommunity),
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RouteFiltersClient) BeginDelete

func (client *RouteFiltersClient) BeginDelete(ctx context.Context, resourceGroupName string, routeFilterName string, options *RouteFiltersClientBeginDeleteOptions) (*runtime.Poller[RouteFiltersClientDeleteResponse], error)

BeginDelete - Deletes the specified route filter. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteFilterDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteFiltersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "filterName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteFilterGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteFiltersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "filterName", &armnetwork.RouteFiltersClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RouteFiltersClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Gets all route filters in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - RouteFiltersClientListByResourceGroupOptions contains the optional parameters for the RouteFiltersClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteFilterListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteFiltersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*RouteFiltersClient) NewListPager

NewListPager - Gets all route filters in a subscription. Generated from API version 2022-05-01 options - RouteFiltersClientListOptions contains the optional parameters for the RouteFiltersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteFilterList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteFiltersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteFilterUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteFiltersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "filterName", armnetwork.TagsObject{
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type RouteFiltersClientBeginCreateOrUpdateOptions

type RouteFiltersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RouteFiltersClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteFiltersClient.BeginCreateOrUpdate method.

type RouteFiltersClientBeginDeleteOptions

type RouteFiltersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RouteFiltersClientBeginDeleteOptions contains the optional parameters for the RouteFiltersClient.BeginDelete method.

type RouteFiltersClientCreateOrUpdateResponse

type RouteFiltersClientCreateOrUpdateResponse struct {
	RouteFilter
}

RouteFiltersClientCreateOrUpdateResponse contains the response from method RouteFiltersClient.CreateOrUpdate.

type RouteFiltersClientDeleteResponse

type RouteFiltersClientDeleteResponse struct {
}

RouteFiltersClientDeleteResponse contains the response from method RouteFiltersClient.Delete.

type RouteFiltersClientGetOptions

type RouteFiltersClientGetOptions struct {
	// Expands referenced express route bgp peering resources.
	Expand *string
}

RouteFiltersClientGetOptions contains the optional parameters for the RouteFiltersClient.Get method.

type RouteFiltersClientGetResponse

type RouteFiltersClientGetResponse struct {
	RouteFilter
}

RouteFiltersClientGetResponse contains the response from method RouteFiltersClient.Get.

type RouteFiltersClientListByResourceGroupOptions

type RouteFiltersClientListByResourceGroupOptions struct {
}

RouteFiltersClientListByResourceGroupOptions contains the optional parameters for the RouteFiltersClient.ListByResourceGroup method.

type RouteFiltersClientListByResourceGroupResponse

type RouteFiltersClientListByResourceGroupResponse struct {
	RouteFilterListResult
}

RouteFiltersClientListByResourceGroupResponse contains the response from method RouteFiltersClient.ListByResourceGroup.

type RouteFiltersClientListOptions

type RouteFiltersClientListOptions struct {
}

RouteFiltersClientListOptions contains the optional parameters for the RouteFiltersClient.List method.

type RouteFiltersClientListResponse

type RouteFiltersClientListResponse struct {
	RouteFilterListResult
}

RouteFiltersClientListResponse contains the response from method RouteFiltersClient.List.

type RouteFiltersClientUpdateTagsOptions

type RouteFiltersClientUpdateTagsOptions struct {
}

RouteFiltersClientUpdateTagsOptions contains the optional parameters for the RouteFiltersClient.UpdateTags method.

type RouteFiltersClientUpdateTagsResponse

type RouteFiltersClientUpdateTagsResponse struct {
	RouteFilter
}

RouteFiltersClientUpdateTagsResponse contains the response 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.

func (*RouteListResult) UnmarshalJSON

func (r *RouteListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RouteListResult.

type RouteMap

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

	// Properties of the RouteMap resource.
	Properties *RouteMapProperties `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"`

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

RouteMap - The RouteMap child resource of a Virtual hub.

func (RouteMap) MarshalJSON

func (r RouteMap) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteMap.

func (*RouteMap) UnmarshalJSON

func (r *RouteMap) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RouteMap.

type RouteMapActionType

type RouteMapActionType string

RouteMapActionType - Kind of actions which can be taken on a matched route. Add, Replace, Remove refer to parameters on the route, like community or prefix

const (
	RouteMapActionTypeAdd     RouteMapActionType = "Add"
	RouteMapActionTypeDrop    RouteMapActionType = "Drop"
	RouteMapActionTypeRemove  RouteMapActionType = "Remove"
	RouteMapActionTypeReplace RouteMapActionType = "Replace"
	RouteMapActionTypeUnknown RouteMapActionType = "Unknown"
)

func PossibleRouteMapActionTypeValues

func PossibleRouteMapActionTypeValues() []RouteMapActionType

PossibleRouteMapActionTypeValues returns the possible values for the RouteMapActionType const type.

type RouteMapMatchCondition

type RouteMapMatchCondition string

RouteMapMatchCondition - Match condition to apply RouteMap rules.

const (
	RouteMapMatchConditionContains    RouteMapMatchCondition = "Contains"
	RouteMapMatchConditionEquals      RouteMapMatchCondition = "Equals"
	RouteMapMatchConditionNotContains RouteMapMatchCondition = "NotContains"
	RouteMapMatchConditionNotEquals   RouteMapMatchCondition = "NotEquals"
	RouteMapMatchConditionUnknown     RouteMapMatchCondition = "Unknown"
)

func PossibleRouteMapMatchConditionValues

func PossibleRouteMapMatchConditionValues() []RouteMapMatchCondition

PossibleRouteMapMatchConditionValues returns the possible values for the RouteMapMatchCondition const type.

type RouteMapProperties

type RouteMapProperties struct {
	// List of connections which have this RoutMap associated for inbound traffic.
	AssociatedInboundConnections []*string `json:"associatedInboundConnections,omitempty"`

	// List of connections which have this RoutMap associated for outbound traffic.
	AssociatedOutboundConnections []*string `json:"associatedOutboundConnections,omitempty"`

	// List of RouteMap rules to be applied.
	Rules []*RouteMapRule `json:"rules,omitempty"`

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

RouteMapProperties - Properties of RouteMap resource

func (RouteMapProperties) MarshalJSON

func (r RouteMapProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteMapProperties.

func (*RouteMapProperties) UnmarshalJSON

func (r *RouteMapProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RouteMapProperties.

type RouteMapRule

type RouteMapRule struct {
	// List of actions which will be applied on a match.
	Actions []*Action `json:"actions,omitempty"`

	// List of matching criterion which will be applied to traffic.
	MatchCriteria []*Criterion `json:"matchCriteria,omitempty"`

	// The unique name for the rule.
	Name *string `json:"name,omitempty"`

	// Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'.
	NextStepIfMatched *NextStep `json:"nextStepIfMatched,omitempty"`
}

RouteMapRule - A RouteMap Rule.

func (RouteMapRule) MarshalJSON

func (r RouteMapRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RouteMapRule.

func (*RouteMapRule) UnmarshalJSON

func (r *RouteMapRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RouteMapRule.

type RouteMapsClient

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

RouteMapsClient contains the methods for the RouteMaps group. Don't use this type directly, use NewRouteMapsClient() instead.

func NewRouteMapsClient

func NewRouteMapsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RouteMapsClient, error)

NewRouteMapsClient creates a new instance of RouteMapsClient 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 (*RouteMapsClient) BeginCreateOrUpdate

func (client *RouteMapsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualHubName string, routeMapName string, routeMapParameters RouteMap, options *RouteMapsClientBeginCreateOrUpdateOptions) (*runtime.Poller[RouteMapsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates a RouteMap if it doesn't exist else updates the existing one. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the RouteMap's resource group. virtualHubName - The name of the VirtualHub containing the RouteMap. routeMapName - The name of the RouteMap. routeMapParameters - Parameters supplied to create or update a RouteMap. options - RouteMapsClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteMapsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteMapPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteMapsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "virtualHub1", "routeMap1", armnetwork.RouteMap{
	Properties: &armnetwork.RouteMapProperties{
		AssociatedInboundConnections: []*string{
			to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1")},
		AssociatedOutboundConnections: []*string{},
		Rules: []*armnetwork.RouteMapRule{
			{
				Name: to.Ptr("rule1"),
				Actions: []*armnetwork.Action{
					{
						Type: to.Ptr(armnetwork.RouteMapActionTypeAdd),
						Parameters: []*armnetwork.Parameter{
							{
								AsPath: []*string{
									to.Ptr("22334")},
								Community:   []*string{},
								RoutePrefix: []*string{},
							}},
					}},
				MatchCriteria: []*armnetwork.Criterion{
					{
						AsPath:         []*string{},
						Community:      []*string{},
						MatchCondition: to.Ptr(armnetwork.RouteMapMatchConditionContains),
						RoutePrefix: []*string{
							to.Ptr("10.0.0.0/8")},
					}},
				NextStepIfMatched: to.Ptr(armnetwork.NextStepContinue),
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RouteMapsClient) BeginDelete

func (client *RouteMapsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, routeMapName string, options *RouteMapsClientBeginDeleteOptions) (*runtime.Poller[RouteMapsClientDeleteResponse], error)

BeginDelete - Deletes a RouteMap. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the RouteMap's resource group. virtualHubName - The name of the VirtualHub containing the RouteMap. routeMapName - The name of the RouteMap. options - RouteMapsClientBeginDeleteOptions contains the optional parameters for the RouteMapsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteMapDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteMapsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "virtualHub1", "routeMap1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*RouteMapsClient) Get

func (client *RouteMapsClient) Get(ctx context.Context, resourceGroupName string, virtualHubName string, routeMapName string, options *RouteMapsClientGetOptions) (RouteMapsClientGetResponse, error)

Get - Retrieves the details of a RouteMap. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the RouteMap's resource group. virtualHubName - The name of the VirtualHub containing the RouteMap. routeMapName - The name of the RouteMap. options - RouteMapsClientGetOptions contains the optional parameters for the RouteMapsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteMapGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteMapsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "virtualHub1", "routeMap1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RouteMapsClient) NewListPager

func (client *RouteMapsClient) NewListPager(resourceGroupName string, virtualHubName string, options *RouteMapsClientListOptions) *runtime.Pager[RouteMapsClientListResponse]

NewListPager - Retrieves the details of all RouteMaps. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the RouteMap's resource group'. virtualHubName - The name of the VirtualHub containing the RouteMap. options - RouteMapsClientListOptions contains the optional parameters for the RouteMapsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteMapList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteMapsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "virtualHub1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type RouteMapsClientBeginCreateOrUpdateOptions

type RouteMapsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RouteMapsClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteMapsClient.BeginCreateOrUpdate method.

type RouteMapsClientBeginDeleteOptions

type RouteMapsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RouteMapsClientBeginDeleteOptions contains the optional parameters for the RouteMapsClient.BeginDelete method.

type RouteMapsClientCreateOrUpdateResponse

type RouteMapsClientCreateOrUpdateResponse struct {
	RouteMap
}

RouteMapsClientCreateOrUpdateResponse contains the response from method RouteMapsClient.CreateOrUpdate.

type RouteMapsClientDeleteResponse

type RouteMapsClientDeleteResponse struct {
}

RouteMapsClientDeleteResponse contains the response from method RouteMapsClient.Delete.

type RouteMapsClientGetOptions

type RouteMapsClientGetOptions struct {
}

RouteMapsClientGetOptions contains the optional parameters for the RouteMapsClient.Get method.

type RouteMapsClientGetResponse

type RouteMapsClientGetResponse struct {
	RouteMap
}

RouteMapsClientGetResponse contains the response from method RouteMapsClient.Get.

type RouteMapsClientListOptions

type RouteMapsClientListOptions struct {
}

RouteMapsClientListOptions contains the optional parameters for the RouteMapsClient.List method.

type RouteMapsClientListResponse

type RouteMapsClientListResponse struct {
	ListRouteMapsResult
}

RouteMapsClientListResponse contains the response from method RouteMapsClient.List.

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.

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.

func (RoutePropertiesFormat) MarshalJSON

func (r RoutePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoutePropertiesFormat.

func (*RoutePropertiesFormat) UnmarshalJSON

func (r *RoutePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutePropertiesFormat.

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.

func (*RouteTable) UnmarshalJSON

func (r *RouteTable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*RouteTableListResult) UnmarshalJSON

func (r *RouteTableListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*RouteTablePropertiesFormat) UnmarshalJSON

func (r *RouteTablePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[RouteTablesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or updates a route table in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateRouteTable)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testrt", armnetwork.RouteTable{
	Location: to.Ptr("westus"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateRouteTableWithRoute)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableCreateWithRoute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testrt", armnetwork.RouteTable{
	Location: to.Ptr("westus"),
	Properties: &armnetwork.RouteTablePropertiesFormat{
		DisableBgpRoutePropagation: to.Ptr(true),
		Routes: []*armnetwork.Route{
			{
				Name: to.Ptr("route1"),
				Properties: &armnetwork.RoutePropertiesFormat{
					AddressPrefix: to.Ptr("10.0.3.0/24"),
					NextHopType:   to.Ptr(armnetwork.RouteNextHopTypeVirtualNetworkGateway),
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RouteTablesClient) BeginDelete

func (client *RouteTablesClient) BeginDelete(ctx context.Context, resourceGroupName string, routeTableName string, options *RouteTablesClientBeginDeleteOptions) (*runtime.Poller[RouteTablesClientDeleteResponse], error)

BeginDelete - Deletes the specified route table. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testrt", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testrt", &armnetwork.RouteTablesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RouteTablesClient) NewListAllPager

NewListAllPager - Gets all route tables in a subscription. Generated from API version 2022-05-01 options - RouteTablesClientListAllOptions contains the optional parameters for the RouteTablesClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*RouteTablesClient) NewListPager

func (client *RouteTablesClient) NewListPager(resourceGroupName string, options *RouteTablesClientListOptions) *runtime.Pager[RouteTablesClientListResponse]

NewListPager - Gets all route tables in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - RouteTablesClientListOptions contains the optional parameters for the RouteTablesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRouteTablesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "testrt", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type RouteTablesClientBeginCreateOrUpdateOptions

type RouteTablesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RouteTablesClientBeginCreateOrUpdateOptions contains the optional parameters for the RouteTablesClient.BeginCreateOrUpdate method.

type RouteTablesClientBeginDeleteOptions

type RouteTablesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RouteTablesClientBeginDeleteOptions contains the optional parameters for the RouteTablesClient.BeginDelete method.

type RouteTablesClientCreateOrUpdateResponse

type RouteTablesClientCreateOrUpdateResponse struct {
	RouteTable
}

RouteTablesClientCreateOrUpdateResponse contains the response from method RouteTablesClient.CreateOrUpdate.

type RouteTablesClientDeleteResponse

type RouteTablesClientDeleteResponse struct {
}

RouteTablesClientDeleteResponse contains the response from method RouteTablesClient.Delete.

type RouteTablesClientGetOptions

type RouteTablesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

RouteTablesClientGetOptions contains the optional parameters for the RouteTablesClient.Get method.

type RouteTablesClientGetResponse

type RouteTablesClientGetResponse struct {
	RouteTable
}

RouteTablesClientGetResponse contains the response from method RouteTablesClient.Get.

type RouteTablesClientListAllOptions

type RouteTablesClientListAllOptions struct {
}

RouteTablesClientListAllOptions contains the optional parameters for the RouteTablesClient.ListAll method.

type RouteTablesClientListAllResponse

type RouteTablesClientListAllResponse struct {
	RouteTableListResult
}

RouteTablesClientListAllResponse contains the response from method RouteTablesClient.ListAll.

type RouteTablesClientListOptions

type RouteTablesClientListOptions struct {
}

RouteTablesClientListOptions contains the optional parameters for the RouteTablesClient.List method.

type RouteTablesClientListResponse

type RouteTablesClientListResponse struct {
	RouteTableListResult
}

RouteTablesClientListResponse contains the response from method RouteTablesClient.List.

type RouteTablesClientUpdateTagsOptions

type RouteTablesClientUpdateTagsOptions struct {
}

RouteTablesClientUpdateTagsOptions contains the optional parameters for the RouteTablesClient.UpdateTags method.

type RouteTablesClientUpdateTagsResponse

type RouteTablesClientUpdateTagsResponse struct {
	RouteTable
}

RouteTablesClientUpdateTagsResponse contains the response 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, error)

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) (*runtime.Poller[RoutesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a route in the specified route table. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableRouteCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRoutesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testrt", "route1", armnetwork.Route{
	Properties: &armnetwork.RoutePropertiesFormat{
		AddressPrefix: to.Ptr("10.0.3.0/24"),
		NextHopType:   to.Ptr(armnetwork.RouteNextHopTypeVirtualNetworkGateway),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RoutesClient) BeginDelete

func (client *RoutesClient) BeginDelete(ctx context.Context, resourceGroupName string, routeTableName string, routeName string, options *RoutesClientBeginDeleteOptions) (*runtime.Poller[RoutesClientDeleteResponse], error)

BeginDelete - Deletes the specified route from a route table. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableRouteDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRoutesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testrt", "route1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableRouteGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRoutesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testrt", "route1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RoutesClient) NewListPager

func (client *RoutesClient) NewListPager(resourceGroupName string, routeTableName string, options *RoutesClientListOptions) *runtime.Pager[RoutesClientListResponse]

NewListPager - Gets all routes in a route table. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RouteTableRouteList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRoutesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "testrt", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type RoutesClientBeginCreateOrUpdateOptions

type RoutesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RoutesClientBeginCreateOrUpdateOptions contains the optional parameters for the RoutesClient.BeginCreateOrUpdate method.

type RoutesClientBeginDeleteOptions

type RoutesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RoutesClientBeginDeleteOptions contains the optional parameters for the RoutesClient.BeginDelete method.

type RoutesClientCreateOrUpdateResponse

type RoutesClientCreateOrUpdateResponse struct {
	Route
}

RoutesClientCreateOrUpdateResponse contains the response from method RoutesClient.CreateOrUpdate.

type RoutesClientDeleteResponse

type RoutesClientDeleteResponse struct {
}

RoutesClientDeleteResponse contains the response from method RoutesClient.Delete.

type RoutesClientGetOptions

type RoutesClientGetOptions struct {
}

RoutesClientGetOptions contains the optional parameters for the RoutesClient.Get method.

type RoutesClientGetResponse

type RoutesClientGetResponse struct {
	Route
}

RoutesClientGetResponse contains the response from method RoutesClient.Get.

type RoutesClientListOptions

type RoutesClientListOptions struct {
}

RoutesClientListOptions contains the optional parameters for the RoutesClient.List method.

type RoutesClientListResponse

type RoutesClientListResponse struct {
	RouteListResult
}

RoutesClientListResponse contains the response from method RoutesClient.List.

type RoutingConfiguration

type RoutingConfiguration struct {
	// The resource id RouteTable associated with this RoutingConfiguration.
	AssociatedRouteTable *SubResource `json:"associatedRouteTable,omitempty"`

	// The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
	InboundRouteMap *SubResource `json:"inboundRouteMap,omitempty"`

	// The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
	OutboundRouteMap *SubResource `json:"outboundRouteMap,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.

func (RoutingConfiguration) MarshalJSON

func (r RoutingConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoutingConfiguration.

func (*RoutingConfiguration) UnmarshalJSON

func (r *RoutingConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingConfiguration.

type RoutingIntent

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.

func (RoutingIntent) MarshalJSON

func (r RoutingIntent) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoutingIntent.

func (*RoutingIntent) UnmarshalJSON

func (r *RoutingIntent) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingIntent.

type RoutingIntentClient

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

func NewRoutingIntentClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RoutingIntentClient, error)

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

func (client *RoutingIntentClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, virtualHubName string, routingIntentName string, routingIntentParameters RoutingIntent, options *RoutingIntentClientBeginCreateOrUpdateOptions) (*runtime.Poller[RoutingIntentClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RoutingIntentPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRoutingIntentClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "virtualHub1", "Intent1", armnetwork.RoutingIntent{
	Properties: &armnetwork.RoutingIntentProperties{
		RoutingPolicies: []*armnetwork.RoutingPolicy{
			{
				Name: to.Ptr("InternetTraffic"),
				Destinations: []*string{
					to.Ptr("Internet")},
				NextHop: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1"),
			},
			{
				Name: to.Ptr("PrivateTrafficPolicy"),
				Destinations: []*string{
					to.Ptr("PrivateTraffic")},
				NextHop: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1"),
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RoutingIntentClient) BeginDelete

func (client *RoutingIntentClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, routingIntentName string, options *RoutingIntentClientBeginDeleteOptions) (*runtime.Poller[RoutingIntentClientDeleteResponse], error)

BeginDelete - Deletes a RoutingIntent. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RoutingIntentDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRoutingIntentClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "virtualHub1", "Intent1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*RoutingIntentClient) Get

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RoutingIntentGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRoutingIntentClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "virtualHub1", "Intent1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*RoutingIntentClient) NewListPager

func (client *RoutingIntentClient) NewListPager(resourceGroupName string, virtualHubName string, options *RoutingIntentClientListOptions) *runtime.Pager[RoutingIntentClientListResponse]

NewListPager - Retrieves the details of all RoutingIntent child resources of the VirtualHub. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/RoutingIntentList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewRoutingIntentClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "virtualHub1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type RoutingIntentClientBeginCreateOrUpdateOptions

type RoutingIntentClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RoutingIntentClientBeginCreateOrUpdateOptions contains the optional parameters for the RoutingIntentClient.BeginCreateOrUpdate method.

type RoutingIntentClientBeginDeleteOptions

type RoutingIntentClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RoutingIntentClientBeginDeleteOptions contains the optional parameters for the RoutingIntentClient.BeginDelete method.

type RoutingIntentClientCreateOrUpdateResponse

type RoutingIntentClientCreateOrUpdateResponse struct {
	RoutingIntent
}

RoutingIntentClientCreateOrUpdateResponse contains the response from method RoutingIntentClient.CreateOrUpdate.

type RoutingIntentClientDeleteResponse

type RoutingIntentClientDeleteResponse struct {
}

RoutingIntentClientDeleteResponse contains the response from method RoutingIntentClient.Delete.

type RoutingIntentClientGetOptions

type RoutingIntentClientGetOptions struct {
}

RoutingIntentClientGetOptions contains the optional parameters for the RoutingIntentClient.Get method.

type RoutingIntentClientGetResponse

type RoutingIntentClientGetResponse struct {
	RoutingIntent
}

RoutingIntentClientGetResponse contains the response from method RoutingIntentClient.Get.

type RoutingIntentClientListOptions

type RoutingIntentClientListOptions struct {
}

RoutingIntentClientListOptions contains the optional parameters for the RoutingIntentClient.List method.

type RoutingIntentClientListResponse

type RoutingIntentClientListResponse struct {
	ListRoutingIntentResult
}

RoutingIntentClientListResponse contains the response from method RoutingIntentClient.List.

type RoutingIntentProperties

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

func (r RoutingIntentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoutingIntentProperties.

func (*RoutingIntentProperties) UnmarshalJSON

func (r *RoutingIntentProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RoutingIntentProperties.

type RoutingPolicy

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

func (r RoutingPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RoutingPolicy.

func (*RoutingPolicy) UnmarshalJSON

func (r *RoutingPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

type Rule

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

func (r *Rule) GetFirewallPolicyRule() *FirewallPolicyRule

GetFirewallPolicyRule implements the FirewallPolicyRuleClassification interface for type Rule.

func (Rule) MarshalJSON

func (r Rule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Rule.

func (*Rule) UnmarshalJSON

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.

func (SKU) MarshalJSON

func (s SKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON

func (s *SKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type ScopeConnection

type ScopeConnection struct {
	// The scope connection properties
	Properties *ScopeConnectionProperties `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 ID.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

ScopeConnection - The Scope Connections resource

func (ScopeConnection) MarshalJSON

func (s ScopeConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScopeConnection.

func (*ScopeConnection) UnmarshalJSON

func (s *ScopeConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScopeConnection.

type ScopeConnectionListResult

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

	// List of scope connections.
	Value []*ScopeConnection `json:"value,omitempty"`
}

ScopeConnectionListResult - List of scope connections.

func (ScopeConnectionListResult) MarshalJSON

func (s ScopeConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScopeConnectionListResult.

func (*ScopeConnectionListResult) UnmarshalJSON

func (s *ScopeConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScopeConnectionListResult.

type ScopeConnectionProperties

type ScopeConnectionProperties struct {
	// A description of the scope connection.
	Description *string `json:"description,omitempty"`

	// Resource ID.
	ResourceID *string `json:"resourceId,omitempty"`

	// Tenant ID.
	TenantID *string `json:"tenantId,omitempty"`

	// READ-ONLY; Connection State
	ConnectionState *ScopeConnectionState `json:"connectionState,omitempty" azure:"ro"`
}

ScopeConnectionProperties - Scope connection.

func (ScopeConnectionProperties) MarshalJSON

func (s ScopeConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ScopeConnectionProperties.

func (*ScopeConnectionProperties) UnmarshalJSON

func (s *ScopeConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ScopeConnectionProperties.

type ScopeConnectionState

type ScopeConnectionState string

ScopeConnectionState - The current scope connection state.

const (
	ScopeConnectionStateConflict  ScopeConnectionState = "Conflict"
	ScopeConnectionStateConnected ScopeConnectionState = "Connected"
	ScopeConnectionStatePending   ScopeConnectionState = "Pending"
	ScopeConnectionStateRejected  ScopeConnectionState = "Rejected"
	ScopeConnectionStateRevoked   ScopeConnectionState = "Revoked"
)

func PossibleScopeConnectionStateValues

func PossibleScopeConnectionStateValues() []ScopeConnectionState

PossibleScopeConnectionStateValues returns the possible values for the ScopeConnectionState const type.

type ScopeConnectionsClient

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

ScopeConnectionsClient contains the methods for the ScopeConnections group. Don't use this type directly, use NewScopeConnectionsClient() instead.

func NewScopeConnectionsClient

func NewScopeConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ScopeConnectionsClient, error)

NewScopeConnectionsClient creates a new instance of ScopeConnectionsClient 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 (*ScopeConnectionsClient) CreateOrUpdate

func (client *ScopeConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkManagerName string, scopeConnectionName string, parameters ScopeConnection, options *ScopeConnectionsClientCreateOrUpdateOptions) (ScopeConnectionsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates scope connection from Network Manager If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. scopeConnectionName - Name for the cross-tenant connection. parameters - Scope connection to be created/updated. options - ScopeConnectionsClientCreateOrUpdateOptions contains the optional parameters for the ScopeConnectionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerScopeConnectionPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewScopeConnectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "testNetworkManager", "TestScopeConnection", armnetwork.ScopeConnection{
	Properties: &armnetwork.ScopeConnectionProperties{
		Description: to.Ptr("This is a scope connection to a cross tenant subscription."),
		ResourceID:  to.Ptr("subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b"),
		TenantID:    to.Ptr("6babcaad-604b-40ac-a9d7-9fd97c0b779f"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ScopeConnectionsClient) Delete

func (client *ScopeConnectionsClient) Delete(ctx context.Context, resourceGroupName string, networkManagerName string, scopeConnectionName string, options *ScopeConnectionsClientDeleteOptions) (ScopeConnectionsClientDeleteResponse, error)

Delete - Delete the pending scope connection created by this network manager. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. scopeConnectionName - Name for the cross-tenant connection. options - ScopeConnectionsClientDeleteOptions contains the optional parameters for the ScopeConnectionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerScopeConnectionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewScopeConnectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx, "rg1", "testNetworkManager", "TestScopeConnection", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*ScopeConnectionsClient) Get

func (client *ScopeConnectionsClient) Get(ctx context.Context, resourceGroupName string, networkManagerName string, scopeConnectionName string, options *ScopeConnectionsClientGetOptions) (ScopeConnectionsClientGetResponse, error)

Get - Get specified scope connection created by this Network Manager. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. scopeConnectionName - Name for the cross-tenant connection. options - ScopeConnectionsClientGetOptions contains the optional parameters for the ScopeConnectionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerScopeConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewScopeConnectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testNetworkManager", "TestScopeConnection", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ScopeConnectionsClient) NewListPager

func (client *ScopeConnectionsClient) NewListPager(resourceGroupName string, networkManagerName string, options *ScopeConnectionsClientListOptions) *runtime.Pager[ScopeConnectionsClientListResponse]

NewListPager - List all scope connections created by this network manager. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. options - ScopeConnectionsClientListOptions contains the optional parameters for the ScopeConnectionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerScopeConnectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewScopeConnectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "testNetworkManager", &armnetwork.ScopeConnectionsClientListOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ScopeConnectionsClientCreateOrUpdateOptions

type ScopeConnectionsClientCreateOrUpdateOptions struct {
}

ScopeConnectionsClientCreateOrUpdateOptions contains the optional parameters for the ScopeConnectionsClient.CreateOrUpdate method.

type ScopeConnectionsClientCreateOrUpdateResponse

type ScopeConnectionsClientCreateOrUpdateResponse struct {
	ScopeConnection
}

ScopeConnectionsClientCreateOrUpdateResponse contains the response from method ScopeConnectionsClient.CreateOrUpdate.

type ScopeConnectionsClientDeleteOptions

type ScopeConnectionsClientDeleteOptions struct {
}

ScopeConnectionsClientDeleteOptions contains the optional parameters for the ScopeConnectionsClient.Delete method.

type ScopeConnectionsClientDeleteResponse

type ScopeConnectionsClientDeleteResponse struct {
}

ScopeConnectionsClientDeleteResponse contains the response from method ScopeConnectionsClient.Delete.

type ScopeConnectionsClientGetOptions

type ScopeConnectionsClientGetOptions struct {
}

ScopeConnectionsClientGetOptions contains the optional parameters for the ScopeConnectionsClient.Get method.

type ScopeConnectionsClientGetResponse

type ScopeConnectionsClientGetResponse struct {
	ScopeConnection
}

ScopeConnectionsClientGetResponse contains the response from method ScopeConnectionsClient.Get.

type ScopeConnectionsClientListOptions

type ScopeConnectionsClientListOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

ScopeConnectionsClientListOptions contains the optional parameters for the ScopeConnectionsClient.List method.

type ScopeConnectionsClientListResponse

type ScopeConnectionsClientListResponse struct {
	ScopeConnectionListResult
}

ScopeConnectionsClientListResponse contains the response from method ScopeConnectionsClient.List.

type SecurityAdminConfiguration

type SecurityAdminConfiguration struct {
	// Indicates the properties for the network manager security admin configuration.
	Properties *SecurityAdminConfigurationPropertiesFormat `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 ID.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

SecurityAdminConfiguration - Defines the security admin configuration

func (SecurityAdminConfiguration) MarshalJSON

func (s SecurityAdminConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityAdminConfiguration.

func (*SecurityAdminConfiguration) UnmarshalJSON

func (s *SecurityAdminConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityAdminConfiguration.

type SecurityAdminConfigurationListResult

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

	// Gets a page of security admin configurations
	Value []*SecurityAdminConfiguration `json:"value,omitempty"`
}

SecurityAdminConfigurationListResult - A list of network manager security admin configurations

func (SecurityAdminConfigurationListResult) MarshalJSON

func (s SecurityAdminConfigurationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityAdminConfigurationListResult.

func (*SecurityAdminConfigurationListResult) UnmarshalJSON

func (s *SecurityAdminConfigurationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityAdminConfigurationListResult.

type SecurityAdminConfigurationPropertiesFormat

type SecurityAdminConfigurationPropertiesFormat struct {
	// Enum list of network intent policy based services.
	ApplyOnNetworkIntentPolicyBasedServices []*NetworkIntentPolicyBasedService `json:"applyOnNetworkIntentPolicyBasedServices,omitempty"`

	// A description of the security configuration.
	Description *string `json:"description,omitempty"`

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

SecurityAdminConfigurationPropertiesFormat - Defines the security admin configuration properties.

func (SecurityAdminConfigurationPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type SecurityAdminConfigurationPropertiesFormat.

func (*SecurityAdminConfigurationPropertiesFormat) UnmarshalJSON

func (s *SecurityAdminConfigurationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityAdminConfigurationPropertiesFormat.

type SecurityAdminConfigurationsClient

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

SecurityAdminConfigurationsClient contains the methods for the SecurityAdminConfigurations group. Don't use this type directly, use NewSecurityAdminConfigurationsClient() instead.

func NewSecurityAdminConfigurationsClient

func NewSecurityAdminConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SecurityAdminConfigurationsClient, error)

NewSecurityAdminConfigurationsClient creates a new instance of SecurityAdminConfigurationsClient 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 (*SecurityAdminConfigurationsClient) BeginDelete

BeginDelete - Deletes a network manager security admin configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. options - SecurityAdminConfigurationsClientBeginDeleteOptions contains the optional parameters for the SecurityAdminConfigurationsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerSecurityAdminConfigurationDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityAdminConfigurationsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", &armnetwork.SecurityAdminConfigurationsClientBeginDeleteOptions{Force: to.Ptr(false)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*SecurityAdminConfigurationsClient) CreateOrUpdate

func (client *SecurityAdminConfigurationsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkManagerName string, configurationName string, securityAdminConfiguration SecurityAdminConfiguration, options *SecurityAdminConfigurationsClientCreateOrUpdateOptions) (SecurityAdminConfigurationsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a network manager security admin configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. securityAdminConfiguration - The security admin configuration to create or update options - SecurityAdminConfigurationsClientCreateOrUpdateOptions contains the optional parameters for the SecurityAdminConfigurationsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerSecurityAdminConfigurationPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityAdminConfigurationsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", armnetwork.SecurityAdminConfiguration{
	Properties: &armnetwork.SecurityAdminConfigurationPropertiesFormat{
		Description: to.Ptr("A sample policy"),
		ApplyOnNetworkIntentPolicyBasedServices: []*armnetwork.NetworkIntentPolicyBasedService{
			to.Ptr(armnetwork.NetworkIntentPolicyBasedServiceNone)},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SecurityAdminConfigurationsClient) Get

func (client *SecurityAdminConfigurationsClient) Get(ctx context.Context, resourceGroupName string, networkManagerName string, configurationName string, options *SecurityAdminConfigurationsClientGetOptions) (SecurityAdminConfigurationsClientGetResponse, error)

Get - Retrieves a network manager security admin configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. configurationName - The name of the network manager Security Configuration. options - SecurityAdminConfigurationsClientGetOptions contains the optional parameters for the SecurityAdminConfigurationsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerSecurityAdminConfigurationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityAdminConfigurationsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testNetworkManager", "myTestSecurityConfig", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SecurityAdminConfigurationsClient) NewListPager

NewListPager - Lists all the network manager security admin configurations in a network manager, in a paginated format. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. options - SecurityAdminConfigurationsClientListOptions contains the optional parameters for the SecurityAdminConfigurationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerSecurityAdminConfigurationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityAdminConfigurationsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "testNetworkManager", &armnetwork.SecurityAdminConfigurationsClientListOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type SecurityAdminConfigurationsClientBeginDeleteOptions

type SecurityAdminConfigurationsClientBeginDeleteOptions struct {
	// Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service
	// will do a cleanup deployment in the background, prior to the delete.
	Force *bool
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SecurityAdminConfigurationsClientBeginDeleteOptions contains the optional parameters for the SecurityAdminConfigurationsClient.BeginDelete method.

type SecurityAdminConfigurationsClientCreateOrUpdateOptions

type SecurityAdminConfigurationsClientCreateOrUpdateOptions struct {
}

SecurityAdminConfigurationsClientCreateOrUpdateOptions contains the optional parameters for the SecurityAdminConfigurationsClient.CreateOrUpdate method.

type SecurityAdminConfigurationsClientCreateOrUpdateResponse

type SecurityAdminConfigurationsClientCreateOrUpdateResponse struct {
	SecurityAdminConfiguration
}

SecurityAdminConfigurationsClientCreateOrUpdateResponse contains the response from method SecurityAdminConfigurationsClient.CreateOrUpdate.

type SecurityAdminConfigurationsClientDeleteResponse

type SecurityAdminConfigurationsClientDeleteResponse struct {
}

SecurityAdminConfigurationsClientDeleteResponse contains the response from method SecurityAdminConfigurationsClient.Delete.

type SecurityAdminConfigurationsClientGetOptions

type SecurityAdminConfigurationsClientGetOptions struct {
}

SecurityAdminConfigurationsClientGetOptions contains the optional parameters for the SecurityAdminConfigurationsClient.Get method.

type SecurityAdminConfigurationsClientGetResponse

type SecurityAdminConfigurationsClientGetResponse struct {
	SecurityAdminConfiguration
}

SecurityAdminConfigurationsClientGetResponse contains the response from method SecurityAdminConfigurationsClient.Get.

type SecurityAdminConfigurationsClientListOptions

type SecurityAdminConfigurationsClientListOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

SecurityAdminConfigurationsClientListOptions contains the optional parameters for the SecurityAdminConfigurationsClient.List method.

type SecurityAdminConfigurationsClientListResponse

type SecurityAdminConfigurationsClientListResponse struct {
	SecurityAdminConfigurationListResult
}

SecurityAdminConfigurationsClientListResponse contains the response from method SecurityAdminConfigurationsClient.List.

type SecurityConfigurationRuleAccess

type SecurityConfigurationRuleAccess string

SecurityConfigurationRuleAccess - Whether network traffic is allowed or denied.

const (
	SecurityConfigurationRuleAccessAllow       SecurityConfigurationRuleAccess = "Allow"
	SecurityConfigurationRuleAccessAlwaysAllow SecurityConfigurationRuleAccess = "AlwaysAllow"
	SecurityConfigurationRuleAccessDeny        SecurityConfigurationRuleAccess = "Deny"
)

func PossibleSecurityConfigurationRuleAccessValues

func PossibleSecurityConfigurationRuleAccessValues() []SecurityConfigurationRuleAccess

PossibleSecurityConfigurationRuleAccessValues returns the possible values for the SecurityConfigurationRuleAccess const type.

type SecurityConfigurationRuleDirection

type SecurityConfigurationRuleDirection string

SecurityConfigurationRuleDirection - The direction of the rule. The direction specifies if the rule will be evaluated on incoming or outgoing traffic.

const (
	SecurityConfigurationRuleDirectionInbound  SecurityConfigurationRuleDirection = "Inbound"
	SecurityConfigurationRuleDirectionOutbound SecurityConfigurationRuleDirection = "Outbound"
)

func PossibleSecurityConfigurationRuleDirectionValues

func PossibleSecurityConfigurationRuleDirectionValues() []SecurityConfigurationRuleDirection

PossibleSecurityConfigurationRuleDirectionValues returns the possible values for the SecurityConfigurationRuleDirection const type.

type SecurityConfigurationRuleProtocol

type SecurityConfigurationRuleProtocol string

SecurityConfigurationRuleProtocol - Network protocol this rule applies to.

const (
	SecurityConfigurationRuleProtocolAh   SecurityConfigurationRuleProtocol = "Ah"
	SecurityConfigurationRuleProtocolAny  SecurityConfigurationRuleProtocol = "Any"
	SecurityConfigurationRuleProtocolEsp  SecurityConfigurationRuleProtocol = "Esp"
	SecurityConfigurationRuleProtocolIcmp SecurityConfigurationRuleProtocol = "Icmp"
	SecurityConfigurationRuleProtocolTCP  SecurityConfigurationRuleProtocol = "Tcp"
	SecurityConfigurationRuleProtocolUDP  SecurityConfigurationRuleProtocol = "Udp"
)

func PossibleSecurityConfigurationRuleProtocolValues

func PossibleSecurityConfigurationRuleProtocolValues() []SecurityConfigurationRuleProtocol

PossibleSecurityConfigurationRuleProtocolValues returns the possible values for the SecurityConfigurationRuleProtocol const type.

type SecurityGroup

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

func (s SecurityGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroup.

func (*SecurityGroup) UnmarshalJSON

func (s *SecurityGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityGroup.

type SecurityGroupListResult

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

func (s SecurityGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroupListResult.

func (*SecurityGroupListResult) UnmarshalJSON

func (s *SecurityGroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (SecurityGroupNetworkInterface) MarshalJSON

func (s SecurityGroupNetworkInterface) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroupNetworkInterface.

func (*SecurityGroupNetworkInterface) UnmarshalJSON

func (s *SecurityGroupNetworkInterface) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityGroupNetworkInterface.

type SecurityGroupPropertiesFormat

type SecurityGroupPropertiesFormat struct {
	// When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial
	// enablement will trigger re-evaluation.
	FlushConnection *bool `json:"flushConnection,omitempty"`

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

func (s SecurityGroupPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroupPropertiesFormat.

func (*SecurityGroupPropertiesFormat) UnmarshalJSON

func (s *SecurityGroupPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityGroupPropertiesFormat.

type SecurityGroupResult

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

func (s SecurityGroupResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroupResult.

func (*SecurityGroupResult) UnmarshalJSON

func (s *SecurityGroupResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (SecurityGroupViewParameters) MarshalJSON

func (s SecurityGroupViewParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityGroupViewParameters.

func (*SecurityGroupViewParameters) UnmarshalJSON

func (s *SecurityGroupViewParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityGroupViewParameters.

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.

func (*SecurityGroupViewResult) UnmarshalJSON

func (s *SecurityGroupViewResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityGroupViewResult.

type SecurityGroupsClient

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

func NewSecurityGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SecurityGroupsClient, error)

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

func (client *SecurityGroupsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, parameters SecurityGroup, options *SecurityGroupsClientBeginCreateOrUpdateOptions) (*runtime.Poller[SecurityGroupsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a network security group in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateNetworkSecurityGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testnsg", armnetwork.SecurityGroup{
	Location: to.Ptr("eastus"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateNetworkSecurityGroupWithRule)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupCreateWithRule.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testnsg", armnetwork.SecurityGroup{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.SecurityGroupPropertiesFormat{
		SecurityRules: []*armnetwork.SecurityRule{
			{
				Name: to.Ptr("rule1"),
				Properties: &armnetwork.SecurityRulePropertiesFormat{
					Access:                   to.Ptr(armnetwork.SecurityRuleAccessAllow),
					DestinationAddressPrefix: to.Ptr("*"),
					DestinationPortRange:     to.Ptr("80"),
					Direction:                to.Ptr(armnetwork.SecurityRuleDirectionInbound),
					Priority:                 to.Ptr[int32](130),
					SourceAddressPrefix:      to.Ptr("*"),
					SourcePortRange:          to.Ptr("*"),
					Protocol:                 to.Ptr(armnetwork.SecurityRuleProtocolAsterisk),
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SecurityGroupsClient) BeginDelete

func (client *SecurityGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, options *SecurityGroupsClientBeginDeleteOptions) (*runtime.Poller[SecurityGroupsClientDeleteResponse], error)

BeginDelete - Deletes the specified network security group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testnsg", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*SecurityGroupsClient) Get

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testnsg", &armnetwork.SecurityGroupsClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SecurityGroupsClient) NewListAllPager

NewListAllPager - Gets all network security groups in a subscription. Generated from API version 2022-05-01 options - SecurityGroupsClientListAllOptions contains the optional parameters for the SecurityGroupsClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*SecurityGroupsClient) NewListPager

NewListPager - Gets all network security groups in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - SecurityGroupsClientListOptions contains the optional parameters for the SecurityGroupsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*SecurityGroupsClient) UpdateTags

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityGroupsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "testnsg", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type SecurityGroupsClientBeginCreateOrUpdateOptions

type SecurityGroupsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SecurityGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the SecurityGroupsClient.BeginCreateOrUpdate method.

type SecurityGroupsClientBeginDeleteOptions

type SecurityGroupsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SecurityGroupsClientBeginDeleteOptions contains the optional parameters for the SecurityGroupsClient.BeginDelete method.

type SecurityGroupsClientCreateOrUpdateResponse

type SecurityGroupsClientCreateOrUpdateResponse struct {
	SecurityGroup
}

SecurityGroupsClientCreateOrUpdateResponse contains the response from method SecurityGroupsClient.CreateOrUpdate.

type SecurityGroupsClientDeleteResponse

type SecurityGroupsClientDeleteResponse struct {
}

SecurityGroupsClientDeleteResponse contains the response from method SecurityGroupsClient.Delete.

type SecurityGroupsClientGetOptions

type SecurityGroupsClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

SecurityGroupsClientGetOptions contains the optional parameters for the SecurityGroupsClient.Get method.

type SecurityGroupsClientGetResponse

type SecurityGroupsClientGetResponse struct {
	SecurityGroup
}

SecurityGroupsClientGetResponse contains the response from method SecurityGroupsClient.Get.

type SecurityGroupsClientListAllOptions

type SecurityGroupsClientListAllOptions struct {
}

SecurityGroupsClientListAllOptions contains the optional parameters for the SecurityGroupsClient.ListAll method.

type SecurityGroupsClientListAllResponse

type SecurityGroupsClientListAllResponse struct {
	SecurityGroupListResult
}

SecurityGroupsClientListAllResponse contains the response from method SecurityGroupsClient.ListAll.

type SecurityGroupsClientListOptions

type SecurityGroupsClientListOptions struct {
}

SecurityGroupsClientListOptions contains the optional parameters for the SecurityGroupsClient.List method.

type SecurityGroupsClientListResponse

type SecurityGroupsClientListResponse struct {
	SecurityGroupListResult
}

SecurityGroupsClientListResponse contains the response from method SecurityGroupsClient.List.

type SecurityGroupsClientUpdateTagsOptions

type SecurityGroupsClientUpdateTagsOptions struct {
}

SecurityGroupsClientUpdateTagsOptions contains the optional parameters for the SecurityGroupsClient.UpdateTags method.

type SecurityGroupsClientUpdateTagsResponse

type SecurityGroupsClientUpdateTagsResponse struct {
	SecurityGroup
}

SecurityGroupsClientUpdateTagsResponse contains the response 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.

func (*SecurityPartnerProvider) UnmarshalJSON

func (s *SecurityPartnerProvider) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (*SecurityPartnerProviderListResult) UnmarshalJSON

func (s *SecurityPartnerProviderListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (SecurityPartnerProviderPropertiesFormat) MarshalJSON

func (s SecurityPartnerProviderPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityPartnerProviderPropertiesFormat.

func (*SecurityPartnerProviderPropertiesFormat) UnmarshalJSON

func (s *SecurityPartnerProviderPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityPartnerProviderPropertiesFormat.

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, error)

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

BeginCreateOrUpdate - Creates or updates the specified Security Partner Provider. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SecurityPartnerProviderPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityPartnerProvidersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "securityPartnerProvider", armnetwork.SecurityPartnerProvider{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.SecurityPartnerProviderPropertiesFormat{
		SecurityProviderName: to.Ptr(armnetwork.SecurityProviderNameZScaler),
		VirtualHub: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SecurityPartnerProvidersClient) BeginDelete

BeginDelete - Deletes the specified Security Partner Provider. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SecurityPartnerProviderDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityPartnerProvidersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "securityPartnerProvider", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*SecurityPartnerProvidersClient) Get

Get - Gets the specified Security Partner Provider. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SecurityPartnerProviderGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityPartnerProvidersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "securityPartnerProvider", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SecurityPartnerProvidersClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all Security Partner Providers in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - SecurityPartnerProvidersClientListByResourceGroupOptions contains the optional parameters for the SecurityPartnerProvidersClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SecurityPartnerProviderListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityPartnerProvidersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*SecurityPartnerProvidersClient) NewListPager

NewListPager - Gets all the Security Partner Providers in a subscription. Generated from API version 2022-05-01 options - SecurityPartnerProvidersClientListOptions contains the optional parameters for the SecurityPartnerProvidersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SecurityPartnerProviderListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityPartnerProvidersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SecurityPartnerProviderUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityPartnerProvidersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "securityPartnerProvider", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type SecurityPartnerProvidersClientBeginCreateOrUpdateOptions

type SecurityPartnerProvidersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SecurityPartnerProvidersClientBeginCreateOrUpdateOptions contains the optional parameters for the SecurityPartnerProvidersClient.BeginCreateOrUpdate method.

type SecurityPartnerProvidersClientBeginDeleteOptions

type SecurityPartnerProvidersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SecurityPartnerProvidersClientBeginDeleteOptions contains the optional parameters for the SecurityPartnerProvidersClient.BeginDelete method.

type SecurityPartnerProvidersClientCreateOrUpdateResponse

type SecurityPartnerProvidersClientCreateOrUpdateResponse struct {
	SecurityPartnerProvider
}

SecurityPartnerProvidersClientCreateOrUpdateResponse contains the response from method SecurityPartnerProvidersClient.CreateOrUpdate.

type SecurityPartnerProvidersClientDeleteResponse

type SecurityPartnerProvidersClientDeleteResponse struct {
}

SecurityPartnerProvidersClientDeleteResponse contains the response from method SecurityPartnerProvidersClient.Delete.

type SecurityPartnerProvidersClientGetOptions

type SecurityPartnerProvidersClientGetOptions struct {
}

SecurityPartnerProvidersClientGetOptions contains the optional parameters for the SecurityPartnerProvidersClient.Get method.

type SecurityPartnerProvidersClientGetResponse

type SecurityPartnerProvidersClientGetResponse struct {
	SecurityPartnerProvider
}

SecurityPartnerProvidersClientGetResponse contains the response from method SecurityPartnerProvidersClient.Get.

type SecurityPartnerProvidersClientListByResourceGroupOptions

type SecurityPartnerProvidersClientListByResourceGroupOptions struct {
}

SecurityPartnerProvidersClientListByResourceGroupOptions contains the optional parameters for the SecurityPartnerProvidersClient.ListByResourceGroup method.

type SecurityPartnerProvidersClientListByResourceGroupResponse

type SecurityPartnerProvidersClientListByResourceGroupResponse struct {
	SecurityPartnerProviderListResult
}

SecurityPartnerProvidersClientListByResourceGroupResponse contains the response from method SecurityPartnerProvidersClient.ListByResourceGroup.

type SecurityPartnerProvidersClientListOptions

type SecurityPartnerProvidersClientListOptions struct {
}

SecurityPartnerProvidersClientListOptions contains the optional parameters for the SecurityPartnerProvidersClient.List method.

type SecurityPartnerProvidersClientListResponse

type SecurityPartnerProvidersClientListResponse struct {
	SecurityPartnerProviderListResult
}

SecurityPartnerProvidersClientListResponse contains the response from method SecurityPartnerProvidersClient.List.

type SecurityPartnerProvidersClientUpdateTagsOptions

type SecurityPartnerProvidersClientUpdateTagsOptions struct {
}

SecurityPartnerProvidersClientUpdateTagsOptions contains the optional parameters for the SecurityPartnerProvidersClient.UpdateTags method.

type SecurityPartnerProvidersClientUpdateTagsResponse

type SecurityPartnerProvidersClientUpdateTagsResponse struct {
	SecurityPartnerProvider
}

SecurityPartnerProvidersClientUpdateTagsResponse contains the response 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.

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.

func (SecurityRule) MarshalJSON

func (s SecurityRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityRule.

func (*SecurityRule) UnmarshalJSON

func (s *SecurityRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityRule.

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.

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.

func (*SecurityRuleAssociations) UnmarshalJSON

func (s *SecurityRuleAssociations) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (*SecurityRuleListResult) UnmarshalJSON

func (s *SecurityRuleListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*SecurityRulePropertiesFormat) UnmarshalJSON

func (s *SecurityRulePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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, error)

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) (*runtime.Poller[SecurityRulesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a security rule in the specified network security group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupRuleCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testnsg", "rule1", armnetwork.SecurityRule{
	Properties: &armnetwork.SecurityRulePropertiesFormat{
		Access:                   to.Ptr(armnetwork.SecurityRuleAccessDeny),
		DestinationAddressPrefix: to.Ptr("11.0.0.0/8"),
		DestinationPortRange:     to.Ptr("8080"),
		Direction:                to.Ptr(armnetwork.SecurityRuleDirectionOutbound),
		Priority:                 to.Ptr[int32](100),
		SourceAddressPrefix:      to.Ptr("10.0.0.0/8"),
		SourcePortRange:          to.Ptr("*"),
		Protocol:                 to.Ptr(armnetwork.SecurityRuleProtocolAsterisk),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SecurityRulesClient) BeginDelete

func (client *SecurityRulesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, securityRuleName string, options *SecurityRulesClientBeginDeleteOptions) (*runtime.Poller[SecurityRulesClientDeleteResponse], error)

BeginDelete - Deletes the specified network security rule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupRuleDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testnsg", "rule1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupRuleGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testnsg", "rule1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SecurityRulesClient) NewListPager

func (client *SecurityRulesClient) NewListPager(resourceGroupName string, networkSecurityGroupName string, options *SecurityRulesClientListOptions) *runtime.Pager[SecurityRulesClientListResponse]

NewListPager - Gets all security rules in a network security group. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkSecurityGroupRuleList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSecurityRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "testnsg", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type SecurityRulesClientBeginCreateOrUpdateOptions

type SecurityRulesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SecurityRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the SecurityRulesClient.BeginCreateOrUpdate method.

type SecurityRulesClientBeginDeleteOptions

type SecurityRulesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SecurityRulesClientBeginDeleteOptions contains the optional parameters for the SecurityRulesClient.BeginDelete method.

type SecurityRulesClientCreateOrUpdateResponse

type SecurityRulesClientCreateOrUpdateResponse struct {
	SecurityRule
}

SecurityRulesClientCreateOrUpdateResponse contains the response from method SecurityRulesClient.CreateOrUpdate.

type SecurityRulesClientDeleteResponse

type SecurityRulesClientDeleteResponse struct {
}

SecurityRulesClientDeleteResponse contains the response from method SecurityRulesClient.Delete.

type SecurityRulesClientGetOptions

type SecurityRulesClientGetOptions struct {
}

SecurityRulesClientGetOptions contains the optional parameters for the SecurityRulesClient.Get method.

type SecurityRulesClientGetResponse

type SecurityRulesClientGetResponse struct {
	SecurityRule
}

SecurityRulesClientGetResponse contains the response from method SecurityRulesClient.Get.

type SecurityRulesClientListOptions

type SecurityRulesClientListOptions struct {
}

SecurityRulesClientListOptions contains the optional parameters for the SecurityRulesClient.List method.

type SecurityRulesClientListResponse

type SecurityRulesClientListResponse struct {
	SecurityRuleListResult
}

SecurityRulesClientListResponse contains the response from method SecurityRulesClient.List.

type SecurityRulesEvaluationResult

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.

func (SecurityRulesEvaluationResult) MarshalJSON

func (s SecurityRulesEvaluationResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecurityRulesEvaluationResult.

func (*SecurityRulesEvaluationResult) UnmarshalJSON

func (s *SecurityRulesEvaluationResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecurityRulesEvaluationResult.

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.

func (ServiceAssociationLink) MarshalJSON

func (s ServiceAssociationLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceAssociationLink.

func (*ServiceAssociationLink) UnmarshalJSON

func (s *ServiceAssociationLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceAssociationLink.

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.

func (*ServiceAssociationLinkPropertiesFormat) UnmarshalJSON

func (s *ServiceAssociationLinkPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGetServiceAssociationLinks.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceAssociationLinksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx, "rg1", "vnet", "subnet", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ServiceAssociationLinksClientListOptions

type ServiceAssociationLinksClientListOptions struct {
}

ServiceAssociationLinksClientListOptions contains the optional parameters for the ServiceAssociationLinksClient.List method.

type ServiceAssociationLinksClientListResponse

type ServiceAssociationLinksClientListResponse struct {
	ServiceAssociationLinksListResult
}

ServiceAssociationLinksClientListResponse contains the response 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.

func (*ServiceAssociationLinksListResult) UnmarshalJSON

func (s *ServiceAssociationLinksListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ServiceDelegationPropertiesFormat) UnmarshalJSON

func (s *ServiceDelegationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

BeginCreateOrUpdate - Creates or updates a service Endpoint Policies. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateServiceEndpointPolicy)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testPolicy", armnetwork.ServiceEndpointPolicy{
	Location: to.Ptr("westus"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateServiceEndpointPolicyWithDefinition)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyCreateWithDefinition.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testPolicy", armnetwork.ServiceEndpointPolicy{
	Location: to.Ptr("westus"),
	Properties: &armnetwork.ServiceEndpointPolicyPropertiesFormat{
		ServiceEndpointPolicyDefinitions: []*armnetwork.ServiceEndpointPolicyDefinition{
			{
				Name: to.Ptr("StorageServiceEndpointPolicyDefinition"),
				Properties: &armnetwork.ServiceEndpointPolicyDefinitionPropertiesFormat{
					Description: to.Ptr("Storage Service EndpointPolicy Definition"),
					Service:     to.Ptr("Microsoft.Storage"),
					ServiceResources: []*string{
						to.Ptr("/subscriptions/subid1"),
						to.Ptr("/subscriptions/subid1/resourceGroups/storageRg"),
						to.Ptr("/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount")},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ServiceEndpointPoliciesClient) BeginDelete

BeginDelete - Deletes the specified service endpoint policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "serviceEndpointPolicy1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ServiceEndpointPoliciesClient) Get

Get - Gets the specified service Endpoint Policies in a specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testServiceEndpointPolicy", &armnetwork.ServiceEndpointPoliciesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ServiceEndpointPoliciesClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Gets all service endpoint Policies in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - ServiceEndpointPoliciesClientListByResourceGroupOptions contains the optional parameters for the ServiceEndpointPoliciesClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*ServiceEndpointPoliciesClient) NewListPager

NewListPager - Gets all the service endpoint policies in a subscription. Generated from API version 2022-05-01 options - ServiceEndpointPoliciesClientListOptions contains the optional parameters for the ServiceEndpointPoliciesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "testServiceEndpointPolicy", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ServiceEndpointPoliciesClientBeginCreateOrUpdateOptions

type ServiceEndpointPoliciesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ServiceEndpointPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServiceEndpointPoliciesClient.BeginCreateOrUpdate method.

type ServiceEndpointPoliciesClientBeginDeleteOptions

type ServiceEndpointPoliciesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ServiceEndpointPoliciesClientBeginDeleteOptions contains the optional parameters for the ServiceEndpointPoliciesClient.BeginDelete method.

type ServiceEndpointPoliciesClientCreateOrUpdateResponse

type ServiceEndpointPoliciesClientCreateOrUpdateResponse struct {
	ServiceEndpointPolicy
}

ServiceEndpointPoliciesClientCreateOrUpdateResponse contains the response from method ServiceEndpointPoliciesClient.CreateOrUpdate.

type ServiceEndpointPoliciesClientDeleteResponse

type ServiceEndpointPoliciesClientDeleteResponse struct {
}

ServiceEndpointPoliciesClientDeleteResponse contains the response from method ServiceEndpointPoliciesClient.Delete.

type ServiceEndpointPoliciesClientGetOptions

type ServiceEndpointPoliciesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

ServiceEndpointPoliciesClientGetOptions contains the optional parameters for the ServiceEndpointPoliciesClient.Get method.

type ServiceEndpointPoliciesClientGetResponse

type ServiceEndpointPoliciesClientGetResponse struct {
	ServiceEndpointPolicy
}

ServiceEndpointPoliciesClientGetResponse contains the response from method ServiceEndpointPoliciesClient.Get.

type ServiceEndpointPoliciesClientListByResourceGroupOptions

type ServiceEndpointPoliciesClientListByResourceGroupOptions struct {
}

ServiceEndpointPoliciesClientListByResourceGroupOptions contains the optional parameters for the ServiceEndpointPoliciesClient.ListByResourceGroup method.

type ServiceEndpointPoliciesClientListByResourceGroupResponse

type ServiceEndpointPoliciesClientListByResourceGroupResponse struct {
	ServiceEndpointPolicyListResult
}

ServiceEndpointPoliciesClientListByResourceGroupResponse contains the response from method ServiceEndpointPoliciesClient.ListByResourceGroup.

type ServiceEndpointPoliciesClientListOptions

type ServiceEndpointPoliciesClientListOptions struct {
}

ServiceEndpointPoliciesClientListOptions contains the optional parameters for the ServiceEndpointPoliciesClient.List method.

type ServiceEndpointPoliciesClientListResponse

type ServiceEndpointPoliciesClientListResponse struct {
	ServiceEndpointPolicyListResult
}

ServiceEndpointPoliciesClientListResponse contains the response from method ServiceEndpointPoliciesClient.List.

type ServiceEndpointPoliciesClientUpdateTagsOptions

type ServiceEndpointPoliciesClientUpdateTagsOptions struct {
}

ServiceEndpointPoliciesClientUpdateTagsOptions contains the optional parameters for the ServiceEndpointPoliciesClient.UpdateTags method.

type ServiceEndpointPoliciesClientUpdateTagsResponse

type ServiceEndpointPoliciesClientUpdateTagsResponse struct {
	ServiceEndpointPolicy
}

ServiceEndpointPoliciesClientUpdateTagsResponse contains the response 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.

func (*ServiceEndpointPolicy) UnmarshalJSON

func (s *ServiceEndpointPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (ServiceEndpointPolicyDefinition) MarshalJSON

func (s ServiceEndpointPolicyDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceEndpointPolicyDefinition.

func (*ServiceEndpointPolicyDefinition) UnmarshalJSON

func (s *ServiceEndpointPolicyDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceEndpointPolicyDefinition.

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

MarshalJSON implements the json.Marshaller interface for type ServiceEndpointPolicyDefinitionListResult.

func (*ServiceEndpointPolicyDefinitionListResult) UnmarshalJSON

func (s *ServiceEndpointPolicyDefinitionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type ServiceEndpointPolicyDefinitionPropertiesFormat.

func (*ServiceEndpointPolicyDefinitionPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyDefinitionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPolicyDefinitionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "testPolicy", "testDefinition", armnetwork.ServiceEndpointPolicyDefinition{
	Properties: &armnetwork.ServiceEndpointPolicyDefinitionPropertiesFormat{
		Description: to.Ptr("Storage Service EndpointPolicy Definition"),
		Service:     to.Ptr("Microsoft.Storage"),
		ServiceResources: []*string{
			to.Ptr("/subscriptions/subid1"),
			to.Ptr("/subscriptions/subid1/resourceGroups/storageRg"),
			to.Ptr("/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount")},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ServiceEndpointPolicyDefinitionsClient) BeginDelete

func (client *ServiceEndpointPolicyDefinitionsClient) BeginDelete(ctx context.Context, resourceGroupName string, serviceEndpointPolicyName string, serviceEndpointPolicyDefinitionName string, options *ServiceEndpointPolicyDefinitionsClientBeginDeleteOptions) (*runtime.Poller[ServiceEndpointPolicyDefinitionsClientDeleteResponse], error)

BeginDelete - Deletes the specified ServiceEndpoint policy definitions. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyDefinitionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPolicyDefinitionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "testPolicy", "testDefinition", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyDefinitionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPolicyDefinitionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testPolicy", "testDefinition", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*ServiceEndpointPolicyDefinitionsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Gets all service endpoint policy definitions in a service end point policy. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceEndpointPolicyDefinitionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceEndpointPolicyDefinitionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", "testPolicy", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ServiceEndpointPolicyDefinitionsClientBeginCreateOrUpdateOptions

type ServiceEndpointPolicyDefinitionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ServiceEndpointPolicyDefinitionsClientBeginCreateOrUpdateOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.BeginCreateOrUpdate method.

type ServiceEndpointPolicyDefinitionsClientBeginDeleteOptions

type ServiceEndpointPolicyDefinitionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ServiceEndpointPolicyDefinitionsClientBeginDeleteOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.BeginDelete method.

type ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResponse

type ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResponse struct {
	ServiceEndpointPolicyDefinition
}

ServiceEndpointPolicyDefinitionsClientCreateOrUpdateResponse contains the response from method ServiceEndpointPolicyDefinitionsClient.CreateOrUpdate.

type ServiceEndpointPolicyDefinitionsClientDeleteResponse

type ServiceEndpointPolicyDefinitionsClientDeleteResponse struct {
}

ServiceEndpointPolicyDefinitionsClientDeleteResponse contains the response from method ServiceEndpointPolicyDefinitionsClient.Delete.

type ServiceEndpointPolicyDefinitionsClientGetOptions

type ServiceEndpointPolicyDefinitionsClientGetOptions struct {
}

ServiceEndpointPolicyDefinitionsClientGetOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.Get method.

type ServiceEndpointPolicyDefinitionsClientGetResponse

type ServiceEndpointPolicyDefinitionsClientGetResponse struct {
	ServiceEndpointPolicyDefinition
}

ServiceEndpointPolicyDefinitionsClientGetResponse contains the response from method ServiceEndpointPolicyDefinitionsClient.Get.

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupOptions

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupOptions struct {
}

ServiceEndpointPolicyDefinitionsClientListByResourceGroupOptions contains the optional parameters for the ServiceEndpointPolicyDefinitionsClient.ListByResourceGroup method.

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupResponse

type ServiceEndpointPolicyDefinitionsClientListByResourceGroupResponse struct {
	ServiceEndpointPolicyDefinitionListResult
}

ServiceEndpointPolicyDefinitionsClientListByResourceGroupResponse contains the response 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.

func (*ServiceEndpointPolicyListResult) UnmarshalJSON

func (s *ServiceEndpointPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ServiceEndpointPolicyPropertiesFormat) UnmarshalJSON

func (s *ServiceEndpointPolicyPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ServiceEndpointPropertiesFormat) UnmarshalJSON

func (s *ServiceEndpointPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (ServiceTagInformation) MarshalJSON

func (s ServiceTagInformation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceTagInformation.

func (*ServiceTagInformation) UnmarshalJSON

func (s *ServiceTagInformation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceTagInformation.

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, error)

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) NewListPager

NewListPager - Gets a list of service tag information resources with pagination. Generated from API version 2022-05-01 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 (GetListOfServiceTags)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceTagInformationListResult.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceTagInformationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("westeurope", &armnetwork.ServiceTagInformationClientListOptions{NoAddressPrefixes: nil,
	TagName: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

Example (GetListOfServiceTagsWithNoAddressPrefixes)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceTagInformationListResultWithNoAddressPrefixes.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceTagInformationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("westeurope", &armnetwork.ServiceTagInformationClientListOptions{NoAddressPrefixes: to.Ptr(true),
	TagName: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

Example (GetListOfServiceTagsWithTagName)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceTagInformationListResultWithTagname.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceTagInformationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("westeurope", &armnetwork.ServiceTagInformationClientListOptions{NoAddressPrefixes: nil,
	TagName: to.Ptr("ApiManagement"),
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type ServiceTagInformationClientListOptions

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 ServiceTagInformationClientListResponse

type ServiceTagInformationClientListResponse struct {
	ServiceTagInformationListResult
}

ServiceTagInformationClientListResponse contains the response 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.

func (*ServiceTagInformationListResult) UnmarshalJSON

func (s *ServiceTagInformationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*ServiceTagInformationPropertiesFormat) UnmarshalJSON

func (s *ServiceTagInformationPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

List - Gets a list of service tag information resources. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/ServiceTagsList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewServiceTagsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx, "westcentralus", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type ServiceTagsClientListOptions

type ServiceTagsClientListOptions struct {
}

ServiceTagsClientListOptions contains the optional parameters for the ServiceTagsClient.List method.

type ServiceTagsClientListResponse

type ServiceTagsClientListResponse struct {
	ServiceTagsListResult
}

ServiceTagsClientListResponse contains the response 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.

func (*ServiceTagsListResult) UnmarshalJSON

func (s *ServiceTagsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*SessionIDs) UnmarshalJSON

func (s *SessionIDs) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

type SignatureOverridesFilterValuesQuery

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

func (SignatureOverridesFilterValuesQuery) MarshalJSON

func (s SignatureOverridesFilterValuesQuery) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SignatureOverridesFilterValuesQuery.

func (*SignatureOverridesFilterValuesQuery) UnmarshalJSON

func (s *SignatureOverridesFilterValuesQuery) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SignatureOverridesFilterValuesQuery.

type SignatureOverridesFilterValuesResponse

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

func (s SignatureOverridesFilterValuesResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SignatureOverridesFilterValuesResponse.

func (*SignatureOverridesFilterValuesResponse) UnmarshalJSON

func (s *SignatureOverridesFilterValuesResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SignatureOverridesFilterValuesResponse.

type SignaturesOverrides

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

func (s SignaturesOverrides) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SignaturesOverrides.

func (*SignaturesOverrides) UnmarshalJSON

func (s *SignaturesOverrides) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SignaturesOverrides.

type SignaturesOverridesList

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

func (s SignaturesOverridesList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SignaturesOverridesList.

func (*SignaturesOverridesList) UnmarshalJSON

func (s *SignaturesOverridesList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SignaturesOverridesList.

type SignaturesOverridesProperties

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

func (s SignaturesOverridesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SignaturesOverridesProperties.

func (*SignaturesOverridesProperties) UnmarshalJSON

func (s *SignaturesOverridesProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SignaturesOverridesProperties.

type SingleQueryResult

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 *FirewallPolicyIDPSSignatureDirection `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 *FirewallPolicyIDPSSignatureMode `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 *FirewallPolicyIDPSSignatureSeverity `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

func (s SingleQueryResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SingleQueryResult.

func (*SingleQueryResult) UnmarshalJSON

func (s *SingleQueryResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SingleQueryResult.

type SlotType

type SlotType string

SlotType - Specifies slot info on a cloud service

const (
	SlotTypeProduction SlotType = "Production"
	SlotTypeStaging    SlotType = "Staging"
)

func PossibleSlotTypeValues

func PossibleSlotTypeValues() []SlotType

PossibleSlotTypeValues returns the possible values for the SlotType const type.

type StaticMember

type StaticMember struct {
	// The Static Member properties
	Properties *StaticMemberProperties `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 ID.
	ID *string `json:"id,omitempty" azure:"ro"`

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

	// READ-ONLY; The system metadata related to this resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

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

StaticMember Item.

func (StaticMember) MarshalJSON

func (s StaticMember) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StaticMember.

func (*StaticMember) UnmarshalJSON

func (s *StaticMember) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StaticMember.

type StaticMemberListResult

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

	// Gets a page of StaticMember
	Value []*StaticMember `json:"value,omitempty"`
}

StaticMemberListResult - Result of the request to list StaticMember. It contains a list of groups and a URL link to get the next set of results.

func (StaticMemberListResult) MarshalJSON

func (s StaticMemberListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StaticMemberListResult.

func (*StaticMemberListResult) UnmarshalJSON

func (s *StaticMemberListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StaticMemberListResult.

type StaticMemberProperties

type StaticMemberProperties struct {
	// Resource Id.
	ResourceID *string `json:"resourceId,omitempty"`

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

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

StaticMemberProperties - Properties of static member.

func (StaticMemberProperties) MarshalJSON

func (s StaticMemberProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StaticMemberProperties.

func (*StaticMemberProperties) UnmarshalJSON

func (s *StaticMemberProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StaticMemberProperties.

type StaticMembersClient

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

StaticMembersClient contains the methods for the StaticMembers group. Don't use this type directly, use NewStaticMembersClient() instead.

func NewStaticMembersClient

func NewStaticMembersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*StaticMembersClient, error)

NewStaticMembersClient creates a new instance of StaticMembersClient 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 (*StaticMembersClient) CreateOrUpdate

func (client *StaticMembersClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkManagerName string, networkGroupName string, staticMemberName string, parameters StaticMember, options *StaticMembersClientCreateOrUpdateOptions) (StaticMembersClientCreateOrUpdateResponse, error)

CreateOrUpdate - Creates or updates a static member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. networkGroupName - The name of the network group. staticMemberName - The name of the static member. parameters - Parameters supplied to the specify the static member to create options - StaticMembersClientCreateOrUpdateOptions contains the optional parameters for the StaticMembersClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerStaticMemberPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewStaticMembersClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "testNetworkManager", "testNetworkGroup", "testStaticMember", armnetwork.StaticMember{
	Properties: &armnetwork.StaticMemberProperties{
		ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*StaticMembersClient) Delete

func (client *StaticMembersClient) Delete(ctx context.Context, resourceGroupName string, networkManagerName string, networkGroupName string, staticMemberName string, options *StaticMembersClientDeleteOptions) (StaticMembersClientDeleteResponse, error)

Delete - Deletes a static member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. networkGroupName - The name of the network group. staticMemberName - The name of the static member. options - StaticMembersClientDeleteOptions contains the optional parameters for the StaticMembersClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerStaticMemberDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewStaticMembersClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx, "SampleRG", "TestNM", "testNetworkGroup", "testStaticMember", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*StaticMembersClient) Get

func (client *StaticMembersClient) Get(ctx context.Context, resourceGroupName string, networkManagerName string, networkGroupName string, staticMemberName string, options *StaticMembersClientGetOptions) (StaticMembersClientGetResponse, error)

Get - Gets the specified static member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. networkGroupName - The name of the network group. staticMemberName - The name of the static member. options - StaticMembersClientGetOptions contains the optional parameters for the StaticMembersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerStaticMemberGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewStaticMembersClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testNetworkManager", "testNetworkGroup", "testStaticMember", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*StaticMembersClient) NewListPager

func (client *StaticMembersClient) NewListPager(resourceGroupName string, networkManagerName string, networkGroupName string, options *StaticMembersClientListOptions) *runtime.Pager[StaticMembersClientListResponse]

NewListPager - Lists the specified static member. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. networkManagerName - The name of the network manager. networkGroupName - The name of the network group. options - StaticMembersClientListOptions contains the optional parameters for the StaticMembersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerStaticMemberList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewStaticMembersClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "testNetworkManager", "testNetworkGroup", &armnetwork.StaticMembersClientListOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type StaticMembersClientCreateOrUpdateOptions

type StaticMembersClientCreateOrUpdateOptions struct {
}

StaticMembersClientCreateOrUpdateOptions contains the optional parameters for the StaticMembersClient.CreateOrUpdate method.

type StaticMembersClientCreateOrUpdateResponse

type StaticMembersClientCreateOrUpdateResponse struct {
	StaticMember
}

StaticMembersClientCreateOrUpdateResponse contains the response from method StaticMembersClient.CreateOrUpdate.

type StaticMembersClientDeleteOptions

type StaticMembersClientDeleteOptions struct {
}

StaticMembersClientDeleteOptions contains the optional parameters for the StaticMembersClient.Delete method.

type StaticMembersClientDeleteResponse

type StaticMembersClientDeleteResponse struct {
}

StaticMembersClientDeleteResponse contains the response from method StaticMembersClient.Delete.

type StaticMembersClientGetOptions

type StaticMembersClientGetOptions struct {
}

StaticMembersClientGetOptions contains the optional parameters for the StaticMembersClient.Get method.

type StaticMembersClientGetResponse

type StaticMembersClientGetResponse struct {
	StaticMember
}

StaticMembersClientGetResponse contains the response from method StaticMembersClient.Get.

type StaticMembersClientListOptions

type StaticMembersClientListOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

StaticMembersClientListOptions contains the optional parameters for the StaticMembersClient.List method.

type StaticMembersClientListResponse

type StaticMembersClientListResponse struct {
	StaticMemberListResult
}

StaticMembersClientListResponse contains the response from method StaticMembersClient.List.

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.

func (*StaticRoute) UnmarshalJSON

func (s *StaticRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StaticRoute.

type StaticRoutesConfig

type StaticRoutesConfig struct {
	// Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
	VnetLocalRouteOverrideCriteria *VnetLocalRouteOverrideCriteria `json:"vnetLocalRouteOverrideCriteria,omitempty"`

	// READ-ONLY; Boolean indicating whether static routes on this connection are automatically propagate to route tables which
	// this connection propagates to.
	PropagateStaticRoutes *bool `json:"propagateStaticRoutes,omitempty" azure:"ro"`
}

StaticRoutesConfig - Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.

func (StaticRoutesConfig) MarshalJSON

func (s StaticRoutesConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StaticRoutesConfig.

func (*StaticRoutesConfig) UnmarshalJSON

func (s *StaticRoutesConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StaticRoutesConfig.

type SubResource

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

SubResource - Reference to another subresource.

func (SubResource) MarshalJSON

func (s SubResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubResource.

func (*SubResource) UnmarshalJSON

func (s *SubResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type 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.

func (Subnet) MarshalJSON

func (s Subnet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Subnet.

func (*Subnet) UnmarshalJSON

func (s *Subnet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Subnet.

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.

func (*SubnetAssociation) UnmarshalJSON

func (s *SubnetAssociation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*SubnetListResult) UnmarshalJSON

func (s *SubnetListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*SubnetPropertiesFormat) UnmarshalJSON

func (s *SubnetPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[SubnetsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a subnet in the specified virtual network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateSubnet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SubnetCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubnetsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "subnet-test", "vnetname", "subnet1", armnetwork.Subnet{
	Properties: &armnetwork.SubnetPropertiesFormat{
		AddressPrefix: to.Ptr("10.0.0.0/16"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateSubnetWithADelegation)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SubnetCreateWithDelegation.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubnetsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "subnet-test", "vnetname", "subnet1", armnetwork.Subnet{
	Properties: &armnetwork.SubnetPropertiesFormat{
		AddressPrefix: to.Ptr("10.0.0.0/16"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateSubnetWithServiceEndpoints)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SubnetCreateServiceEndpoint.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubnetsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "subnet-test", "vnetname", "subnet1", armnetwork.Subnet{
	Properties: &armnetwork.SubnetPropertiesFormat{
		AddressPrefix: to.Ptr("10.0.0.0/16"),
		ServiceEndpoints: []*armnetwork.ServiceEndpointPropertiesFormat{
			{
				Service: to.Ptr("Microsoft.Storage"),
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SubnetsClient) BeginDelete

func (client *SubnetsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, options *SubnetsClientBeginDeleteOptions) (*runtime.Poller[SubnetsClientDeleteResponse], error)

BeginDelete - Deletes the specified subnet. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SubnetDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubnetsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "subnet-test", "vnetname", "subnet1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*SubnetsClient) BeginPrepareNetworkPolicies

func (client *SubnetsClient) BeginPrepareNetworkPolicies(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, prepareNetworkPoliciesRequestParameters PrepareNetworkPoliciesRequest, options *SubnetsClientBeginPrepareNetworkPoliciesOptions) (*runtime.Poller[SubnetsClientPrepareNetworkPoliciesResponse], error)

BeginPrepareNetworkPolicies - Prepares a subnet by applying network intent policies. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SubnetPrepareNetworkPolicies.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubnetsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginPrepareNetworkPolicies(ctx, "rg1", "test-vnet", "subnet1", armnetwork.PrepareNetworkPoliciesRequest{
	ServiceName: to.Ptr("Microsoft.Sql/managedInstances"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*SubnetsClient) BeginUnprepareNetworkPolicies

func (client *SubnetsClient) BeginUnprepareNetworkPolicies(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, unprepareNetworkPoliciesRequestParameters UnprepareNetworkPoliciesRequest, options *SubnetsClientBeginUnprepareNetworkPoliciesOptions) (*runtime.Poller[SubnetsClientUnprepareNetworkPoliciesResponse], error)

BeginUnprepareNetworkPolicies - Unprepares a subnet by removing network intent policies. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SubnetUnprepareNetworkPolicies.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubnetsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUnprepareNetworkPolicies(ctx, "rg1", "test-vnet", "subnet1", armnetwork.UnprepareNetworkPoliciesRequest{
	ServiceName: to.Ptr("Microsoft.Sql/managedInstances"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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 (GetSubnet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SubnetGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubnetsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "subnet-test", "vnetname", "subnet1", &armnetwork.SubnetsClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetSubnetWithADelegation)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SubnetGetWithDelegation.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubnetsClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "subnet-test", "vnetname", "subnet1", &armnetwork.SubnetsClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SubnetsClient) NewListPager

func (client *SubnetsClient) NewListPager(resourceGroupName string, virtualNetworkName string, options *SubnetsClientListOptions) *runtime.Pager[SubnetsClientListResponse]

NewListPager - Gets all subnets in a virtual network. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/SubnetList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubnetsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("subnet-test", "vnetname", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type SubnetsClientBeginCreateOrUpdateOptions

type SubnetsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SubnetsClientBeginCreateOrUpdateOptions contains the optional parameters for the SubnetsClient.BeginCreateOrUpdate method.

type SubnetsClientBeginDeleteOptions

type SubnetsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SubnetsClientBeginDeleteOptions contains the optional parameters for the SubnetsClient.BeginDelete method.

type SubnetsClientBeginPrepareNetworkPoliciesOptions

type SubnetsClientBeginPrepareNetworkPoliciesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SubnetsClientBeginPrepareNetworkPoliciesOptions contains the optional parameters for the SubnetsClient.BeginPrepareNetworkPolicies method.

type SubnetsClientBeginUnprepareNetworkPoliciesOptions

type SubnetsClientBeginUnprepareNetworkPoliciesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SubnetsClientBeginUnprepareNetworkPoliciesOptions contains the optional parameters for the SubnetsClient.BeginUnprepareNetworkPolicies method.

type SubnetsClientCreateOrUpdateResponse

type SubnetsClientCreateOrUpdateResponse struct {
	Subnet
}

SubnetsClientCreateOrUpdateResponse contains the response from method SubnetsClient.CreateOrUpdate.

type SubnetsClientDeleteResponse

type SubnetsClientDeleteResponse struct {
}

SubnetsClientDeleteResponse contains the response from method SubnetsClient.Delete.

type SubnetsClientGetOptions

type SubnetsClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

SubnetsClientGetOptions contains the optional parameters for the SubnetsClient.Get method.

type SubnetsClientGetResponse

type SubnetsClientGetResponse struct {
	Subnet
}

SubnetsClientGetResponse contains the response from method SubnetsClient.Get.

type SubnetsClientListOptions

type SubnetsClientListOptions struct {
}

SubnetsClientListOptions contains the optional parameters for the SubnetsClient.List method.

type SubnetsClientListResponse

type SubnetsClientListResponse struct {
	SubnetListResult
}

SubnetsClientListResponse contains the response from method SubnetsClient.List.

type SubnetsClientPrepareNetworkPoliciesResponse

type SubnetsClientPrepareNetworkPoliciesResponse struct {
}

SubnetsClientPrepareNetworkPoliciesResponse contains the response from method SubnetsClient.PrepareNetworkPolicies.

type SubnetsClientUnprepareNetworkPoliciesResponse

type SubnetsClientUnprepareNetworkPoliciesResponse struct {
}

SubnetsClientUnprepareNetworkPoliciesResponse contains the response from method SubnetsClient.UnprepareNetworkPolicies.

type SubscriptionNetworkManagerConnectionsClient

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

SubscriptionNetworkManagerConnectionsClient contains the methods for the SubscriptionNetworkManagerConnections group. Don't use this type directly, use NewSubscriptionNetworkManagerConnectionsClient() instead.

func NewSubscriptionNetworkManagerConnectionsClient

func NewSubscriptionNetworkManagerConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SubscriptionNetworkManagerConnectionsClient, error)

NewSubscriptionNetworkManagerConnectionsClient creates a new instance of SubscriptionNetworkManagerConnectionsClient 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 (*SubscriptionNetworkManagerConnectionsClient) CreateOrUpdate

CreateOrUpdate - Create a network manager connection on this subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 networkManagerConnectionName - Name for the network manager connection. parameters - Network manager connection to be created/updated. options - SubscriptionNetworkManagerConnectionsClientCreateOrUpdateOptions contains the optional parameters for the SubscriptionNetworkManagerConnectionsClient.CreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectionSubscriptionPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubscriptionNetworkManagerConnectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "TestNMConnection", armnetwork.ManagerConnection{
	Properties: &armnetwork.ManagerConnectionProperties{
		NetworkManagerID: to.Ptr("/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SubscriptionNetworkManagerConnectionsClient) Delete

Delete - Delete specified connection created by this subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 networkManagerConnectionName - Name for the network manager connection. options - SubscriptionNetworkManagerConnectionsClientDeleteOptions contains the optional parameters for the SubscriptionNetworkManagerConnectionsClient.Delete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectionSubscriptionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubscriptionNetworkManagerConnectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = client.Delete(ctx, "TestNMConnection", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
Output:

func (*SubscriptionNetworkManagerConnectionsClient) Get

Get - Get a specified connection created by this subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 networkManagerConnectionName - Name for the network manager connection. options - SubscriptionNetworkManagerConnectionsClientGetOptions contains the optional parameters for the SubscriptionNetworkManagerConnectionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectionSubscriptionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubscriptionNetworkManagerConnectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "TestNMConnection", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*SubscriptionNetworkManagerConnectionsClient) NewListPager

NewListPager - List all network manager connections created by this subscription. Generated from API version 2022-05-01 options - SubscriptionNetworkManagerConnectionsClientListOptions contains the optional parameters for the SubscriptionNetworkManagerConnectionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkManagerConnectionSubscriptionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewSubscriptionNetworkManagerConnectionsClient("00000000-0000-0000-0000-000000000000", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(&armnetwork.SubscriptionNetworkManagerConnectionsClientListOptions{Top: nil,
	SkipToken: nil,
})
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type SubscriptionNetworkManagerConnectionsClientCreateOrUpdateOptions

type SubscriptionNetworkManagerConnectionsClientCreateOrUpdateOptions struct {
}

SubscriptionNetworkManagerConnectionsClientCreateOrUpdateOptions contains the optional parameters for the SubscriptionNetworkManagerConnectionsClient.CreateOrUpdate method.

type SubscriptionNetworkManagerConnectionsClientCreateOrUpdateResponse

type SubscriptionNetworkManagerConnectionsClientCreateOrUpdateResponse struct {
	ManagerConnection
}

SubscriptionNetworkManagerConnectionsClientCreateOrUpdateResponse contains the response from method SubscriptionNetworkManagerConnectionsClient.CreateOrUpdate.

type SubscriptionNetworkManagerConnectionsClientDeleteOptions

type SubscriptionNetworkManagerConnectionsClientDeleteOptions struct {
}

SubscriptionNetworkManagerConnectionsClientDeleteOptions contains the optional parameters for the SubscriptionNetworkManagerConnectionsClient.Delete method.

type SubscriptionNetworkManagerConnectionsClientDeleteResponse

type SubscriptionNetworkManagerConnectionsClientDeleteResponse struct {
}

SubscriptionNetworkManagerConnectionsClientDeleteResponse contains the response from method SubscriptionNetworkManagerConnectionsClient.Delete.

type SubscriptionNetworkManagerConnectionsClientGetOptions

type SubscriptionNetworkManagerConnectionsClientGetOptions struct {
}

SubscriptionNetworkManagerConnectionsClientGetOptions contains the optional parameters for the SubscriptionNetworkManagerConnectionsClient.Get method.

type SubscriptionNetworkManagerConnectionsClientGetResponse

type SubscriptionNetworkManagerConnectionsClientGetResponse struct {
	ManagerConnection
}

SubscriptionNetworkManagerConnectionsClientGetResponse contains the response from method SubscriptionNetworkManagerConnectionsClient.Get.

type SubscriptionNetworkManagerConnectionsClientListOptions

type SubscriptionNetworkManagerConnectionsClientListOptions struct {
	// SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element,
	// the value of the nextLink element will include a skipToken parameter that
	// specifies a starting point to use for subsequent calls.
	SkipToken *string
	// An optional query parameter which specifies the maximum number of records to be returned by the server.
	Top *int32
}

SubscriptionNetworkManagerConnectionsClientListOptions contains the optional parameters for the SubscriptionNetworkManagerConnectionsClient.List method.

type SubscriptionNetworkManagerConnectionsClientListResponse

type SubscriptionNetworkManagerConnectionsClientListResponse struct {
	ManagerConnectionListResult
}

SubscriptionNetworkManagerConnectionsClientListResponse contains the response from method SubscriptionNetworkManagerConnectionsClient.List.

type SwapResource

type SwapResource struct {
	// Swap resource properties
	Properties *SwapResourceProperties `json:"properties,omitempty"`

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

SwapResource to represent slot type on the specified cloud service.

func (SwapResource) MarshalJSON

func (s SwapResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SwapResource.

func (*SwapResource) UnmarshalJSON

func (s *SwapResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SwapResource.

type SwapResourceListResult

type SwapResourceListResult struct {
	Value []*SwapResource `json:"value,omitempty"`
}

SwapResourceListResult - SwapResource List with single entry to represent slot type on the specified cloud service.

func (SwapResourceListResult) MarshalJSON

func (s SwapResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SwapResourceListResult.

func (*SwapResourceListResult) UnmarshalJSON

func (s *SwapResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SwapResourceListResult.

type SwapResourceProperties

type SwapResourceProperties struct {
	// Specifies slot info on a cloud service
	SlotType *SlotType `json:"slotType,omitempty"`
}

SwapResourceProperties - Swap resource properties

func (SwapResourceProperties) MarshalJSON

func (s SwapResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SwapResourceProperties.

func (*SwapResourceProperties) UnmarshalJSON

func (s *SwapResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SwapResourceProperties.

type SyncRemoteAddressSpace

type SyncRemoteAddressSpace string
const (
	SyncRemoteAddressSpaceTrue SyncRemoteAddressSpace = "true"
)

func PossibleSyncRemoteAddressSpaceValues

func PossibleSyncRemoteAddressSpaceValues() []SyncRemoteAddressSpace

PossibleSyncRemoteAddressSpaceValues returns the possible values for the SyncRemoteAddressSpace const type.

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

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.

func (*TagsObject) UnmarshalJSON

func (t *TagsObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (TopologyAssociation) MarshalJSON

func (t TopologyAssociation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopologyAssociation.

func (*TopologyAssociation) UnmarshalJSON

func (t *TopologyAssociation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopologyAssociation.

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.

func (TopologyParameters) MarshalJSON

func (t TopologyParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TopologyParameters.

func (*TopologyParameters) UnmarshalJSON

func (t *TopologyParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TopologyParameters.

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.

func (*TopologyResource) UnmarshalJSON

func (t *TopologyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (TrafficAnalyticsConfigurationProperties) MarshalJSON

func (t TrafficAnalyticsConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrafficAnalyticsConfigurationProperties.

func (*TrafficAnalyticsConfigurationProperties) UnmarshalJSON

func (t *TrafficAnalyticsConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrafficAnalyticsConfigurationProperties.

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.

func (TrafficAnalyticsProperties) MarshalJSON

func (t TrafficAnalyticsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrafficAnalyticsProperties.

func (*TrafficAnalyticsProperties) UnmarshalJSON

func (t *TrafficAnalyticsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrafficAnalyticsProperties.

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.

func (*TrafficSelectorPolicy) UnmarshalJSON

func (t *TrafficSelectorPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (*TroubleshootingDetails) UnmarshalJSON

func (t *TroubleshootingDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (TroubleshootingParameters) MarshalJSON

func (t TroubleshootingParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TroubleshootingParameters.

func (*TroubleshootingParameters) UnmarshalJSON

func (t *TroubleshootingParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TroubleshootingParameters.

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.

func (TroubleshootingProperties) MarshalJSON

func (t TroubleshootingProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TroubleshootingProperties.

func (*TroubleshootingProperties) UnmarshalJSON

func (t *TroubleshootingProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TroubleshootingProperties.

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.

func (TroubleshootingRecommendedActions) MarshalJSON

func (t TroubleshootingRecommendedActions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TroubleshootingRecommendedActions.

func (*TroubleshootingRecommendedActions) UnmarshalJSON

func (t *TroubleshootingRecommendedActions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TroubleshootingRecommendedActions.

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.

func (TunnelConnectionHealth) MarshalJSON

func (t TunnelConnectionHealth) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TunnelConnectionHealth.

func (*TunnelConnectionHealth) UnmarshalJSON

func (t *TunnelConnectionHealth) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TunnelConnectionHealth.

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.

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.

func (UnprepareNetworkPoliciesRequest) MarshalJSON

func (u UnprepareNetworkPoliciesRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UnprepareNetworkPoliciesRequest.

func (*UnprepareNetworkPoliciesRequest) UnmarshalJSON

func (u *UnprepareNetworkPoliciesRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UnprepareNetworkPoliciesRequest.

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.

func (Usage) MarshalJSON

func (u Usage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Usage.

func (*Usage) UnmarshalJSON

func (u *Usage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type 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.

func (UsageName) MarshalJSON

func (u UsageName) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UsageName.

func (*UsageName) UnmarshalJSON

func (u *UsageName) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UsageName.

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.

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, error)

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) NewListPager

func (client *UsagesClient) NewListPager(location string, options *UsagesClientListOptions) *runtime.Pager[UsagesClientListResponse]

NewListPager - List network usages for a subscription. Generated from API version 2022-05-01 location - The location where resource usage is queried. options - UsagesClientListOptions contains the optional parameters for the UsagesClient.List method.

Example (ListUsages)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/UsageList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewUsagesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("westus", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

Example (ListUsagesSpacedLocation)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/UsageListSpacedLocation.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewUsagesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("West US", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type UsagesClientListOptions

type UsagesClientListOptions struct {
}

UsagesClientListOptions contains the optional parameters for the UsagesClient.List method.

type UsagesClientListResponse

type UsagesClientListResponse struct {
	UsagesListResult
}

UsagesClientListResponse contains the response 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.

func (*UsagesListResult) UnmarshalJSON

func (u *UsagesListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UsagesListResult.

type UseHubGateway

type UseHubGateway string

UseHubGateway - Flag if need to use hub gateway.

const (
	UseHubGatewayFalse UseHubGateway = "False"
	UseHubGatewayTrue  UseHubGateway = "True"
)

func PossibleUseHubGatewayValues

func PossibleUseHubGatewayValues() []UseHubGateway

PossibleUseHubGatewayValues returns the possible values for the UseHubGateway const type.

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

func (v VM) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VM.

func (*VM) UnmarshalJSON

func (v *VM) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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

	// per ip address pool connection policy for virtual network gateway P2S client.
	VngClientConnectionConfigurations []*VngClientConnectionConfiguration `json:"vngClientConnectionConfigurations,omitempty"`
}

VPNClientConfiguration - VpnClientConfiguration for P2S client.

func (VPNClientConfiguration) MarshalJSON

func (v VPNClientConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNClientConfiguration.

func (*VPNClientConfiguration) UnmarshalJSON

func (v *VPNClientConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VPNClientConnectionHealth) UnmarshalJSON

func (v *VPNClientConnectionHealth) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VPNClientConnectionHealthDetail) MarshalJSON

func (v VPNClientConnectionHealthDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNClientConnectionHealthDetail.

func (*VPNClientConnectionHealthDetail) UnmarshalJSON

func (v *VPNClientConnectionHealthDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNClientConnectionHealthDetail.

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

MarshalJSON implements the json.Marshaller interface for type VPNClientConnectionHealthDetailListResult.

func (*VPNClientConnectionHealthDetailListResult) UnmarshalJSON

func (v *VPNClientConnectionHealthDetailListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VPNClientIPsecParameters) MarshalJSON

func (v VPNClientIPsecParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNClientIPsecParameters.

func (*VPNClientIPsecParameters) UnmarshalJSON

func (v *VPNClientIPsecParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNClientIPsecParameters.

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.

func (*VPNClientParameters) UnmarshalJSON

func (v *VPNClientParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (VPNClientRevokedCertificate) MarshalJSON

func (v VPNClientRevokedCertificate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNClientRevokedCertificate.

func (*VPNClientRevokedCertificate) UnmarshalJSON

func (v *VPNClientRevokedCertificate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNClientRevokedCertificate.

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.

func (VPNClientRevokedCertificatePropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VPNClientRevokedCertificatePropertiesFormat.

func (*VPNClientRevokedCertificatePropertiesFormat) UnmarshalJSON

func (v *VPNClientRevokedCertificatePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNClientRevokedCertificatePropertiesFormat.

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.

func (VPNClientRootCertificate) MarshalJSON

func (v VPNClientRootCertificate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNClientRootCertificate.

func (*VPNClientRootCertificate) UnmarshalJSON

func (v *VPNClientRootCertificate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNClientRootCertificate.

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.

func (VPNClientRootCertificatePropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VPNClientRootCertificatePropertiesFormat.

func (*VPNClientRootCertificatePropertiesFormat) UnmarshalJSON

func (v *VPNClientRootCertificatePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNClientRootCertificatePropertiesFormat.

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.

func (VPNConnection) MarshalJSON

func (v VPNConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNConnection.

func (*VPNConnection) UnmarshalJSON

func (v *VPNConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNConnection.

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

MarshalJSON implements the json.Marshaller interface for type VPNConnectionPacketCaptureStartParameters.

func (*VPNConnectionPacketCaptureStartParameters) UnmarshalJSON

func (v *VPNConnectionPacketCaptureStartParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type VPNConnectionPacketCaptureStopParameters.

func (*VPNConnectionPacketCaptureStopParameters) UnmarshalJSON

func (v *VPNConnectionPacketCaptureStopParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VPNConnectionProperties) UnmarshalJSON

func (v *VPNConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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, error)

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) (*runtime.Poller[VPNConnectionsClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnConnectionPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "gateway1", "vpnConnection1", armnetwork.VPNConnection{
	Properties: &armnetwork.VPNConnectionProperties{
		RemoteVPNSite: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
		},
		RoutingConfiguration: &armnetwork.RoutingConfiguration{
			AssociatedRouteTable: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
			},
			InboundRouteMap: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"),
			},
			OutboundRouteMap: &armnetwork.SubResource{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"),
			},
			PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
				IDs: []*armnetwork.SubResource{
					{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
					},
					{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"),
					},
					{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"),
					}},
				Labels: []*string{
					to.Ptr("label1"),
					to.Ptr("label2")},
			},
		},
		TrafficSelectorPolicies: []*armnetwork.TrafficSelectorPolicy{},
		VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
			{
				Name: to.Ptr("Connection-Link1"),
				Properties: &armnetwork.VPNSiteLinkConnectionProperties{
					ConnectionBandwidth:            to.Ptr[int32](200),
					SharedKey:                      to.Ptr("key"),
					UsePolicyBasedTrafficSelectors: to.Ptr(false),
					VPNConnectionProtocolType:      to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
					VPNLinkConnectionMode:          to.Ptr(armnetwork.VPNLinkConnectionModeDefault),
					VPNSiteLink: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
					},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNConnectionsClient) BeginDelete

func (client *VPNConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, gatewayName string, connectionName string, options *VPNConnectionsClientBeginDeleteOptions) (*runtime.Poller[VPNConnectionsClientDeleteResponse], error)

BeginDelete - Deletes a vpn connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnConnectionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "gateway1", "vpnConnection1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VPNConnectionsClient) BeginStartPacketCapture

func (client *VPNConnectionsClient) BeginStartPacketCapture(ctx context.Context, resourceGroupName string, gatewayName string, vpnConnectionName string, options *VPNConnectionsClientBeginStartPacketCaptureOptions) (*runtime.Poller[VPNConnectionsClientStartPacketCaptureResponse], error)

BeginStartPacketCapture - Starts packet capture on Vpn connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (StartPacketCaptureOnVpnConnectionWithFilter)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnConnectionStartPacketCaptureFilterData.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStartPacketCapture(ctx, "rg1", "gateway1", "vpnConnection1", &armnetwork.VPNConnectionsClientBeginStartPacketCaptureOptions{Parameters: &armnetwork.VPNConnectionPacketCaptureStartParameters{
	FilterData: to.Ptr("{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}"),
	LinkConnectionNames: []*string{
		to.Ptr("siteLink1"),
		to.Ptr("siteLink2")},
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (StartPacketCaptureOnVpnConnectionWithoutFilter)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnConnectionStartPacketCapture.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStartPacketCapture(ctx, "rg1", "gateway1", "vpnConnection1", &armnetwork.VPNConnectionsClientBeginStartPacketCaptureOptions{Parameters: &armnetwork.VPNConnectionPacketCaptureStartParameters{
	LinkConnectionNames: []*string{
		to.Ptr("siteLink1"),
		to.Ptr("siteLink2")},
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNConnectionsClient) BeginStopPacketCapture

func (client *VPNConnectionsClient) BeginStopPacketCapture(ctx context.Context, resourceGroupName string, gatewayName string, vpnConnectionName string, options *VPNConnectionsClientBeginStopPacketCaptureOptions) (*runtime.Poller[VPNConnectionsClientStopPacketCaptureResponse], error)

BeginStopPacketCapture - Stops packet capture on Vpn connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnConnectionStopPacketCapture.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStopPacketCapture(ctx, "rg1", "gateway1", "vpnConnection1", &armnetwork.VPNConnectionsClientBeginStopPacketCaptureOptions{Parameters: &armnetwork.VPNConnectionPacketCaptureStopParameters{
	LinkConnectionNames: []*string{
		to.Ptr("vpnSiteLink1"),
		to.Ptr("vpnSiteLink2")},
	SasURL: to.Ptr("https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D"),
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "gateway1", "vpnConnection1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNConnectionsClient) NewListByVPNGatewayPager

func (client *VPNConnectionsClient) NewListByVPNGatewayPager(resourceGroupName string, gatewayName string, options *VPNConnectionsClientListByVPNGatewayOptions) *runtime.Pager[VPNConnectionsClientListByVPNGatewayResponse]

NewListByVPNGatewayPager - Retrieves all vpn connections for a particular virtual wan vpn gateway. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnConnectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByVPNGatewayPager("rg1", "gateway1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VPNConnectionsClientBeginCreateOrUpdateOptions

type VPNConnectionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNConnectionsClient.BeginCreateOrUpdate method.

type VPNConnectionsClientBeginDeleteOptions

type VPNConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNConnectionsClientBeginDeleteOptions contains the optional parameters for the VPNConnectionsClient.BeginDelete method.

type VPNConnectionsClientBeginStartPacketCaptureOptions

type VPNConnectionsClientBeginStartPacketCaptureOptions struct {
	// Vpn Connection packet capture parameters supplied to start packet capture on gateway connection.
	Parameters *VPNConnectionPacketCaptureStartParameters
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNConnectionsClientBeginStartPacketCaptureOptions contains the optional parameters for the VPNConnectionsClient.BeginStartPacketCapture method.

type VPNConnectionsClientBeginStopPacketCaptureOptions

type VPNConnectionsClientBeginStopPacketCaptureOptions struct {
	// Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection.
	Parameters *VPNConnectionPacketCaptureStopParameters
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNConnectionsClientBeginStopPacketCaptureOptions contains the optional parameters for the VPNConnectionsClient.BeginStopPacketCapture method.

type VPNConnectionsClientCreateOrUpdateResponse

type VPNConnectionsClientCreateOrUpdateResponse struct {
	VPNConnection
}

VPNConnectionsClientCreateOrUpdateResponse contains the response from method VPNConnectionsClient.CreateOrUpdate.

type VPNConnectionsClientDeleteResponse

type VPNConnectionsClientDeleteResponse struct {
}

VPNConnectionsClientDeleteResponse contains the response from method VPNConnectionsClient.Delete.

type VPNConnectionsClientGetOptions

type VPNConnectionsClientGetOptions struct {
}

VPNConnectionsClientGetOptions contains the optional parameters for the VPNConnectionsClient.Get method.

type VPNConnectionsClientGetResponse

type VPNConnectionsClientGetResponse struct {
	VPNConnection
}

VPNConnectionsClientGetResponse contains the response from method VPNConnectionsClient.Get.

type VPNConnectionsClientListByVPNGatewayOptions

type VPNConnectionsClientListByVPNGatewayOptions struct {
}

VPNConnectionsClientListByVPNGatewayOptions contains the optional parameters for the VPNConnectionsClient.ListByVPNGateway method.

type VPNConnectionsClientListByVPNGatewayResponse

type VPNConnectionsClientListByVPNGatewayResponse struct {
	ListVPNConnectionsResult
}

VPNConnectionsClientListByVPNGatewayResponse contains the response from method VPNConnectionsClient.ListByVPNGateway.

type VPNConnectionsClientStartPacketCaptureResponse

type VPNConnectionsClientStartPacketCaptureResponse struct {
	Value *string
}

VPNConnectionsClientStartPacketCaptureResponse contains the response from method VPNConnectionsClient.StartPacketCapture.

func (*VPNConnectionsClientStartPacketCaptureResponse) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VPNConnectionsClientStartPacketCaptureResponse.

type VPNConnectionsClientStopPacketCaptureResponse

type VPNConnectionsClientStopPacketCaptureResponse struct {
	Value *string
}

VPNConnectionsClientStopPacketCaptureResponse contains the response from method VPNConnectionsClient.StopPacketCapture.

func (*VPNConnectionsClientStopPacketCaptureResponse) UnmarshalJSON

func (v *VPNConnectionsClientStopPacketCaptureResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNConnectionsClientStopPacketCaptureResponse.

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.

func (VPNDeviceScriptParameters) MarshalJSON

func (v VPNDeviceScriptParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNDeviceScriptParameters.

func (*VPNDeviceScriptParameters) UnmarshalJSON

func (v *VPNDeviceScriptParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNDeviceScriptParameters.

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.

func (*VPNGateway) UnmarshalJSON

func (v *VPNGateway) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

func (VPNGatewayIPConfiguration) MarshalJSON

func (v VPNGatewayIPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNGatewayIPConfiguration.

func (*VPNGatewayIPConfiguration) UnmarshalJSON

func (v *VPNGatewayIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNGatewayIPConfiguration.

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.

func (VPNGatewayNatRule) MarshalJSON

func (v VPNGatewayNatRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNGatewayNatRule.

func (*VPNGatewayNatRule) UnmarshalJSON

func (v *VPNGatewayNatRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNGatewayNatRule.

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.

func (*VPNGatewayNatRuleProperties) UnmarshalJSON

func (v *VPNGatewayNatRuleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VPNGatewayPacketCaptureStartParameters) MarshalJSON

func (v VPNGatewayPacketCaptureStartParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNGatewayPacketCaptureStartParameters.

func (*VPNGatewayPacketCaptureStartParameters) UnmarshalJSON

func (v *VPNGatewayPacketCaptureStartParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNGatewayPacketCaptureStartParameters.

type VPNGatewayPacketCaptureStopParameters

type VPNGatewayPacketCaptureStopParameters struct {
	// SAS url for packet capture on vpn gateway.
	SasURL *string `json:"sasUrl,omitempty"`
}

VPNGatewayPacketCaptureStopParameters - Stop packet capture parameters.

func (VPNGatewayPacketCaptureStopParameters) MarshalJSON

func (v VPNGatewayPacketCaptureStopParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNGatewayPacketCaptureStopParameters.

func (*VPNGatewayPacketCaptureStopParameters) UnmarshalJSON

func (v *VPNGatewayPacketCaptureStopParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNGatewayPacketCaptureStopParameters.

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.

func (*VPNGatewayProperties) UnmarshalJSON

func (v *VPNGatewayProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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, error)

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) (*runtime.Poller[VPNGatewaysClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnGatewayPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "gateway1", armnetwork.VPNGateway{
	Location: to.Ptr("westcentralus"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.VPNGatewayProperties{
		BgpSettings: &armnetwork.BgpSettings{
			Asn: to.Ptr[int64](65515),
			BgpPeeringAddresses: []*armnetwork.IPConfigurationBgpPeeringAddress{
				{
					CustomBgpIPAddresses: []*string{
						to.Ptr("169.254.21.5")},
					IPConfigurationID: to.Ptr("Instance0"),
				},
				{
					CustomBgpIPAddresses: []*string{
						to.Ptr("169.254.21.10")},
					IPConfigurationID: to.Ptr("Instance1"),
				}},
			PeerWeight: to.Ptr[int32](0),
		},
		Connections: []*armnetwork.VPNConnection{
			{
				Name: to.Ptr("vpnConnection1"),
				Properties: &armnetwork.VPNConnectionProperties{
					RemoteVPNSite: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1"),
					},
					VPNLinkConnections: []*armnetwork.VPNSiteLinkConnection{
						{
							Name: to.Ptr("Connection-Link1"),
							Properties: &armnetwork.VPNSiteLinkConnectionProperties{
								ConnectionBandwidth: to.Ptr[int32](200),
								EgressNatRules: []*armnetwork.SubResource{
									{
										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03"),
									}},
								SharedKey:                 to.Ptr("key"),
								VPNConnectionProtocolType: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
								VPNSiteLink: &armnetwork.SubResource{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1"),
								},
							},
						}},
				},
			}},
		EnableBgpRouteTranslationForNat: to.Ptr(false),
		IsRoutingPreferenceInternet:     to.Ptr(false),
		NatRules: []*armnetwork.VPNGatewayNatRule{
			{
				Name: to.Ptr("nat03"),
				Properties: &armnetwork.VPNGatewayNatRuleProperties{
					Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
					ExternalMappings: []*armnetwork.VPNNatRuleMapping{
						{
							AddressSpace: to.Ptr("192.168.0.0/26"),
						}},
					InternalMappings: []*armnetwork.VPNNatRuleMapping{
						{
							AddressSpace: to.Ptr("0.0.0.0/26"),
						}},
					IPConfigurationID: to.Ptr(""),
					Mode:              to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
				},
			}},
		VirtualHub: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNGatewaysClient) BeginDelete

func (client *VPNGatewaysClient) BeginDelete(ctx context.Context, resourceGroupName string, gatewayName string, options *VPNGatewaysClientBeginDeleteOptions) (*runtime.Poller[VPNGatewaysClientDeleteResponse], error)

BeginDelete - Deletes a virtual wan vpn gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnGatewayDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "gateway1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VPNGatewaysClient) BeginReset

func (client *VPNGatewaysClient) BeginReset(ctx context.Context, resourceGroupName string, gatewayName string, options *VPNGatewaysClientBeginResetOptions) (*runtime.Poller[VPNGatewaysClientResetResponse], error)

BeginReset - Resets the primary of the vpn gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnGatewayReset.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginReset(ctx, "rg1", "vpngw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNGatewaysClient) BeginStartPacketCapture

func (client *VPNGatewaysClient) BeginStartPacketCapture(ctx context.Context, resourceGroupName string, gatewayName string, options *VPNGatewaysClientBeginStartPacketCaptureOptions) (*runtime.Poller[VPNGatewaysClientStartPacketCaptureResponse], error)

BeginStartPacketCapture - Starts packet capture on vpn gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (StartPacketCaptureOnVpnGatewayWithFilter)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnGatewayStartPacketCaptureFilterData.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStartPacketCapture(ctx, "rg1", "vpngw", &armnetwork.VPNGatewaysClientBeginStartPacketCaptureOptions{Parameters: &armnetwork.VPNGatewayPacketCaptureStartParameters{
	FilterData: to.Ptr("{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}"),
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (StartPacketCaptureOnVpnGatewayWithoutFilter)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnGatewayStartPacketCapture.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStartPacketCapture(ctx, "rg1", "vpngw", &armnetwork.VPNGatewaysClientBeginStartPacketCaptureOptions{Parameters: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNGatewaysClient) BeginStopPacketCapture

func (client *VPNGatewaysClient) BeginStopPacketCapture(ctx context.Context, resourceGroupName string, gatewayName string, options *VPNGatewaysClientBeginStopPacketCaptureOptions) (*runtime.Poller[VPNGatewaysClientStopPacketCaptureResponse], error)

BeginStopPacketCapture - Stops packet capture on vpn gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnGatewayStopPacketCapture.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStopPacketCapture(ctx, "rg1", "vpngw", &armnetwork.VPNGatewaysClientBeginStopPacketCaptureOptions{Parameters: &armnetwork.VPNGatewayPacketCaptureStopParameters{
	SasURL: to.Ptr("https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D"),
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNGatewaysClient) BeginUpdateTags

func (client *VPNGatewaysClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, gatewayName string, vpnGatewayParameters TagsObject, options *VPNGatewaysClientBeginUpdateTagsOptions) (*runtime.Poller[VPNGatewaysClientUpdateTagsResponse], error)

BeginUpdateTags - Updates virtual wan vpn gateway tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnGatewayUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdateTags(ctx, "rg1", "gateway1", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnGatewayGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "gateway1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNGatewaysClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all the VpnGateways in a resource group. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the VpnGateway. options - VPNGatewaysClientListByResourceGroupOptions contains the optional parameters for the VPNGatewaysClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnGatewayListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VPNGatewaysClient) NewListPager

NewListPager - Lists all the VpnGateways in a subscription. Generated from API version 2022-05-01 options - VPNGatewaysClientListOptions contains the optional parameters for the VPNGatewaysClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnGatewayList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VPNGatewaysClientBeginCreateOrUpdateOptions

type VPNGatewaysClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNGatewaysClient.BeginCreateOrUpdate method.

type VPNGatewaysClientBeginDeleteOptions

type VPNGatewaysClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNGatewaysClientBeginDeleteOptions contains the optional parameters for the VPNGatewaysClient.BeginDelete method.

type VPNGatewaysClientBeginResetOptions

type VPNGatewaysClientBeginResetOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNGatewaysClientBeginResetOptions contains the optional parameters for the VPNGatewaysClient.BeginReset method.

type VPNGatewaysClientBeginStartPacketCaptureOptions

type VPNGatewaysClientBeginStartPacketCaptureOptions struct {
	// Vpn gateway packet capture parameters supplied to start packet capture on vpn gateway.
	Parameters *VPNGatewayPacketCaptureStartParameters
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNGatewaysClientBeginStartPacketCaptureOptions contains the optional parameters for the VPNGatewaysClient.BeginStartPacketCapture method.

type VPNGatewaysClientBeginStopPacketCaptureOptions

type VPNGatewaysClientBeginStopPacketCaptureOptions struct {
	// Vpn gateway packet capture parameters supplied to stop packet capture on vpn gateway.
	Parameters *VPNGatewayPacketCaptureStopParameters
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNGatewaysClientBeginStopPacketCaptureOptions contains the optional parameters for the VPNGatewaysClient.BeginStopPacketCapture method.

type VPNGatewaysClientBeginUpdateTagsOptions

type VPNGatewaysClientBeginUpdateTagsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the VPNGatewaysClient.BeginUpdateTags method.

type VPNGatewaysClientCreateOrUpdateResponse

type VPNGatewaysClientCreateOrUpdateResponse struct {
	VPNGateway
}

VPNGatewaysClientCreateOrUpdateResponse contains the response from method VPNGatewaysClient.CreateOrUpdate.

type VPNGatewaysClientDeleteResponse

type VPNGatewaysClientDeleteResponse struct {
}

VPNGatewaysClientDeleteResponse contains the response from method VPNGatewaysClient.Delete.

type VPNGatewaysClientGetOptions

type VPNGatewaysClientGetOptions struct {
}

VPNGatewaysClientGetOptions contains the optional parameters for the VPNGatewaysClient.Get method.

type VPNGatewaysClientGetResponse

type VPNGatewaysClientGetResponse struct {
	VPNGateway
}

VPNGatewaysClientGetResponse contains the response from method VPNGatewaysClient.Get.

type VPNGatewaysClientListByResourceGroupOptions

type VPNGatewaysClientListByResourceGroupOptions struct {
}

VPNGatewaysClientListByResourceGroupOptions contains the optional parameters for the VPNGatewaysClient.ListByResourceGroup method.

type VPNGatewaysClientListByResourceGroupResponse

type VPNGatewaysClientListByResourceGroupResponse struct {
	ListVPNGatewaysResult
}

VPNGatewaysClientListByResourceGroupResponse contains the response from method VPNGatewaysClient.ListByResourceGroup.

type VPNGatewaysClientListOptions

type VPNGatewaysClientListOptions struct {
}

VPNGatewaysClientListOptions contains the optional parameters for the VPNGatewaysClient.List method.

type VPNGatewaysClientListResponse

type VPNGatewaysClientListResponse struct {
	ListVPNGatewaysResult
}

VPNGatewaysClientListResponse contains the response from method VPNGatewaysClient.List.

type VPNGatewaysClientResetResponse

type VPNGatewaysClientResetResponse struct {
	VPNGateway
}

VPNGatewaysClientResetResponse contains the response from method VPNGatewaysClient.Reset.

type VPNGatewaysClientStartPacketCaptureResponse

type VPNGatewaysClientStartPacketCaptureResponse struct {
	Value *string
}

VPNGatewaysClientStartPacketCaptureResponse contains the response from method VPNGatewaysClient.StartPacketCapture.

func (*VPNGatewaysClientStartPacketCaptureResponse) UnmarshalJSON

func (v *VPNGatewaysClientStartPacketCaptureResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNGatewaysClientStartPacketCaptureResponse.

type VPNGatewaysClientStopPacketCaptureResponse

type VPNGatewaysClientStopPacketCaptureResponse struct {
	Value *string
}

VPNGatewaysClientStopPacketCaptureResponse contains the response from method VPNGatewaysClient.StopPacketCapture.

func (*VPNGatewaysClientStopPacketCaptureResponse) UnmarshalJSON

func (v *VPNGatewaysClientStopPacketCaptureResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNGatewaysClientStopPacketCaptureResponse.

type VPNGatewaysClientUpdateTagsResponse

type VPNGatewaysClientUpdateTagsResponse struct {
	VPNGateway
}

VPNGatewaysClientUpdateTagsResponse contains the response 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.

func (VPNLinkBgpSettings) MarshalJSON

func (v VPNLinkBgpSettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNLinkBgpSettings.

func (*VPNLinkBgpSettings) UnmarshalJSON

func (v *VPNLinkBgpSettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNLinkBgpSettings.

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.

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, error)

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) (*runtime.Poller[VPNLinkConnectionsClientGetIkeSasResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteLinkConnectionGetIkeSas.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNLinkConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetIkeSas(ctx, "rg1", "gateway1", "vpnConnection1", "Connection-Link1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNLinkConnectionsClient) BeginResetConnection

func (client *VPNLinkConnectionsClient) BeginResetConnection(ctx context.Context, resourceGroupName string, gatewayName string, connectionName string, linkConnectionName string, options *VPNLinkConnectionsClientBeginResetConnectionOptions) (*runtime.Poller[VPNLinkConnectionsClientResetConnectionResponse], error)

BeginResetConnection - Resets the VpnLink connection specified. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteLinkConnectionReset.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNLinkConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginResetConnection(ctx, "rg1", "gateway1", "vpnConnection1", "Connection-Link1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VPNLinkConnectionsClient) NewListByVPNConnectionPager

func (client *VPNLinkConnectionsClient) NewListByVPNConnectionPager(resourceGroupName string, gatewayName string, connectionName string, options *VPNLinkConnectionsClientListByVPNConnectionOptions) *runtime.Pager[VPNLinkConnectionsClientListByVPNConnectionResponse]

NewListByVPNConnectionPager - Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteLinkConnectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNLinkConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByVPNConnectionPager("rg1", "gateway1", "vpnConnection1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VPNLinkConnectionsClientBeginGetIkeSasOptions

type VPNLinkConnectionsClientBeginGetIkeSasOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNLinkConnectionsClientBeginGetIkeSasOptions contains the optional parameters for the VPNLinkConnectionsClient.BeginGetIkeSas method.

type VPNLinkConnectionsClientBeginResetConnectionOptions

type VPNLinkConnectionsClientBeginResetConnectionOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNLinkConnectionsClientBeginResetConnectionOptions contains the optional parameters for the VPNLinkConnectionsClient.BeginResetConnection method.

type VPNLinkConnectionsClientGetIkeSasResponse

type VPNLinkConnectionsClientGetIkeSasResponse struct {
	Value *string
}

VPNLinkConnectionsClientGetIkeSasResponse contains the response from method VPNLinkConnectionsClient.GetIkeSas.

func (*VPNLinkConnectionsClientGetIkeSasResponse) UnmarshalJSON

func (v *VPNLinkConnectionsClientGetIkeSasResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNLinkConnectionsClientGetIkeSasResponse.

type VPNLinkConnectionsClientListByVPNConnectionOptions

type VPNLinkConnectionsClientListByVPNConnectionOptions struct {
}

VPNLinkConnectionsClientListByVPNConnectionOptions contains the optional parameters for the VPNLinkConnectionsClient.ListByVPNConnection method.

type VPNLinkConnectionsClientListByVPNConnectionResponse

type VPNLinkConnectionsClientListByVPNConnectionResponse struct {
	ListVPNSiteLinkConnectionsResult
}

VPNLinkConnectionsClientListByVPNConnectionResponse contains the response from method VPNLinkConnectionsClient.ListByVPNConnection.

type VPNLinkConnectionsClientResetConnectionResponse

type VPNLinkConnectionsClientResetConnectionResponse struct {
}

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.

func (VPNLinkProviderProperties) MarshalJSON

func (v VPNLinkProviderProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNLinkProviderProperties.

func (*VPNLinkProviderProperties) UnmarshalJSON

func (v *VPNLinkProviderProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNLinkProviderProperties.

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.

func (VPNNatRuleMapping) MarshalJSON

func (v VPNNatRuleMapping) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNNatRuleMapping.

func (*VPNNatRuleMapping) UnmarshalJSON

func (v *VPNNatRuleMapping) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNNatRuleMapping.

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.

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.

type VPNPacketCaptureStartParameters

type VPNPacketCaptureStartParameters struct {
	// Start Packet capture parameters.
	FilterData *string `json:"filterData,omitempty"`
}

VPNPacketCaptureStartParameters - Start packet capture parameters on virtual network gateway.

func (VPNPacketCaptureStartParameters) MarshalJSON

func (v VPNPacketCaptureStartParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNPacketCaptureStartParameters.

func (*VPNPacketCaptureStartParameters) UnmarshalJSON

func (v *VPNPacketCaptureStartParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNPacketCaptureStartParameters.

type VPNPacketCaptureStopParameters

type VPNPacketCaptureStopParameters struct {
	// SAS url for packet capture on virtual network gateway.
	SasURL *string `json:"sasUrl,omitempty"`
}

VPNPacketCaptureStopParameters - Stop packet capture parameters.

func (VPNPacketCaptureStopParameters) MarshalJSON

func (v VPNPacketCaptureStopParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNPacketCaptureStopParameters.

func (*VPNPacketCaptureStopParameters) UnmarshalJSON

func (v *VPNPacketCaptureStopParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNPacketCaptureStopParameters.

type VPNPolicyMemberAttributeType

type VPNPolicyMemberAttributeType string

VPNPolicyMemberAttributeType - The Vpn Policy member attribute type.

const (
	VPNPolicyMemberAttributeTypeAADGroupID         VPNPolicyMemberAttributeType = "AADGroupId"
	VPNPolicyMemberAttributeTypeCertificateGroupID VPNPolicyMemberAttributeType = "CertificateGroupId"
	VPNPolicyMemberAttributeTypeRadiusAzureGroupID VPNPolicyMemberAttributeType = "RadiusAzureGroupId"
)

func PossibleVPNPolicyMemberAttributeTypeValues

func PossibleVPNPolicyMemberAttributeTypeValues() []VPNPolicyMemberAttributeType

PossibleVPNPolicyMemberAttributeTypeValues returns the possible values for the VPNPolicyMemberAttributeType const type.

type VPNProfileResponse

type VPNProfileResponse struct {
	// URL to the VPN profile.
	ProfileURL *string `json:"profileUrl,omitempty"`
}

VPNProfileResponse - Vpn Profile Response for package generation.

func (VPNProfileResponse) MarshalJSON

func (v VPNProfileResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNProfileResponse.

func (*VPNProfileResponse) UnmarshalJSON

func (v *VPNProfileResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNProfileResponse.

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.

func (VPNServerConfigRadiusClientRootCertificate) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VPNServerConfigRadiusClientRootCertificate.

func (*VPNServerConfigRadiusClientRootCertificate) UnmarshalJSON

func (v *VPNServerConfigRadiusClientRootCertificate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNServerConfigRadiusClientRootCertificate.

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.

func (VPNServerConfigRadiusServerRootCertificate) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VPNServerConfigRadiusServerRootCertificate.

func (*VPNServerConfigRadiusServerRootCertificate) UnmarshalJSON

func (v *VPNServerConfigRadiusServerRootCertificate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNServerConfigRadiusServerRootCertificate.

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.

func (VPNServerConfigVPNClientRevokedCertificate) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VPNServerConfigVPNClientRevokedCertificate.

func (*VPNServerConfigVPNClientRevokedCertificate) UnmarshalJSON

func (v *VPNServerConfigVPNClientRevokedCertificate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNServerConfigVPNClientRevokedCertificate.

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.

func (VPNServerConfigVPNClientRootCertificate) MarshalJSON

func (v VPNServerConfigVPNClientRootCertificate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNServerConfigVPNClientRootCertificate.

func (*VPNServerConfigVPNClientRootCertificate) UnmarshalJSON

func (v *VPNServerConfigVPNClientRootCertificate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNServerConfigVPNClientRootCertificate.

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.

func (*VPNServerConfiguration) UnmarshalJSON

func (v *VPNServerConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNServerConfiguration.

type VPNServerConfigurationPolicyGroup

type VPNServerConfigurationPolicyGroup 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 VpnServerConfigurationPolicyGroup.
	Properties *VPNServerConfigurationPolicyGroupProperties `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"`
}

VPNServerConfigurationPolicyGroup - VpnServerConfigurationPolicyGroup Resource.

func (VPNServerConfigurationPolicyGroup) MarshalJSON

func (v VPNServerConfigurationPolicyGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNServerConfigurationPolicyGroup.

func (*VPNServerConfigurationPolicyGroup) UnmarshalJSON

func (v *VPNServerConfigurationPolicyGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNServerConfigurationPolicyGroup.

type VPNServerConfigurationPolicyGroupMember

type VPNServerConfigurationPolicyGroupMember struct {
	// The Vpn Policy member attribute type.
	AttributeType *VPNPolicyMemberAttributeType `json:"attributeType,omitempty"`

	// The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.
	AttributeValue *string `json:"attributeValue,omitempty"`

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

VPNServerConfigurationPolicyGroupMember - VpnServerConfiguration PolicyGroup member

func (VPNServerConfigurationPolicyGroupMember) MarshalJSON

func (v VPNServerConfigurationPolicyGroupMember) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNServerConfigurationPolicyGroupMember.

func (*VPNServerConfigurationPolicyGroupMember) UnmarshalJSON

func (v *VPNServerConfigurationPolicyGroupMember) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNServerConfigurationPolicyGroupMember.

type VPNServerConfigurationPolicyGroupProperties

type VPNServerConfigurationPolicyGroupProperties struct {
	// Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
	IsDefault *bool `json:"isDefault,omitempty"`

	// Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
	PolicyMembers []*VPNServerConfigurationPolicyGroupMember `json:"policyMembers,omitempty"`

	// Priority for VpnServerConfigurationPolicyGroup.
	Priority *int32 `json:"priority,omitempty"`

	// READ-ONLY; List of references to P2SConnectionConfigurations.
	P2SConnectionConfigurations []*SubResource `json:"p2SConnectionConfigurations,omitempty" azure:"ro"`

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

VPNServerConfigurationPolicyGroupProperties - Parameters for VpnServerConfigurationPolicyGroup.

func (VPNServerConfigurationPolicyGroupProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VPNServerConfigurationPolicyGroupProperties.

func (*VPNServerConfigurationPolicyGroupProperties) UnmarshalJSON

func (v *VPNServerConfigurationPolicyGroupProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNServerConfigurationPolicyGroupProperties.

type VPNServerConfigurationProperties

type VPNServerConfigurationProperties struct {
	// The set of aad vpn authentication parameters.
	AADAuthenticationParameters *AADAuthenticationParameters `json:"aadAuthenticationParameters,omitempty"`

	// List of all VpnServerConfigurationPolicyGroups.
	ConfigurationPolicyGroups []*VPNServerConfigurationPolicyGroup `json:"configurationPolicyGroups,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.

func (*VPNServerConfigurationProperties) UnmarshalJSON

func (v *VPNServerConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

BeginList - Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/GetVirtualWanVpnServerConfigurations.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNServerConfigurationsAssociatedWithVirtualWanClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginList(ctx, "rg1", "wan1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

type VPNServerConfigurationsAssociatedWithVirtualWanClientBeginListOptions

type VPNServerConfigurationsAssociatedWithVirtualWanClientBeginListOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNServerConfigurationsAssociatedWithVirtualWanClientBeginListOptions contains the optional parameters for the VPNServerConfigurationsAssociatedWithVirtualWanClient.BeginList method.

type VPNServerConfigurationsAssociatedWithVirtualWanClientListResponse

type VPNServerConfigurationsAssociatedWithVirtualWanClientListResponse struct {
	VPNServerConfigurationsResponse
}

VPNServerConfigurationsAssociatedWithVirtualWanClientListResponse contains the response 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, error)

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) (*runtime.Poller[VPNServerConfigurationsClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnServerConfigurationPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNServerConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "vpnServerConfiguration1", armnetwork.VPNServerConfiguration{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.VPNServerConfigurationProperties{
		ConfigurationPolicyGroups: []*armnetwork.VPNServerConfigurationPolicyGroup{
			{
				ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1"),
				Name: to.Ptr("policyGroup1"),
				Properties: &armnetwork.VPNServerConfigurationPolicyGroupProperties{
					IsDefault: to.Ptr(true),
					PolicyMembers: []*armnetwork.VPNServerConfigurationPolicyGroupMember{
						{
							Name:           to.Ptr("policy1"),
							AttributeType:  to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeRadiusAzureGroupID),
							AttributeValue: to.Ptr("6ad1bd08"),
						}},
					Priority: to.Ptr[int32](0),
				},
			},
			{
				ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2"),
				Name: to.Ptr("policyGroup2"),
				Properties: &armnetwork.VPNServerConfigurationPolicyGroupProperties{
					IsDefault: to.Ptr(true),
					PolicyMembers: []*armnetwork.VPNServerConfigurationPolicyGroupMember{
						{
							Name:           to.Ptr("policy2"),
							AttributeType:  to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeCertificateGroupID),
							AttributeValue: to.Ptr("red.com"),
						}},
					Priority: to.Ptr[int32](0),
				},
			}},
		RadiusClientRootCertificates: []*armnetwork.VPNServerConfigRadiusClientRootCertificate{
			{
				Name:       to.Ptr("vpnServerConfigRadiusClientRootCert1"),
				Thumbprint: to.Ptr("83FFBFC8848B5A5836C94D0112367E16148A286F"),
			}},
		RadiusServerRootCertificates: []*armnetwork.VPNServerConfigRadiusServerRootCertificate{
			{
				Name:           to.Ptr("vpnServerConfigRadiusServerRootCer1"),
				PublicCertData: to.Ptr("MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM"),
			}},
		RadiusServers: []*armnetwork.RadiusServer{
			{
				RadiusServerAddress: to.Ptr("10.0.0.0"),
				RadiusServerScore:   to.Ptr[int64](25),
				RadiusServerSecret:  to.Ptr("radiusServerSecret"),
			}},
		VPNClientIPSecPolicies: []*armnetwork.IPSecPolicy{
			{
				DhGroup:             to.Ptr(armnetwork.DhGroupDHGroup14),
				IkeEncryption:       to.Ptr(armnetwork.IkeEncryptionAES256),
				IkeIntegrity:        to.Ptr(armnetwork.IkeIntegritySHA384),
				IPSecEncryption:     to.Ptr(armnetwork.IPSecEncryptionAES256),
				IPSecIntegrity:      to.Ptr(armnetwork.IPSecIntegritySHA256),
				PfsGroup:            to.Ptr(armnetwork.PfsGroupPFS14),
				SaDataSizeKilobytes: to.Ptr[int32](429497),
				SaLifeTimeSeconds:   to.Ptr[int32](86472),
			}},
		VPNClientRevokedCertificates: []*armnetwork.VPNServerConfigVPNClientRevokedCertificate{
			{
				Name:       to.Ptr("vpnServerConfigVpnClientRevokedCert1"),
				Thumbprint: to.Ptr("83FFBFC8848B5A5836C94D0112367E16148A286F"),
			}},
		VPNClientRootCertificates: []*armnetwork.VPNServerConfigVPNClientRootCertificate{
			{
				Name:           to.Ptr("vpnServerConfigVpnClientRootCert1"),
				PublicCertData: to.Ptr("MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN"),
			}},
		VPNProtocols: []*armnetwork.VPNGatewayTunnelingProtocol{
			to.Ptr(armnetwork.VPNGatewayTunnelingProtocolIkeV2)},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNServerConfigurationsClient) BeginDelete

BeginDelete - Deletes a VpnServerConfiguration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnServerConfigurationDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNServerConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "vpnServerConfiguration1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnServerConfigurationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNServerConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "vpnServerConfiguration1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNServerConfigurationsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all the vpnServerConfigurations in a resource group. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the VpnServerConfiguration. options - VPNServerConfigurationsClientListByResourceGroupOptions contains the optional parameters for the VPNServerConfigurationsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnServerConfigurationListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNServerConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VPNServerConfigurationsClient) NewListPager

NewListPager - Lists all the VpnServerConfigurations in a subscription. Generated from API version 2022-05-01 options - VPNServerConfigurationsClientListOptions contains the optional parameters for the VPNServerConfigurationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnServerConfigurationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNServerConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnServerConfigurationUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNServerConfigurationsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "vpnServerConfiguration1", armnetwork.TagsObject{
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
		"key2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VPNServerConfigurationsClientBeginCreateOrUpdateOptions

type VPNServerConfigurationsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNServerConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNServerConfigurationsClient.BeginCreateOrUpdate method.

type VPNServerConfigurationsClientBeginDeleteOptions

type VPNServerConfigurationsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNServerConfigurationsClientBeginDeleteOptions contains the optional parameters for the VPNServerConfigurationsClient.BeginDelete method.

type VPNServerConfigurationsClientCreateOrUpdateResponse

type VPNServerConfigurationsClientCreateOrUpdateResponse struct {
	VPNServerConfiguration
}

VPNServerConfigurationsClientCreateOrUpdateResponse contains the response from method VPNServerConfigurationsClient.CreateOrUpdate.

type VPNServerConfigurationsClientDeleteResponse

type VPNServerConfigurationsClientDeleteResponse struct {
}

VPNServerConfigurationsClientDeleteResponse contains the response from method VPNServerConfigurationsClient.Delete.

type VPNServerConfigurationsClientGetOptions

type VPNServerConfigurationsClientGetOptions struct {
}

VPNServerConfigurationsClientGetOptions contains the optional parameters for the VPNServerConfigurationsClient.Get method.

type VPNServerConfigurationsClientGetResponse

type VPNServerConfigurationsClientGetResponse struct {
	VPNServerConfiguration
}

VPNServerConfigurationsClientGetResponse contains the response from method VPNServerConfigurationsClient.Get.

type VPNServerConfigurationsClientListByResourceGroupOptions

type VPNServerConfigurationsClientListByResourceGroupOptions struct {
}

VPNServerConfigurationsClientListByResourceGroupOptions contains the optional parameters for the VPNServerConfigurationsClient.ListByResourceGroup method.

type VPNServerConfigurationsClientListByResourceGroupResponse

type VPNServerConfigurationsClientListByResourceGroupResponse struct {
	ListVPNServerConfigurationsResult
}

VPNServerConfigurationsClientListByResourceGroupResponse contains the response from method VPNServerConfigurationsClient.ListByResourceGroup.

type VPNServerConfigurationsClientListOptions

type VPNServerConfigurationsClientListOptions struct {
}

VPNServerConfigurationsClientListOptions contains the optional parameters for the VPNServerConfigurationsClient.List method.

type VPNServerConfigurationsClientListResponse

type VPNServerConfigurationsClientListResponse struct {
	ListVPNServerConfigurationsResult
}

VPNServerConfigurationsClientListResponse contains the response from method VPNServerConfigurationsClient.List.

type VPNServerConfigurationsClientUpdateTagsOptions

type VPNServerConfigurationsClientUpdateTagsOptions struct {
}

VPNServerConfigurationsClientUpdateTagsOptions contains the optional parameters for the VPNServerConfigurationsClient.UpdateTags method.

type VPNServerConfigurationsClientUpdateTagsResponse

type VPNServerConfigurationsClientUpdateTagsResponse struct {
	VPNServerConfiguration
}

VPNServerConfigurationsClientUpdateTagsResponse contains the response 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.

func (*VPNServerConfigurationsResponse) UnmarshalJSON

func (v *VPNServerConfigurationsResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VPNSite) UnmarshalJSON

func (v *VPNSite) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VPNSiteID) MarshalJSON

func (v VPNSiteID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNSiteID.

func (*VPNSiteID) UnmarshalJSON

func (v *VPNSiteID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNSiteID.

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.

func (VPNSiteLink) MarshalJSON

func (v VPNSiteLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNSiteLink.

func (*VPNSiteLink) UnmarshalJSON

func (v *VPNSiteLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNSiteLink.

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.

func (VPNSiteLinkConnection) MarshalJSON

func (v VPNSiteLinkConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNSiteLinkConnection.

func (*VPNSiteLinkConnection) UnmarshalJSON

func (v *VPNSiteLinkConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNSiteLinkConnection.

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

	// vpnGatewayCustomBgpAddresses used by this connection.
	VPNGatewayCustomBgpAddresses []*GatewayCustomBgpIPAddressIPConfiguration `json:"vpnGatewayCustomBgpAddresses,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.

func (*VPNSiteLinkConnectionProperties) UnmarshalJSON

func (v *VPNSiteLinkConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteLinkConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNSiteLinkConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "gateway1", "vpnConnection1", "Connection-Link1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VPNSiteLinkConnectionsClientGetOptions

type VPNSiteLinkConnectionsClientGetOptions struct {
}

VPNSiteLinkConnectionsClientGetOptions contains the optional parameters for the VPNSiteLinkConnectionsClient.Get method.

type VPNSiteLinkConnectionsClientGetResponse

type VPNSiteLinkConnectionsClientGetResponse struct {
	VPNSiteLinkConnection
}

VPNSiteLinkConnectionsClientGetResponse contains the response 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.

func (VPNSiteLinkProperties) MarshalJSON

func (v VPNSiteLinkProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNSiteLinkProperties.

func (*VPNSiteLinkProperties) UnmarshalJSON

func (v *VPNSiteLinkProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNSiteLinkProperties.

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, error)

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteLinkGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNSiteLinksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "vpnSite1", "vpnSiteLink1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNSiteLinksClient) NewListByVPNSitePager

func (client *VPNSiteLinksClient) NewListByVPNSitePager(resourceGroupName string, vpnSiteName string, options *VPNSiteLinksClientListByVPNSiteOptions) *runtime.Pager[VPNSiteLinksClientListByVPNSiteResponse]

NewListByVPNSitePager - Lists all the vpnSiteLinks in a resource group for a vpn site. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteLinkListByVpnSite.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNSiteLinksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByVPNSitePager("rg1", "vpnSite1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VPNSiteLinksClientGetOptions

type VPNSiteLinksClientGetOptions struct {
}

VPNSiteLinksClientGetOptions contains the optional parameters for the VPNSiteLinksClient.Get method.

type VPNSiteLinksClientGetResponse

type VPNSiteLinksClientGetResponse struct {
	VPNSiteLink
}

VPNSiteLinksClientGetResponse contains the response from method VPNSiteLinksClient.Get.

type VPNSiteLinksClientListByVPNSiteOptions

type VPNSiteLinksClientListByVPNSiteOptions struct {
}

VPNSiteLinksClientListByVPNSiteOptions contains the optional parameters for the VPNSiteLinksClient.ListByVPNSite method.

type VPNSiteLinksClientListByVPNSiteResponse

type VPNSiteLinksClientListByVPNSiteResponse struct {
	ListVPNSiteLinksResult
}

VPNSiteLinksClientListByVPNSiteResponse contains the response 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.

func (*VPNSiteProperties) UnmarshalJSON

func (v *VPNSiteProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[VPNSitesClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSitePut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNSitesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "vpnSite1", armnetwork.VPNSite{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.VPNSiteProperties{
		AddressSpace: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("10.0.0.0/16")},
		},
		IsSecuritySite: to.Ptr(false),
		O365Policy: &armnetwork.O365PolicyProperties{
			BreakOutCategories: &armnetwork.O365BreakOutCategoryPolicies{
				Default:  to.Ptr(false),
				Allow:    to.Ptr(true),
				Optimize: to.Ptr(true),
			},
		},
		VirtualWan: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"),
		},
		VPNSiteLinks: []*armnetwork.VPNSiteLink{
			{
				Name: to.Ptr("vpnSiteLink1"),
				Properties: &armnetwork.VPNSiteLinkProperties{
					BgpProperties: &armnetwork.VPNLinkBgpSettings{
						Asn:               to.Ptr[int64](1234),
						BgpPeeringAddress: to.Ptr("192.168.0.0"),
					},
					Fqdn:      to.Ptr("link1.vpnsite1.contoso.com"),
					IPAddress: to.Ptr("50.50.50.56"),
					LinkProperties: &armnetwork.VPNLinkProviderProperties{
						LinkProviderName: to.Ptr("vendor1"),
						LinkSpeedInMbps:  to.Ptr[int32](0),
					},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNSitesClient) BeginDelete

func (client *VPNSitesClient) BeginDelete(ctx context.Context, resourceGroupName string, vpnSiteName string, options *VPNSitesClientBeginDeleteOptions) (*runtime.Poller[VPNSitesClientDeleteResponse], error)

BeginDelete - Deletes a VpnSite. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNSitesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "vpnSite1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNSitesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "vpnSite1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VPNSitesClient) NewListByResourceGroupPager

func (client *VPNSitesClient) NewListByResourceGroupPager(resourceGroupName string, options *VPNSitesClientListByResourceGroupOptions) *runtime.Pager[VPNSitesClientListByResourceGroupResponse]

NewListByResourceGroupPager - Lists all the vpnSites in a resource group. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the VpnSite. options - VPNSitesClientListByResourceGroupOptions contains the optional parameters for the VPNSitesClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNSitesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VPNSitesClient) NewListPager

NewListPager - Lists all the VpnSites in a subscription. Generated from API version 2022-05-01 options - VPNSitesClientListOptions contains the optional parameters for the VPNSitesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNSitesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSiteUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNSitesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "vpnSite1", armnetwork.TagsObject{
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
		"key2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VPNSitesClientBeginCreateOrUpdateOptions

type VPNSitesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNSitesClientBeginCreateOrUpdateOptions contains the optional parameters for the VPNSitesClient.BeginCreateOrUpdate method.

type VPNSitesClientBeginDeleteOptions

type VPNSitesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNSitesClientBeginDeleteOptions contains the optional parameters for the VPNSitesClient.BeginDelete method.

type VPNSitesClientCreateOrUpdateResponse

type VPNSitesClientCreateOrUpdateResponse struct {
	VPNSite
}

VPNSitesClientCreateOrUpdateResponse contains the response from method VPNSitesClient.CreateOrUpdate.

type VPNSitesClientDeleteResponse

type VPNSitesClientDeleteResponse struct {
}

VPNSitesClientDeleteResponse contains the response from method VPNSitesClient.Delete.

type VPNSitesClientGetOptions

type VPNSitesClientGetOptions struct {
}

VPNSitesClientGetOptions contains the optional parameters for the VPNSitesClient.Get method.

type VPNSitesClientGetResponse

type VPNSitesClientGetResponse struct {
	VPNSite
}

VPNSitesClientGetResponse contains the response from method VPNSitesClient.Get.

type VPNSitesClientListByResourceGroupOptions

type VPNSitesClientListByResourceGroupOptions struct {
}

VPNSitesClientListByResourceGroupOptions contains the optional parameters for the VPNSitesClient.ListByResourceGroup method.

type VPNSitesClientListByResourceGroupResponse

type VPNSitesClientListByResourceGroupResponse struct {
	ListVPNSitesResult
}

VPNSitesClientListByResourceGroupResponse contains the response from method VPNSitesClient.ListByResourceGroup.

type VPNSitesClientListOptions

type VPNSitesClientListOptions struct {
}

VPNSitesClientListOptions contains the optional parameters for the VPNSitesClient.List method.

type VPNSitesClientListResponse

type VPNSitesClientListResponse struct {
	ListVPNSitesResult
}

VPNSitesClientListResponse contains the response from method VPNSitesClient.List.

type VPNSitesClientUpdateTagsOptions

type VPNSitesClientUpdateTagsOptions struct {
}

VPNSitesClientUpdateTagsOptions contains the optional parameters for the VPNSitesClient.UpdateTags method.

type VPNSitesClientUpdateTagsResponse

type VPNSitesClientUpdateTagsResponse struct {
	VPNSite
}

VPNSitesClientUpdateTagsResponse contains the response 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, error)

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

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VpnSitesConfigurationDownload.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVPNSitesConfigurationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDownload(ctx, "rg1", "wan1", armnetwork.GetVPNSitesConfigurationRequest{
	OutputBlobSasURL: to.Ptr("https://blobcortextesturl.blob.core.windows.net/folderforconfig/vpnFile?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b"),
	VPNSites: []*string{
		to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/abc")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

type VPNSitesConfigurationClientBeginDownloadOptions

type VPNSitesConfigurationClientBeginDownloadOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VPNSitesConfigurationClientBeginDownloadOptions contains the optional parameters for the VPNSitesConfigurationClient.BeginDownload method.

type VPNSitesConfigurationClientDownloadResponse

type VPNSitesConfigurationClientDownloadResponse struct {
}

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.

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.

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.

func (VerificationIPFlowParameters) MarshalJSON

func (v VerificationIPFlowParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VerificationIPFlowParameters.

func (*VerificationIPFlowParameters) UnmarshalJSON

func (v *VerificationIPFlowParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VerificationIPFlowParameters.

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.

func (VerificationIPFlowResult) MarshalJSON

func (v VerificationIPFlowResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VerificationIPFlowResult.

func (*VerificationIPFlowResult) UnmarshalJSON

func (v *VerificationIPFlowResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VerificationIPFlowResult.

type VipSwapClient

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

VipSwapClient contains the methods for the VipSwap group. Don't use this type directly, use NewVipSwapClient() instead.

func NewVipSwapClient

func NewVipSwapClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VipSwapClient, error)

NewVipSwapClient creates a new instance of VipSwapClient 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 (*VipSwapClient) BeginCreate

func (client *VipSwapClient) BeginCreate(ctx context.Context, groupName string, resourceName string, parameters SwapResource, options *VipSwapClientBeginCreateOptions) (*runtime.Poller[VipSwapClientCreateResponse], error)

BeginCreate - Performs vip swap operation on swappable cloud services. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 groupName - The name of the resource group. resourceName - The name of the cloud service. parameters - SwapResource object where slot type should be the target slot after vip swap for the specified cloud service. options - VipSwapClientBeginCreateOptions contains the optional parameters for the VipSwapClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CloudServiceSwapPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVipSwapClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreate(ctx, "rg1", "testCloudService", armnetwork.SwapResource{
	Properties: &armnetwork.SwapResourceProperties{
		SlotType: to.Ptr(armnetwork.SlotTypeProduction),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VipSwapClient) Get

func (client *VipSwapClient) Get(ctx context.Context, groupName string, resourceName string, options *VipSwapClientGetOptions) (VipSwapClientGetResponse, error)

Get - Gets the SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 groupName - The name of the resource group. resourceName - The name of the cloud service. options - VipSwapClientGetOptions contains the optional parameters for the VipSwapClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CloudServiceSwapGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVipSwapClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testCloudService", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VipSwapClient) List

func (client *VipSwapClient) List(ctx context.Context, groupName string, resourceName string, options *VipSwapClientListOptions) (VipSwapClientListResponse, error)

List - Gets the list of SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 groupName - The name of the resource group. resourceName - The name of the cloud service. options - VipSwapClientListOptions contains the optional parameters for the VipSwapClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/CloudServiceSwapList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVipSwapClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.List(ctx, "rg1", "testCloudService", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VipSwapClientBeginCreateOptions

type VipSwapClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VipSwapClientBeginCreateOptions contains the optional parameters for the VipSwapClient.BeginCreate method.

type VipSwapClientCreateResponse

type VipSwapClientCreateResponse struct {
}

VipSwapClientCreateResponse contains the response from method VipSwapClient.Create.

type VipSwapClientGetOptions

type VipSwapClientGetOptions struct {
}

VipSwapClientGetOptions contains the optional parameters for the VipSwapClient.Get method.

type VipSwapClientGetResponse

type VipSwapClientGetResponse struct {
	SwapResource
}

VipSwapClientGetResponse contains the response from method VipSwapClient.Get.

type VipSwapClientListOptions

type VipSwapClientListOptions struct {
}

VipSwapClientListOptions contains the optional parameters for the VipSwapClient.List method.

type VipSwapClientListResponse

type VipSwapClientListResponse struct {
	SwapResourceListResult
}

VipSwapClientListResponse contains the response from method VipSwapClient.List.

type VirtualAppliance

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

func (v VirtualAppliance) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualAppliance.

func (*VirtualAppliance) UnmarshalJSON

func (v *VirtualAppliance) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualAppliance.

type VirtualApplianceListResult

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

func (v VirtualApplianceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceListResult.

func (*VirtualApplianceListResult) UnmarshalJSON

func (v *VirtualApplianceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualApplianceNicProperties) MarshalJSON

func (v VirtualApplianceNicProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceNicProperties.

func (*VirtualApplianceNicProperties) UnmarshalJSON

func (v *VirtualApplianceNicProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualApplianceNicProperties.

type VirtualAppliancePropertiesFormat

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

func (v VirtualAppliancePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualAppliancePropertiesFormat.

func (*VirtualAppliancePropertiesFormat) UnmarshalJSON

func (v *VirtualAppliancePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualAppliancePropertiesFormat.

type VirtualApplianceSKU

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

func (v VirtualApplianceSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSKU.

func (*VirtualApplianceSKU) UnmarshalJSON

func (v *VirtualApplianceSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualApplianceSKU.

type VirtualApplianceSKUInstances

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.

func (VirtualApplianceSKUInstances) MarshalJSON

func (v VirtualApplianceSKUInstances) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSKUInstances.

func (*VirtualApplianceSKUInstances) UnmarshalJSON

func (v *VirtualApplianceSKUInstances) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualApplianceSKUInstances.

type VirtualApplianceSKUListResult

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

func (v VirtualApplianceSKUListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSKUListResult.

func (*VirtualApplianceSKUListResult) UnmarshalJSON

func (v *VirtualApplianceSKUListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualApplianceSKUProperties) MarshalJSON

func (v VirtualApplianceSKUProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSKUProperties.

func (*VirtualApplianceSKUProperties) UnmarshalJSON

func (v *VirtualApplianceSKUProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualApplianceSKUProperties.

type VirtualApplianceSKUPropertiesFormat

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

func (v VirtualApplianceSKUPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSKUPropertiesFormat.

func (*VirtualApplianceSKUPropertiesFormat) UnmarshalJSON

func (v *VirtualApplianceSKUPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

Get - Retrieves a single available sku for network virtual appliance. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 skuName - Name of the Sku. options - VirtualApplianceSKUsClientGetOptions contains the optional parameters for the VirtualApplianceSKUsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceSkuGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualApplianceSKUsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "ciscoSdwan", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualApplianceSKUsClient) NewListPager

NewListPager - List all SKUs available for a virtual appliance. Generated from API version 2022-05-01 options - VirtualApplianceSKUsClientListOptions contains the optional parameters for the VirtualApplianceSKUsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceSkuList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualApplianceSKUsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VirtualApplianceSKUsClientGetOptions

type VirtualApplianceSKUsClientGetOptions struct {
}

VirtualApplianceSKUsClientGetOptions contains the optional parameters for the VirtualApplianceSKUsClient.Get method.

type VirtualApplianceSKUsClientGetResponse

type VirtualApplianceSKUsClientGetResponse struct {
	VirtualApplianceSKU
}

VirtualApplianceSKUsClientGetResponse contains the response from method VirtualApplianceSKUsClient.Get.

type VirtualApplianceSKUsClientListOptions

type VirtualApplianceSKUsClientListOptions struct {
}

VirtualApplianceSKUsClientListOptions contains the optional parameters for the VirtualApplianceSKUsClient.List method.

type VirtualApplianceSKUsClientListResponse

type VirtualApplianceSKUsClientListResponse struct {
	VirtualApplianceSKUListResult
}

VirtualApplianceSKUsClientListResponse contains the response 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.

func (VirtualApplianceSite) MarshalJSON

func (v VirtualApplianceSite) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSite.

func (*VirtualApplianceSite) UnmarshalJSON

func (v *VirtualApplianceSite) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualApplianceSite.

type VirtualApplianceSiteListResult

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

func (v VirtualApplianceSiteListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSiteListResult.

func (*VirtualApplianceSiteListResult) UnmarshalJSON

func (v *VirtualApplianceSiteListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualApplianceSiteProperties) MarshalJSON

func (v VirtualApplianceSiteProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualApplianceSiteProperties.

func (*VirtualApplianceSiteProperties) UnmarshalJSON

func (v *VirtualApplianceSiteProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualApplianceSiteProperties.

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, error)

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) (*runtime.Poller[VirtualApplianceSitesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates the specified Network Virtual Appliance Site. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceSitePut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualApplianceSitesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "nva", "site1", armnetwork.VirtualApplianceSite{
	Properties: &armnetwork.VirtualApplianceSiteProperties{
		AddressPrefix: to.Ptr("192.168.1.0/24"),
		O365Policy: &armnetwork.Office365PolicyProperties{
			BreakOutCategories: &armnetwork.BreakOutCategoryPolicies{
				Default:  to.Ptr(true),
				Allow:    to.Ptr(true),
				Optimize: to.Ptr(true),
			},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualApplianceSitesClient) BeginDelete

func (client *VirtualApplianceSitesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, siteName string, options *VirtualApplianceSitesClientBeginDeleteOptions) (*runtime.Poller[VirtualApplianceSitesClientDeleteResponse], error)

BeginDelete - Deletes the specified site from a Virtual Appliance. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceSiteDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualApplianceSitesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "nva", "site1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceSiteGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualApplianceSitesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "nva", "site1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualApplianceSitesClient) NewListPager

func (client *VirtualApplianceSitesClient) NewListPager(resourceGroupName string, networkVirtualApplianceName string, options *VirtualApplianceSitesClientListOptions) *runtime.Pager[VirtualApplianceSitesClientListResponse]

NewListPager - Lists all Network Virtual Appliance Sites in a Network Virtual Appliance resource. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceSiteList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualApplianceSitesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "nva", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VirtualApplianceSitesClientBeginCreateOrUpdateOptions

type VirtualApplianceSitesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualApplianceSitesClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualApplianceSitesClient.BeginCreateOrUpdate method.

type VirtualApplianceSitesClientBeginDeleteOptions

type VirtualApplianceSitesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualApplianceSitesClientBeginDeleteOptions contains the optional parameters for the VirtualApplianceSitesClient.BeginDelete method.

type VirtualApplianceSitesClientCreateOrUpdateResponse

type VirtualApplianceSitesClientCreateOrUpdateResponse struct {
	VirtualApplianceSite
}

VirtualApplianceSitesClientCreateOrUpdateResponse contains the response from method VirtualApplianceSitesClient.CreateOrUpdate.

type VirtualApplianceSitesClientDeleteResponse

type VirtualApplianceSitesClientDeleteResponse struct {
}

VirtualApplianceSitesClientDeleteResponse contains the response from method VirtualApplianceSitesClient.Delete.

type VirtualApplianceSitesClientGetOptions

type VirtualApplianceSitesClientGetOptions struct {
}

VirtualApplianceSitesClientGetOptions contains the optional parameters for the VirtualApplianceSitesClient.Get method.

type VirtualApplianceSitesClientGetResponse

type VirtualApplianceSitesClientGetResponse struct {
	VirtualApplianceSite
}

VirtualApplianceSitesClientGetResponse contains the response from method VirtualApplianceSitesClient.Get.

type VirtualApplianceSitesClientListOptions

type VirtualApplianceSitesClientListOptions struct {
}

VirtualApplianceSitesClientListOptions contains the optional parameters for the VirtualApplianceSitesClient.List method.

type VirtualApplianceSitesClientListResponse

type VirtualApplianceSitesClientListResponse struct {
	VirtualApplianceSiteListResult
}

VirtualApplianceSitesClientListResponse contains the response from method VirtualApplianceSitesClient.List.

type VirtualAppliancesClient

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

func NewVirtualAppliancesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VirtualAppliancesClient, error)

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

func (client *VirtualAppliancesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, parameters VirtualAppliance, options *VirtualAppliancesClientBeginCreateOrUpdateOptions) (*runtime.Poller[VirtualAppliancesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates the specified Network Virtual Appliance. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualAppliancePut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualAppliancesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "nva", armnetwork.VirtualAppliance{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Identity: &armnetwork.ManagedServiceIdentity{
		Type: to.Ptr(armnetwork.ResourceIdentityTypeUserAssigned),
		UserAssignedIdentities: map[string]*armnetwork.Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties{
			"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {},
		},
	},
	Properties: &armnetwork.VirtualAppliancePropertiesFormat{
		BootStrapConfigurationBlobs: []*string{
			to.Ptr("https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig")},
		CloudInitConfigurationBlobs: []*string{
			to.Ptr("https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig")},
		NvaSKU: &armnetwork.VirtualApplianceSKUProperties{
			BundledScaleUnit:   to.Ptr("1"),
			MarketPlaceVersion: to.Ptr("12.1"),
			Vendor:             to.Ptr("Cisco SDWAN"),
		},
		VirtualApplianceAsn: to.Ptr[int64](10000),
		VirtualHub: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualAppliancesClient) BeginDelete

func (client *VirtualAppliancesClient) BeginDelete(ctx context.Context, resourceGroupName string, networkVirtualApplianceName string, options *VirtualAppliancesClientBeginDeleteOptions) (*runtime.Poller[VirtualAppliancesClientDeleteResponse], error)

BeginDelete - Deletes the specified Network Virtual Appliance. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualAppliancesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "nva", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualAppliancesClient) Get

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualAppliancesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "nva", &armnetwork.VirtualAppliancesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualAppliancesClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all Network Virtual Appliances in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - VirtualAppliancesClientListByResourceGroupOptions contains the optional parameters for the VirtualAppliancesClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualAppliancesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualAppliancesClient) NewListPager

NewListPager - Gets all Network Virtual Appliances in a subscription. Generated from API version 2022-05-01 options - VirtualAppliancesClientListOptions contains the optional parameters for the VirtualAppliancesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualAppliancesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualAppliancesClient) UpdateTags

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkVirtualApplianceUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualAppliancesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "nva", armnetwork.TagsObject{
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
		"key2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VirtualAppliancesClientBeginCreateOrUpdateOptions

type VirtualAppliancesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualAppliancesClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualAppliancesClient.BeginCreateOrUpdate method.

type VirtualAppliancesClientBeginDeleteOptions

type VirtualAppliancesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualAppliancesClientBeginDeleteOptions contains the optional parameters for the VirtualAppliancesClient.BeginDelete method.

type VirtualAppliancesClientCreateOrUpdateResponse

type VirtualAppliancesClientCreateOrUpdateResponse struct {
	VirtualAppliance
}

VirtualAppliancesClientCreateOrUpdateResponse contains the response from method VirtualAppliancesClient.CreateOrUpdate.

type VirtualAppliancesClientDeleteResponse

type VirtualAppliancesClientDeleteResponse struct {
}

VirtualAppliancesClientDeleteResponse contains the response from method VirtualAppliancesClient.Delete.

type VirtualAppliancesClientGetOptions

type VirtualAppliancesClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

VirtualAppliancesClientGetOptions contains the optional parameters for the VirtualAppliancesClient.Get method.

type VirtualAppliancesClientGetResponse

type VirtualAppliancesClientGetResponse struct {
	VirtualAppliance
}

VirtualAppliancesClientGetResponse contains the response from method VirtualAppliancesClient.Get.

type VirtualAppliancesClientListByResourceGroupOptions

type VirtualAppliancesClientListByResourceGroupOptions struct {
}

VirtualAppliancesClientListByResourceGroupOptions contains the optional parameters for the VirtualAppliancesClient.ListByResourceGroup method.

type VirtualAppliancesClientListByResourceGroupResponse

type VirtualAppliancesClientListByResourceGroupResponse struct {
	VirtualApplianceListResult
}

VirtualAppliancesClientListByResourceGroupResponse contains the response from method VirtualAppliancesClient.ListByResourceGroup.

type VirtualAppliancesClientListOptions

type VirtualAppliancesClientListOptions struct {
}

VirtualAppliancesClientListOptions contains the optional parameters for the VirtualAppliancesClient.List method.

type VirtualAppliancesClientListResponse

type VirtualAppliancesClientListResponse struct {
	VirtualApplianceListResult
}

VirtualAppliancesClientListResponse contains the response from method VirtualAppliancesClient.List.

type VirtualAppliancesClientUpdateTagsOptions

type VirtualAppliancesClientUpdateTagsOptions struct {
}

VirtualAppliancesClientUpdateTagsOptions contains the optional parameters for the VirtualAppliancesClient.UpdateTags method.

type VirtualAppliancesClientUpdateTagsResponse

type VirtualAppliancesClientUpdateTagsResponse struct {
	VirtualAppliance
}

VirtualAppliancesClientUpdateTagsResponse contains the response 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.

func (*VirtualHub) UnmarshalJSON

func (v *VirtualHub) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubBgpConnectionPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubBgpConnectionClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "hub1", "conn1", armnetwork.BgpConnection{
	Properties: &armnetwork.BgpConnectionProperties{
		HubVirtualNetworkConnection: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1"),
		},
		PeerAsn: to.Ptr[int64](20000),
		PeerIP:  to.Ptr("192.168.1.5"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualHubBgpConnectionClient) BeginDelete

BeginDelete - Deletes a VirtualHubBgpConnection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubBgpConnectionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubBgpConnectionClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "hub1", "conn1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubBgpConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubBgpConnectionClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "hub1", "conn1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VirtualHubBgpConnectionClientBeginCreateOrUpdateOptions

type VirtualHubBgpConnectionClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubBgpConnectionClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubBgpConnectionClient.BeginCreateOrUpdate method.

type VirtualHubBgpConnectionClientBeginDeleteOptions

type VirtualHubBgpConnectionClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubBgpConnectionClientBeginDeleteOptions contains the optional parameters for the VirtualHubBgpConnectionClient.BeginDelete method.

type VirtualHubBgpConnectionClientCreateOrUpdateResponse

type VirtualHubBgpConnectionClientCreateOrUpdateResponse struct {
	BgpConnection
}

VirtualHubBgpConnectionClientCreateOrUpdateResponse contains the response from method VirtualHubBgpConnectionClient.CreateOrUpdate.

type VirtualHubBgpConnectionClientDeleteResponse

type VirtualHubBgpConnectionClientDeleteResponse struct {
}

VirtualHubBgpConnectionClientDeleteResponse contains the response from method VirtualHubBgpConnectionClient.Delete.

type VirtualHubBgpConnectionClientGetOptions

type VirtualHubBgpConnectionClientGetOptions struct {
}

VirtualHubBgpConnectionClientGetOptions contains the optional parameters for the VirtualHubBgpConnectionClient.Get method.

type VirtualHubBgpConnectionClientGetResponse

type VirtualHubBgpConnectionClientGetResponse struct {
	BgpConnection
}

VirtualHubBgpConnectionClientGetResponse contains the response 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, error)

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

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterPeerListAdvertisedRoute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubBgpConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListAdvertisedRoutes(ctx, "rg1", "virtualRouter1", "peer1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualHubBgpConnectionsClient) BeginListLearnedRoutes

BeginListLearnedRoutes - Retrieves a list of routes the virtual hub bgp connection has learned. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterPeerListLearnedRoute.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubBgpConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListLearnedRoutes(ctx, "rg1", "virtualRouter1", "peer1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualHubBgpConnectionsClient) NewListPager

NewListPager - Retrieves the details of all VirtualHubBgpConnections. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubBgpConnectionList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubBgpConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "hub1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VirtualHubBgpConnectionsClientBeginListAdvertisedRoutesOptions

type VirtualHubBgpConnectionsClientBeginListAdvertisedRoutesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubBgpConnectionsClientBeginListAdvertisedRoutesOptions contains the optional parameters for the VirtualHubBgpConnectionsClient.BeginListAdvertisedRoutes method.

type VirtualHubBgpConnectionsClientBeginListLearnedRoutesOptions

type VirtualHubBgpConnectionsClientBeginListLearnedRoutesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubBgpConnectionsClientBeginListLearnedRoutesOptions contains the optional parameters for the VirtualHubBgpConnectionsClient.BeginListLearnedRoutes method.

type VirtualHubBgpConnectionsClientListAdvertisedRoutesResponse

type VirtualHubBgpConnectionsClientListAdvertisedRoutesResponse struct {
	PeerRouteList
}

VirtualHubBgpConnectionsClientListAdvertisedRoutesResponse contains the response from method VirtualHubBgpConnectionsClient.ListAdvertisedRoutes.

type VirtualHubBgpConnectionsClientListLearnedRoutesResponse

type VirtualHubBgpConnectionsClientListLearnedRoutesResponse struct {
	PeerRouteList
}

VirtualHubBgpConnectionsClientListLearnedRoutesResponse contains the response from method VirtualHubBgpConnectionsClient.ListLearnedRoutes.

type VirtualHubBgpConnectionsClientListOptions

type VirtualHubBgpConnectionsClientListOptions struct {
}

VirtualHubBgpConnectionsClientListOptions contains the optional parameters for the VirtualHubBgpConnectionsClient.List method.

type VirtualHubBgpConnectionsClientListResponse

type VirtualHubBgpConnectionsClientListResponse struct {
	ListVirtualHubBgpConnectionResults
}

VirtualHubBgpConnectionsClientListResponse contains the response 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.

func (*VirtualHubEffectiveRoute) UnmarshalJSON

func (v *VirtualHubEffectiveRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VirtualHubEffectiveRouteList) UnmarshalJSON

func (v *VirtualHubEffectiveRouteList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualHubID) MarshalJSON

func (v VirtualHubID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualHubID.

func (*VirtualHubID) UnmarshalJSON

func (v *VirtualHubID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualHubID.

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, error)

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

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubIpConfigurationPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubIPConfigurationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "hub1", "ipconfig1", armnetwork.HubIPConfiguration{
	Properties: &armnetwork.HubIPConfigurationPropertiesFormat{
		Subnet: &armnetwork.Subnet{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualHubIPConfigurationClient) BeginDelete

BeginDelete - Deletes a VirtualHubIpConfiguration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubIpConfigurationDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubIPConfigurationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "hub1", "ipconfig1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualHubIPConfigurationClient) Get

Get - Retrieves the details of a Virtual Hub Ip configuration. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubIpConfigurationGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubIPConfigurationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "hub1", "ipconfig1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualHubIPConfigurationClient) NewListPager

NewListPager - Retrieves the details of all VirtualHubIpConfigurations. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubIpConfigurationList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubIPConfigurationClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "hub1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VirtualHubIPConfigurationClientBeginCreateOrUpdateOptions

type VirtualHubIPConfigurationClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubIPConfigurationClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubIPConfigurationClient.BeginCreateOrUpdate method.

type VirtualHubIPConfigurationClientBeginDeleteOptions

type VirtualHubIPConfigurationClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubIPConfigurationClientBeginDeleteOptions contains the optional parameters for the VirtualHubIPConfigurationClient.BeginDelete method.

type VirtualHubIPConfigurationClientCreateOrUpdateResponse

type VirtualHubIPConfigurationClientCreateOrUpdateResponse struct {
	HubIPConfiguration
}

VirtualHubIPConfigurationClientCreateOrUpdateResponse contains the response from method VirtualHubIPConfigurationClient.CreateOrUpdate.

type VirtualHubIPConfigurationClientDeleteResponse

type VirtualHubIPConfigurationClientDeleteResponse struct {
}

VirtualHubIPConfigurationClientDeleteResponse contains the response from method VirtualHubIPConfigurationClient.Delete.

type VirtualHubIPConfigurationClientGetOptions

type VirtualHubIPConfigurationClientGetOptions struct {
}

VirtualHubIPConfigurationClientGetOptions contains the optional parameters for the VirtualHubIPConfigurationClient.Get method.

type VirtualHubIPConfigurationClientGetResponse

type VirtualHubIPConfigurationClientGetResponse struct {
	HubIPConfiguration
}

VirtualHubIPConfigurationClientGetResponse contains the response from method VirtualHubIPConfigurationClient.Get.

type VirtualHubIPConfigurationClientListOptions

type VirtualHubIPConfigurationClientListOptions struct {
}

VirtualHubIPConfigurationClientListOptions contains the optional parameters for the VirtualHubIPConfigurationClient.List method.

type VirtualHubIPConfigurationClientListResponse

type VirtualHubIPConfigurationClientListResponse struct {
	ListVirtualHubIPConfigurationResults
}

VirtualHubIPConfigurationClientListResponse contains the response 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 hubRoutingPreference of this VirtualHub.
	HubRoutingPreference *HubRoutingPreference `json:"hubRoutingPreference,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"`

	// The VirtualHub Router autoscale configuration.
	VirtualRouterAutoScaleConfiguration *VirtualRouterAutoScaleConfiguration `json:"virtualRouterAutoScaleConfiguration,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; List of references to RouteMaps.
	RouteMaps []*SubResource `json:"routeMaps,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.

func (*VirtualHubProperties) UnmarshalJSON

func (v *VirtualHubProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VirtualHubRoute) UnmarshalJSON

func (v *VirtualHubRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VirtualHubRouteTable) UnmarshalJSON

func (v *VirtualHubRouteTable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualHubRouteTableV2) MarshalJSON

func (v VirtualHubRouteTableV2) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualHubRouteTableV2.

func (*VirtualHubRouteTableV2) UnmarshalJSON

func (v *VirtualHubRouteTableV2) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualHubRouteTableV2.

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.

func (*VirtualHubRouteTableV2Properties) UnmarshalJSON

func (v *VirtualHubRouteTableV2Properties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[VirtualHubRouteTableV2SClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubRouteTableV2Put.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubRouteTableV2SClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "virtualHub1", "virtualHubRouteTable1a", armnetwork.VirtualHubRouteTableV2{
	Properties: &armnetwork.VirtualHubRouteTableV2Properties{
		AttachedConnections: []*string{
			to.Ptr("All_Vnets")},
		Routes: []*armnetwork.VirtualHubRouteV2{
			{
				DestinationType: to.Ptr("CIDR"),
				Destinations: []*string{
					to.Ptr("20.10.0.0/16"),
					to.Ptr("20.20.0.0/16")},
				NextHopType: to.Ptr("IPAddress"),
				NextHops: []*string{
					to.Ptr("10.0.0.68")},
			},
			{
				DestinationType: to.Ptr("CIDR"),
				Destinations: []*string{
					to.Ptr("0.0.0.0/0")},
				NextHopType: to.Ptr("IPAddress"),
				NextHops: []*string{
					to.Ptr("10.0.0.68")},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualHubRouteTableV2SClient) BeginDelete

BeginDelete - Deletes a VirtualHubRouteTableV2. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubRouteTableV2Delete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubRouteTableV2SClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "virtualHub1", "virtualHubRouteTable1a", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubRouteTableV2Get.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubRouteTableV2SClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "virtualHub1", "virtualHubRouteTable1a", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualHubRouteTableV2SClient) NewListPager

NewListPager - Retrieves the details of all VirtualHubRouteTableV2s. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubRouteTableV2List.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubRouteTableV2SClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "virtualHub1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VirtualHubRouteTableV2SClientBeginCreateOrUpdateOptions

type VirtualHubRouteTableV2SClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubRouteTableV2SClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.BeginCreateOrUpdate method.

type VirtualHubRouteTableV2SClientBeginDeleteOptions

type VirtualHubRouteTableV2SClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubRouteTableV2SClientBeginDeleteOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.BeginDelete method.

type VirtualHubRouteTableV2SClientCreateOrUpdateResponse

type VirtualHubRouteTableV2SClientCreateOrUpdateResponse struct {
	VirtualHubRouteTableV2
}

VirtualHubRouteTableV2SClientCreateOrUpdateResponse contains the response from method VirtualHubRouteTableV2SClient.CreateOrUpdate.

type VirtualHubRouteTableV2SClientDeleteResponse

type VirtualHubRouteTableV2SClientDeleteResponse struct {
}

VirtualHubRouteTableV2SClientDeleteResponse contains the response from method VirtualHubRouteTableV2SClient.Delete.

type VirtualHubRouteTableV2SClientGetOptions

type VirtualHubRouteTableV2SClientGetOptions struct {
}

VirtualHubRouteTableV2SClientGetOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.Get method.

type VirtualHubRouteTableV2SClientGetResponse

type VirtualHubRouteTableV2SClientGetResponse struct {
	VirtualHubRouteTableV2
}

VirtualHubRouteTableV2SClientGetResponse contains the response from method VirtualHubRouteTableV2SClient.Get.

type VirtualHubRouteTableV2SClientListOptions

type VirtualHubRouteTableV2SClientListOptions struct {
}

VirtualHubRouteTableV2SClientListOptions contains the optional parameters for the VirtualHubRouteTableV2SClient.List method.

type VirtualHubRouteTableV2SClientListResponse

type VirtualHubRouteTableV2SClientListResponse struct {
	ListVirtualHubRouteTableV2SResult
}

VirtualHubRouteTableV2SClientListResponse contains the response 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.

func (*VirtualHubRouteV2) UnmarshalJSON

func (v *VirtualHubRouteV2) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[VirtualHubsClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "virtualHub2", armnetwork.VirtualHub{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.VirtualHubProperties{
		AddressPrefix: to.Ptr("10.168.0.0/24"),
		SKU:           to.Ptr("Basic"),
		VirtualWan: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualHubsClient) BeginDelete

func (client *VirtualHubsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualHubName string, options *VirtualHubsClientBeginDeleteOptions) (*runtime.Poller[VirtualHubsClientDeleteResponse], error)

BeginDelete - Deletes a VirtualHub. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "virtualHub1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualHubsClient) BeginGetEffectiveVirtualHubRoutes

func (client *VirtualHubsClient) BeginGetEffectiveVirtualHubRoutes(ctx context.Context, resourceGroupName string, virtualHubName string, options *VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions) (*runtime.Poller[VirtualHubsClientGetEffectiveVirtualHubRoutesResponse], 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. Generated from API version 2022-05-01 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 (EffectiveRoutesForAConnectionResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/EffectiveRoutesListForConnection.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetEffectiveVirtualHubRoutes(ctx, "rg1", "virtualHub1", &armnetwork.VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions{EffectiveRoutesParameters: &armnetwork.EffectiveRoutesParameters{
	ResourceID:             to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName"),
	VirtualWanResourceType: to.Ptr("ExpressRouteConnection"),
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

Example (EffectiveRoutesForARouteTableResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/EffectiveRoutesListForRouteTable.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetEffectiveVirtualHubRoutes(ctx, "rg1", "virtualHub1", &armnetwork.VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions{EffectiveRoutesParameters: &armnetwork.EffectiveRoutesParameters{
	ResourceID:             to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1"),
	VirtualWanResourceType: to.Ptr("RouteTable"),
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

Example (EffectiveRoutesForTheVirtualHub)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/EffectiveRoutesListForVirtualHub.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetEffectiveVirtualHubRoutes(ctx, "rg1", "virtualHub1", &armnetwork.VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions{EffectiveRoutesParameters: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualHubsClient) BeginGetInboundRoutes

func (client *VirtualHubsClient) BeginGetInboundRoutes(ctx context.Context, resourceGroupName string, virtualHubName string, getInboundRoutesParameters GetInboundRoutesParameters, options *VirtualHubsClientBeginGetInboundRoutesOptions) (*runtime.Poller[VirtualHubsClientGetInboundRoutesResponse], error)

BeginGetInboundRoutes - Gets the inbound routes configured for the Virtual Hub on a particular connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. getInboundRoutesParameters - Parameters supplied to get the inbound routes for a connection resource. options - VirtualHubsClientBeginGetInboundRoutesOptions contains the optional parameters for the VirtualHubsClient.BeginGetInboundRoutes method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/GetInboundRoutes.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetInboundRoutes(ctx, "rg1", "virtualHub1", armnetwork.GetInboundRoutesParameters{
	ConnectionType: to.Ptr("ExpressRouteConnection"),
	ResourceURI:    to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualHubsClient) BeginGetOutboundRoutes

func (client *VirtualHubsClient) BeginGetOutboundRoutes(ctx context.Context, resourceGroupName string, virtualHubName string, getOutboundRoutesParameters GetOutboundRoutesParameters, options *VirtualHubsClientBeginGetOutboundRoutesOptions) (*runtime.Poller[VirtualHubsClientGetOutboundRoutesResponse], error)

BeginGetOutboundRoutes - Gets the outbound routes configured for the Virtual Hub on a particular connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the VirtualHub. virtualHubName - The name of the VirtualHub. getOutboundRoutesParameters - Parameters supplied to get the outbound routes for a connection resource. options - VirtualHubsClientBeginGetOutboundRoutesOptions contains the optional parameters for the VirtualHubsClient.BeginGetOutboundRoutes method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/GetOutboundRoutes.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetOutboundRoutes(ctx, "rg1", "virtualHub1", armnetwork.GetOutboundRoutesParameters{
	ConnectionType: to.Ptr("ExpressRouteConnection"),
	ResourceURI:    to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "virtualHub1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualHubsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all the VirtualHubs in a resource group. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the VirtualHub. options - VirtualHubsClientListByResourceGroupOptions contains the optional parameters for the VirtualHubsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualHubsClient) NewListPager

NewListPager - Lists all the VirtualHubs in a subscription. Generated from API version 2022-05-01 options - VirtualHubsClientListOptions contains the optional parameters for the VirtualHubsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualHubUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualHubsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "virtualHub2", armnetwork.TagsObject{
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
		"key2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VirtualHubsClientBeginCreateOrUpdateOptions

type VirtualHubsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualHubsClient.BeginCreateOrUpdate method.

type VirtualHubsClientBeginDeleteOptions

type VirtualHubsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubsClientBeginDeleteOptions contains the optional parameters for the VirtualHubsClient.BeginDelete method.

type VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions

type VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions struct {
	// Parameters supplied to get the effective routes for a specific resource.
	EffectiveRoutesParameters *EffectiveRoutesParameters
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubsClientBeginGetEffectiveVirtualHubRoutesOptions contains the optional parameters for the VirtualHubsClient.BeginGetEffectiveVirtualHubRoutes method.

type VirtualHubsClientBeginGetInboundRoutesOptions

type VirtualHubsClientBeginGetInboundRoutesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubsClientBeginGetInboundRoutesOptions contains the optional parameters for the VirtualHubsClient.BeginGetInboundRoutes method.

type VirtualHubsClientBeginGetOutboundRoutesOptions

type VirtualHubsClientBeginGetOutboundRoutesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualHubsClientBeginGetOutboundRoutesOptions contains the optional parameters for the VirtualHubsClient.BeginGetOutboundRoutes method.

type VirtualHubsClientCreateOrUpdateResponse

type VirtualHubsClientCreateOrUpdateResponse struct {
	VirtualHub
}

VirtualHubsClientCreateOrUpdateResponse contains the response from method VirtualHubsClient.CreateOrUpdate.

type VirtualHubsClientDeleteResponse

type VirtualHubsClientDeleteResponse struct {
}

VirtualHubsClientDeleteResponse contains the response from method VirtualHubsClient.Delete.

type VirtualHubsClientGetEffectiveVirtualHubRoutesResponse

type VirtualHubsClientGetEffectiveVirtualHubRoutesResponse struct {
}

VirtualHubsClientGetEffectiveVirtualHubRoutesResponse contains the response from method VirtualHubsClient.GetEffectiveVirtualHubRoutes.

type VirtualHubsClientGetInboundRoutesResponse

type VirtualHubsClientGetInboundRoutesResponse struct {
}

VirtualHubsClientGetInboundRoutesResponse contains the response from method VirtualHubsClient.GetInboundRoutes.

type VirtualHubsClientGetOptions

type VirtualHubsClientGetOptions struct {
}

VirtualHubsClientGetOptions contains the optional parameters for the VirtualHubsClient.Get method.

type VirtualHubsClientGetOutboundRoutesResponse

type VirtualHubsClientGetOutboundRoutesResponse struct {
}

VirtualHubsClientGetOutboundRoutesResponse contains the response from method VirtualHubsClient.GetOutboundRoutes.

type VirtualHubsClientGetResponse

type VirtualHubsClientGetResponse struct {
	VirtualHub
}

VirtualHubsClientGetResponse contains the response from method VirtualHubsClient.Get.

type VirtualHubsClientListByResourceGroupOptions

type VirtualHubsClientListByResourceGroupOptions struct {
}

VirtualHubsClientListByResourceGroupOptions contains the optional parameters for the VirtualHubsClient.ListByResourceGroup method.

type VirtualHubsClientListByResourceGroupResponse

type VirtualHubsClientListByResourceGroupResponse struct {
	ListVirtualHubsResult
}

VirtualHubsClientListByResourceGroupResponse contains the response from method VirtualHubsClient.ListByResourceGroup.

type VirtualHubsClientListOptions

type VirtualHubsClientListOptions struct {
}

VirtualHubsClientListOptions contains the optional parameters for the VirtualHubsClient.List method.

type VirtualHubsClientListResponse

type VirtualHubsClientListResponse struct {
	ListVirtualHubsResult
}

VirtualHubsClientListResponse contains the response from method VirtualHubsClient.List.

type VirtualHubsClientUpdateTagsOptions

type VirtualHubsClientUpdateTagsOptions struct {
}

VirtualHubsClientUpdateTagsOptions contains the optional parameters for the VirtualHubsClient.UpdateTags method.

type VirtualHubsClientUpdateTagsResponse

type VirtualHubsClientUpdateTagsResponse struct {
	VirtualHub
}

VirtualHubsClientUpdateTagsResponse contains the response 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.

func (*VirtualNetwork) UnmarshalJSON

func (v *VirtualNetwork) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualNetworkBgpCommunities) MarshalJSON

func (v VirtualNetworkBgpCommunities) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkBgpCommunities.

func (*VirtualNetworkBgpCommunities) UnmarshalJSON

func (v *VirtualNetworkBgpCommunities) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkBgpCommunities.

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.

func (VirtualNetworkConnectionGatewayReference) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkConnectionGatewayReference.

func (*VirtualNetworkConnectionGatewayReference) UnmarshalJSON

func (v *VirtualNetworkConnectionGatewayReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkConnectionGatewayReference.

type VirtualNetworkDdosProtectionStatusResult

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

	// The Ddos Protection Status Result for each public ip under a virtual network.
	Value []*PublicIPDdosProtectionStatusResult `json:"value,omitempty"`
}

VirtualNetworkDdosProtectionStatusResult - Response for GetVirtualNetworkDdosProtectionStatusOperation.

func (VirtualNetworkDdosProtectionStatusResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkDdosProtectionStatusResult.

func (*VirtualNetworkDdosProtectionStatusResult) UnmarshalJSON

func (v *VirtualNetworkDdosProtectionStatusResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkDdosProtectionStatusResult.

type VirtualNetworkEncryption

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.

func (VirtualNetworkEncryption) MarshalJSON

func (v VirtualNetworkEncryption) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkEncryption.

func (*VirtualNetworkEncryption) UnmarshalJSON

func (v *VirtualNetworkEncryption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkEncryption.

type VirtualNetworkEncryptionEnforcement

type VirtualNetworkEncryptionEnforcement string

VirtualNetworkEncryptionEnforcement - If the encrypted VNet allows VM that does not support encryption

const (
	VirtualNetworkEncryptionEnforcementAllowUnencrypted VirtualNetworkEncryptionEnforcement = "AllowUnencrypted"
	VirtualNetworkEncryptionEnforcementDropUnencrypted  VirtualNetworkEncryptionEnforcement = "DropUnencrypted"
)

func PossibleVirtualNetworkEncryptionEnforcementValues

func PossibleVirtualNetworkEncryptionEnforcementValues() []VirtualNetworkEncryptionEnforcement

PossibleVirtualNetworkEncryptionEnforcementValues returns the possible values for the VirtualNetworkEncryptionEnforcement const type.

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.

func (*VirtualNetworkGateway) UnmarshalJSON

func (v *VirtualNetworkGateway) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VirtualNetworkGatewayConnection) UnmarshalJSON

func (v *VirtualNetworkGatewayConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayConnectionListEntity.

func (*VirtualNetworkGatewayConnectionListEntity) UnmarshalJSON

func (v *VirtualNetworkGatewayConnectionListEntity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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 the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be
	// enabled.
	EnablePrivateLinkFastPath *bool `json:"enablePrivateLinkFastPath,omitempty"`

	// Bypass ExpressRoute Gateway for data forwarding.
	ExpressRouteGatewayBypass *bool `json:"expressRouteGatewayBypass,omitempty"`

	// GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.
	GatewayCustomBgpIPAddresses []*GatewayCustomBgpIPAddressIPConfiguration `json:"gatewayCustomBgpIpAddresses,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

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayConnectionListEntityPropertiesFormat.

func (*VirtualNetworkGatewayConnectionListEntityPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayConnectionListResult.

func (*VirtualNetworkGatewayConnectionListResult) UnmarshalJSON

func (v *VirtualNetworkGatewayConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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 the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be
	// enabled.
	EnablePrivateLinkFastPath *bool `json:"enablePrivateLinkFastPath,omitempty"`

	// Bypass ExpressRoute Gateway for data forwarding.
	ExpressRouteGatewayBypass *bool `json:"expressRouteGatewayBypass,omitempty"`

	// GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.
	GatewayCustomBgpIPAddresses []*GatewayCustomBgpIPAddressIPConfiguration `json:"gatewayCustomBgpIpAddresses,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

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayConnectionPropertiesFormat.

func (*VirtualNetworkGatewayConnectionPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller 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.

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.

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.

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, error)

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

BeginCreateOrUpdate - Creates or updates a virtual network gateway connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "connS2S", armnetwork.VirtualNetworkGatewayConnection{
	Location: to.Ptr("centralus"),
	Properties: &armnetwork.VirtualNetworkGatewayConnectionPropertiesFormat{
		ConnectionMode:     to.Ptr(armnetwork.VirtualNetworkGatewayConnectionModeDefault),
		ConnectionProtocol: to.Ptr(armnetwork.VirtualNetworkGatewayConnectionProtocolIKEv2),
		ConnectionType:     to.Ptr(armnetwork.VirtualNetworkGatewayConnectionTypeIPsec),
		DpdTimeoutSeconds:  to.Ptr[int32](30),
		EgressNatRules: []*armnetwork.SubResource{
			{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
			}},
		EnableBgp: to.Ptr(false),
		GatewayCustomBgpIPAddresses: []*armnetwork.GatewayCustomBgpIPAddressIPConfiguration{
			{
				CustomBgpIPAddress: to.Ptr("169.254.21.1"),
				IPConfigurationID:  to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default"),
			},
			{
				CustomBgpIPAddress: to.Ptr("169.254.21.3"),
				IPConfigurationID:  to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive"),
			}},
		IngressNatRules: []*armnetwork.SubResource{
			{
				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"),
			}},
		IPSecPolicies: []*armnetwork.IPSecPolicy{},
		LocalNetworkGateway2: &armnetwork.LocalNetworkGateway{
			ID:       to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw"),
			Location: to.Ptr("centralus"),
			Tags:     map[string]*string{},
			Properties: &armnetwork.LocalNetworkGatewayPropertiesFormat{
				GatewayIPAddress: to.Ptr("x.x.x.x"),
				LocalNetworkAddressSpace: &armnetwork.AddressSpace{
					AddressPrefixes: []*string{
						to.Ptr("10.1.0.0/16")},
				},
			},
		},
		RoutingWeight:                  to.Ptr[int32](0),
		SharedKey:                      to.Ptr("Abc123"),
		TrafficSelectorPolicies:        []*armnetwork.TrafficSelectorPolicy{},
		UsePolicyBasedTrafficSelectors: to.Ptr(false),
		VirtualNetworkGateway1: &armnetwork.VirtualNetworkGateway{
			ID:       to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw"),
			Location: to.Ptr("centralus"),
			Tags:     map[string]*string{},
			Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
				Active: to.Ptr(false),
				BgpSettings: &armnetwork.BgpSettings{
					Asn:               to.Ptr[int64](65514),
					BgpPeeringAddress: to.Ptr("10.0.1.30"),
					PeerWeight:        to.Ptr[int32](0),
				},
				EnableBgp:   to.Ptr(false),
				GatewayType: to.Ptr(armnetwork.VirtualNetworkGatewayTypeVPN),
				IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
					{
						ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1"),
						Name: to.Ptr("gwipconfig1"),
						Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
							PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
							PublicIPAddress: &armnetwork.SubResource{
								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
							},
							Subnet: &armnetwork.SubResource{
								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
							},
						},
					}},
				SKU: &armnetwork.VirtualNetworkGatewaySKU{
					Name: to.Ptr(armnetwork.VirtualNetworkGatewaySKUNameVPNGw1),
					Tier: to.Ptr(armnetwork.VirtualNetworkGatewaySKUTierVPNGw1),
				},
				VPNType: to.Ptr(armnetwork.VPNTypeRouteBased),
			},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginDelete

BeginDelete - Deletes the specified virtual network Gateway connection. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "conn1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginGetIkeSas

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetIkeSas(ctx, "rg1", "vpngwcn1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginResetConnection

BeginResetConnection - Resets the virtual network gateway connection specified. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionReset.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginResetConnection(ctx, "rg1", "conn1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginResetSharedKey

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginResetSharedKey(ctx, "rg1", "conn1", armnetwork.ConnectionResetSharedKey{
	KeyLength: to.Ptr[int32](128),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginSetSharedKey

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginSetSharedKey(ctx, "rg1", "connS2S", armnetwork.ConnectionSharedKey{
	Value: to.Ptr("AzureAbc123"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginStartPacketCapture

BeginStartPacketCapture - Starts packet capture on virtual network gateway connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (StartPacketCaptureOnVirtualNetworkGatewayConnectionWithFilter)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStartPacketCapture(ctx, "rg1", "vpngwcn1", &armnetwork.VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions{Parameters: &armnetwork.VPNPacketCaptureStartParameters{
	FilterData: to.Ptr("{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}"),
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (StartPacketCaptureOnVirtualNetworkGatewayConnectionWithoutFilter)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStartPacketCapture(ctx, "rg1", "vpngwcn1", &armnetwork.VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions{Parameters: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginStopPacketCapture

BeginStopPacketCapture - Stops packet capture on virtual network gateway connection in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStopPacketCapture(ctx, "rg1", "vpngwcn1", armnetwork.VPNPacketCaptureStopParameters{
	SasURL: to.Ptr("https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayConnectionsClient) BeginUpdateTags

BeginUpdateTags - Updates a virtual network gateway connection tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdateTags(ctx, "rg1", "test", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayConnectionsClient) Get

Get - Gets the specified virtual network gateway connection by resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "connS2S", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayConnectionsClient) GetSharedKey

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetSharedKey(ctx, "rg1", "connS2S", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayConnectionsClient) NewListPager

NewListPager - The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - VirtualNetworkGatewayConnectionsClientListOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayConnectionsList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayConnectionsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VirtualNetworkGatewayConnectionsClientBeginCreateOrUpdateOptions

type VirtualNetworkGatewayConnectionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayConnectionsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginCreateOrUpdate method.

type VirtualNetworkGatewayConnectionsClientBeginDeleteOptions

type VirtualNetworkGatewayConnectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayConnectionsClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginDelete method.

type VirtualNetworkGatewayConnectionsClientBeginGetIkeSasOptions

type VirtualNetworkGatewayConnectionsClientBeginGetIkeSasOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayConnectionsClientBeginGetIkeSasOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginGetIkeSas method.

type VirtualNetworkGatewayConnectionsClientBeginResetConnectionOptions

type VirtualNetworkGatewayConnectionsClientBeginResetConnectionOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayConnectionsClientBeginResetConnectionOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginResetConnection method.

type VirtualNetworkGatewayConnectionsClientBeginResetSharedKeyOptions

type VirtualNetworkGatewayConnectionsClientBeginResetSharedKeyOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayConnectionsClientBeginResetSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginResetSharedKey method.

type VirtualNetworkGatewayConnectionsClientBeginSetSharedKeyOptions

type VirtualNetworkGatewayConnectionsClientBeginSetSharedKeyOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayConnectionsClientBeginSetSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginSetSharedKey method.

type VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions

type VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions struct {
	// Virtual network gateway packet capture parameters supplied to start packet capture on gateway connection.
	Parameters *VPNPacketCaptureStartParameters
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayConnectionsClientBeginStartPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginStartPacketCapture method.

type VirtualNetworkGatewayConnectionsClientBeginStopPacketCaptureOptions

type VirtualNetworkGatewayConnectionsClientBeginStopPacketCaptureOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayConnectionsClientBeginStopPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginStopPacketCapture method.

type VirtualNetworkGatewayConnectionsClientBeginUpdateTagsOptions

type VirtualNetworkGatewayConnectionsClientBeginUpdateTagsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayConnectionsClientBeginUpdateTagsOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.BeginUpdateTags method.

type VirtualNetworkGatewayConnectionsClientCreateOrUpdateResponse

type VirtualNetworkGatewayConnectionsClientCreateOrUpdateResponse struct {
	VirtualNetworkGatewayConnection
}

VirtualNetworkGatewayConnectionsClientCreateOrUpdateResponse contains the response from method VirtualNetworkGatewayConnectionsClient.CreateOrUpdate.

type VirtualNetworkGatewayConnectionsClientDeleteResponse

type VirtualNetworkGatewayConnectionsClientDeleteResponse struct {
}

VirtualNetworkGatewayConnectionsClientDeleteResponse contains the response from method VirtualNetworkGatewayConnectionsClient.Delete.

type VirtualNetworkGatewayConnectionsClientGetIkeSasResponse

type VirtualNetworkGatewayConnectionsClientGetIkeSasResponse struct {
	Value *string
}

VirtualNetworkGatewayConnectionsClientGetIkeSasResponse contains the response from method VirtualNetworkGatewayConnectionsClient.GetIkeSas.

func (*VirtualNetworkGatewayConnectionsClientGetIkeSasResponse) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewayConnectionsClientGetIkeSasResponse.

type VirtualNetworkGatewayConnectionsClientGetOptions

type VirtualNetworkGatewayConnectionsClientGetOptions struct {
}

VirtualNetworkGatewayConnectionsClientGetOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.Get method.

type VirtualNetworkGatewayConnectionsClientGetResponse

type VirtualNetworkGatewayConnectionsClientGetResponse struct {
	VirtualNetworkGatewayConnection
}

VirtualNetworkGatewayConnectionsClientGetResponse contains the response from method VirtualNetworkGatewayConnectionsClient.Get.

type VirtualNetworkGatewayConnectionsClientGetSharedKeyOptions

type VirtualNetworkGatewayConnectionsClientGetSharedKeyOptions struct {
}

VirtualNetworkGatewayConnectionsClientGetSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.GetSharedKey method.

type VirtualNetworkGatewayConnectionsClientGetSharedKeyResponse

type VirtualNetworkGatewayConnectionsClientGetSharedKeyResponse struct {
	ConnectionSharedKey
}

VirtualNetworkGatewayConnectionsClientGetSharedKeyResponse contains the response from method VirtualNetworkGatewayConnectionsClient.GetSharedKey.

type VirtualNetworkGatewayConnectionsClientListOptions

type VirtualNetworkGatewayConnectionsClientListOptions struct {
}

VirtualNetworkGatewayConnectionsClientListOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.List method.

type VirtualNetworkGatewayConnectionsClientListResponse

type VirtualNetworkGatewayConnectionsClientListResponse struct {
	VirtualNetworkGatewayConnectionListResult
}

VirtualNetworkGatewayConnectionsClientListResponse contains the response from method VirtualNetworkGatewayConnectionsClient.List.

type VirtualNetworkGatewayConnectionsClientResetConnectionResponse

type VirtualNetworkGatewayConnectionsClientResetConnectionResponse struct {
}

VirtualNetworkGatewayConnectionsClientResetConnectionResponse contains the response from method VirtualNetworkGatewayConnectionsClient.ResetConnection.

type VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse

type VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse struct {
	ConnectionResetSharedKey
}

VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse contains the response from method VirtualNetworkGatewayConnectionsClient.ResetSharedKey.

type VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse

type VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse struct {
	ConnectionSharedKey
}

VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse contains the response from method VirtualNetworkGatewayConnectionsClient.SetSharedKey.

type VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse

type VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse struct {
	Value *string
}

VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse contains the response from method VirtualNetworkGatewayConnectionsClient.StartPacketCapture.

func (*VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewayConnectionsClientStartPacketCaptureResponse.

type VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse

type VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse struct {
	Value *string
}

VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse contains the response from method VirtualNetworkGatewayConnectionsClient.StopPacketCapture.

func (*VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewayConnectionsClientStopPacketCaptureResponse.

type VirtualNetworkGatewayConnectionsClientUpdateTagsResponse

type VirtualNetworkGatewayConnectionsClientUpdateTagsResponse struct {
	VirtualNetworkGatewayConnection
}

VirtualNetworkGatewayConnectionsClientUpdateTagsResponse contains the response 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.

func (VirtualNetworkGatewayIPConfiguration) MarshalJSON

func (v VirtualNetworkGatewayIPConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayIPConfiguration.

func (*VirtualNetworkGatewayIPConfiguration) UnmarshalJSON

func (v *VirtualNetworkGatewayIPConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewayIPConfiguration.

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.

func (VirtualNetworkGatewayIPConfigurationPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayIPConfigurationPropertiesFormat.

func (*VirtualNetworkGatewayIPConfigurationPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewayIPConfigurationPropertiesFormat.

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

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayListConnectionsResult.

func (*VirtualNetworkGatewayListConnectionsResult) UnmarshalJSON

func (v *VirtualNetworkGatewayListConnectionsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VirtualNetworkGatewayListResult) UnmarshalJSON

func (v *VirtualNetworkGatewayListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualNetworkGatewayNatRule) MarshalJSON

func (v VirtualNetworkGatewayNatRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayNatRule.

func (*VirtualNetworkGatewayNatRule) UnmarshalJSON

func (v *VirtualNetworkGatewayNatRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewayNatRule.

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.

func (*VirtualNetworkGatewayNatRuleProperties) UnmarshalJSON

func (v *VirtualNetworkGatewayNatRuleProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayNatRulePut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "gateway1", "natRule1", armnetwork.VirtualNetworkGatewayNatRule{
	Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
		Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
		ExternalMappings: []*armnetwork.VPNNatRuleMapping{
			{
				AddressSpace: to.Ptr("192.168.21.0/24"),
				PortRange:    to.Ptr("300-400"),
			}},
		InternalMappings: []*armnetwork.VPNNatRuleMapping{
			{
				AddressSpace: to.Ptr("10.4.0.0/24"),
				PortRange:    to.Ptr("200-300"),
			}},
		IPConfigurationID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default"),
		Mode:              to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayNatRulesClient) BeginDelete

BeginDelete - Deletes a nat rule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayNatRuleDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "gateway1", "natRule1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualNetworkGatewayNatRulesClient) Get

Get - Retrieves the details of a nat rule. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayNatRuleGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "gateway1", "natRule1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewayNatRulesClient) NewListByVirtualNetworkGatewayPager

NewListByVirtualNetworkGatewayPager - Retrieves all nat rules for a particular virtual network gateway. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayNatRuleList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewayNatRulesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByVirtualNetworkGatewayPager("rg1", "gateway1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VirtualNetworkGatewayNatRulesClientBeginCreateOrUpdateOptions

type VirtualNetworkGatewayNatRulesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayNatRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.BeginCreateOrUpdate method.

type VirtualNetworkGatewayNatRulesClientBeginDeleteOptions

type VirtualNetworkGatewayNatRulesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewayNatRulesClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.BeginDelete method.

type VirtualNetworkGatewayNatRulesClientCreateOrUpdateResponse

type VirtualNetworkGatewayNatRulesClientCreateOrUpdateResponse struct {
	VirtualNetworkGatewayNatRule
}

VirtualNetworkGatewayNatRulesClientCreateOrUpdateResponse contains the response from method VirtualNetworkGatewayNatRulesClient.CreateOrUpdate.

type VirtualNetworkGatewayNatRulesClientDeleteResponse

type VirtualNetworkGatewayNatRulesClientDeleteResponse struct {
}

VirtualNetworkGatewayNatRulesClientDeleteResponse contains the response from method VirtualNetworkGatewayNatRulesClient.Delete.

type VirtualNetworkGatewayNatRulesClientGetOptions

type VirtualNetworkGatewayNatRulesClientGetOptions struct {
}

VirtualNetworkGatewayNatRulesClientGetOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.Get method.

type VirtualNetworkGatewayNatRulesClientGetResponse

type VirtualNetworkGatewayNatRulesClientGetResponse struct {
	VirtualNetworkGatewayNatRule
}

VirtualNetworkGatewayNatRulesClientGetResponse contains the response from method VirtualNetworkGatewayNatRulesClient.Get.

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayOptions

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayOptions struct {
}

VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayOptions contains the optional parameters for the VirtualNetworkGatewayNatRulesClient.ListByVirtualNetworkGateway method.

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResponse

type VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResponse struct {
	ListVirtualNetworkGatewayNatRulesResult
}

VirtualNetworkGatewayNatRulesClientListByVirtualNetworkGatewayResponse contains the response from method VirtualNetworkGatewayNatRulesClient.ListByVirtualNetworkGateway.

type VirtualNetworkGatewayPolicyGroup

type VirtualNetworkGatewayPolicyGroup 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 tVirtualNetworkGatewayPolicyGroup.
	Properties *VirtualNetworkGatewayPolicyGroupProperties `json:"properties,omitempty"`

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

VirtualNetworkGatewayPolicyGroup - Parameters for VirtualNetworkGatewayPolicyGroup.

func (VirtualNetworkGatewayPolicyGroup) MarshalJSON

func (v VirtualNetworkGatewayPolicyGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayPolicyGroup.

func (*VirtualNetworkGatewayPolicyGroup) UnmarshalJSON

func (v *VirtualNetworkGatewayPolicyGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewayPolicyGroup.

type VirtualNetworkGatewayPolicyGroupMember

type VirtualNetworkGatewayPolicyGroupMember struct {
	// The Vpn Policy member attribute type.
	AttributeType *VPNPolicyMemberAttributeType `json:"attributeType,omitempty"`

	// The value of Attribute used for this VirtualNetworkGatewayPolicyGroupMember.
	AttributeValue *string `json:"attributeValue,omitempty"`

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

VirtualNetworkGatewayPolicyGroupMember - Vpn Client Connection configuration PolicyGroup member

func (VirtualNetworkGatewayPolicyGroupMember) MarshalJSON

func (v VirtualNetworkGatewayPolicyGroupMember) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayPolicyGroupMember.

func (*VirtualNetworkGatewayPolicyGroupMember) UnmarshalJSON

func (v *VirtualNetworkGatewayPolicyGroupMember) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewayPolicyGroupMember.

type VirtualNetworkGatewayPolicyGroupProperties

type VirtualNetworkGatewayPolicyGroupProperties struct {
	// REQUIRED; Shows if this is a Default VirtualNetworkGatewayPolicyGroup or not.
	IsDefault *bool `json:"isDefault,omitempty"`

	// REQUIRED; Multiple PolicyMembers for VirtualNetworkGatewayPolicyGroup.
	PolicyMembers []*VirtualNetworkGatewayPolicyGroupMember `json:"policyMembers,omitempty"`

	// REQUIRED; Priority for VirtualNetworkGatewayPolicyGroup.
	Priority *int32 `json:"priority,omitempty"`

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

	// READ-ONLY; List of references to vngClientConnectionConfigurations.
	VngClientConnectionConfigurations []*SubResource `json:"vngClientConnectionConfigurations,omitempty" azure:"ro"`
}

VirtualNetworkGatewayPolicyGroupProperties - Properties of VirtualNetworkGatewayPolicyGroup.

func (VirtualNetworkGatewayPolicyGroupProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewayPolicyGroupProperties.

func (*VirtualNetworkGatewayPolicyGroupProperties) UnmarshalJSON

func (v *VirtualNetworkGatewayPolicyGroupProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewayPolicyGroupProperties.

type VirtualNetworkGatewayPropertiesFormat

type VirtualNetworkGatewayPropertiesFormat struct {
	// ActiveActive flag.
	Active *bool `json:"activeActive,omitempty"`

	// Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity
	// to Azure Virtual WAN.
	AllowRemoteVnetTraffic *bool `json:"allowRemoteVnetTraffic,omitempty"`

	// Configures this gateway to accept traffic from remote Virtual WAN networks.
	AllowVirtualWanTraffic *bool `json:"allowVirtualWanTraffic,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"`

	// The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup
	// for the gateway.
	VirtualNetworkGatewayPolicyGroups []*VirtualNetworkGatewayPolicyGroup `json:"virtualNetworkGatewayPolicyGroups,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.

func (*VirtualNetworkGatewayPropertiesFormat) UnmarshalJSON

func (v *VirtualNetworkGatewayPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualNetworkGatewaySKU) MarshalJSON

func (v VirtualNetworkGatewaySKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkGatewaySKU.

func (*VirtualNetworkGatewaySKU) UnmarshalJSON

func (v *VirtualNetworkGatewaySKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewaySKU.

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.

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.

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.

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, error)

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

BeginCreateOrUpdate - Creates or updates a virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "vpngw", armnetwork.VirtualNetworkGateway{
	Location: to.Ptr("centralus"),
	Properties: &armnetwork.VirtualNetworkGatewayPropertiesFormat{
		Active:                 to.Ptr(false),
		AllowRemoteVnetTraffic: to.Ptr(false),
		AllowVirtualWanTraffic: to.Ptr(false),
		BgpSettings: &armnetwork.BgpSettings{
			Asn:               to.Ptr[int64](65515),
			BgpPeeringAddress: to.Ptr("10.0.1.30"),
			PeerWeight:        to.Ptr[int32](0),
		},
		CustomRoutes: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("101.168.0.6/32")},
		},
		DisableIPSecReplayProtection:    to.Ptr(false),
		EnableBgp:                       to.Ptr(false),
		EnableBgpRouteTranslationForNat: to.Ptr(false),
		EnableDNSForwarding:             to.Ptr(true),
		GatewayType:                     to.Ptr(armnetwork.VirtualNetworkGatewayTypeVPN),
		IPConfigurations: []*armnetwork.VirtualNetworkGatewayIPConfiguration{
			{
				Name: to.Ptr("gwipconfig1"),
				Properties: &armnetwork.VirtualNetworkGatewayIPConfigurationPropertiesFormat{
					PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
					PublicIPAddress: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip"),
					},
					Subnet: &armnetwork.SubResource{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet"),
					},
				},
			}},
		NatRules: []*armnetwork.VirtualNetworkGatewayNatRule{
			{
				ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1"),
				Name: to.Ptr("natRule1"),
				Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
					Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
					ExternalMappings: []*armnetwork.VPNNatRuleMapping{
						{
							AddressSpace: to.Ptr("50.0.0.0/24"),
						}},
					InternalMappings: []*armnetwork.VPNNatRuleMapping{
						{
							AddressSpace: to.Ptr("10.10.0.0/24"),
						}},
					IPConfigurationID: to.Ptr(""),
					Mode:              to.Ptr(armnetwork.VPNNatRuleModeEgressSnat),
				},
			},
			{
				ID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2"),
				Name: to.Ptr("natRule2"),
				Properties: &armnetwork.VirtualNetworkGatewayNatRuleProperties{
					Type: to.Ptr(armnetwork.VPNNatRuleTypeStatic),
					ExternalMappings: []*armnetwork.VPNNatRuleMapping{
						{
							AddressSpace: to.Ptr("30.0.0.0/24"),
						}},
					InternalMappings: []*armnetwork.VPNNatRuleMapping{
						{
							AddressSpace: to.Ptr("20.10.0.0/24"),
						}},
					IPConfigurationID: to.Ptr(""),
					Mode:              to.Ptr(armnetwork.VPNNatRuleModeIngressSnat),
				},
			}},
		SKU: &armnetwork.VirtualNetworkGatewaySKU{
			Name: to.Ptr(armnetwork.VirtualNetworkGatewaySKUNameVPNGw1),
			Tier: to.Ptr(armnetwork.VirtualNetworkGatewaySKUTierVPNGw1),
		},
		VPNClientConfiguration: &armnetwork.VPNClientConfiguration{
			RadiusServers: []*armnetwork.RadiusServer{
				{
					RadiusServerAddress: to.Ptr("10.2.0.0"),
					RadiusServerScore:   to.Ptr[int64](20),
					RadiusServerSecret:  to.Ptr("radiusServerSecret"),
				}},
			VPNClientProtocols: []*armnetwork.VPNClientProtocol{
				to.Ptr(armnetwork.VPNClientProtocolOpenVPN)},
			VPNClientRevokedCertificates: []*armnetwork.VPNClientRevokedCertificate{},
			VPNClientRootCertificates:    []*armnetwork.VPNClientRootCertificate{},
		},
		VPNType: to.Ptr(armnetwork.VPNTypeRouteBased),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginDelete

BeginDelete - Deletes the specified virtual network gateway. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "vpngw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualNetworkGatewaysClient) BeginDisconnectVirtualNetworkGatewayVPNConnections

BeginDisconnectVirtualNetworkGatewayVPNConnections - Disconnect vpn connections of virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDisconnectVirtualNetworkGatewayVPNConnections(ctx, "vpn-gateway-test", "vpngateway", armnetwork.P2SVPNConnectionRequest{
	VPNConnectionIDs: []*string{
		to.Ptr("vpnconnId1"),
		to.Ptr("vpnconnId2")},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualNetworkGatewaysClient) BeginGenerateVPNProfile

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. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGenerateVPNProfile(ctx, "rg1", "vpngw", armnetwork.VPNClientParameters{}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginGeneratevpnclientpackage

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGeneratevpnclientpackage(ctx, "rg1", "vpngw", armnetwork.VPNClientParameters{}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginGetAdvertisedRoutes

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetAdvertisedRoutes(ctx, "rg1", "vpngw", "test", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginGetBgpPeerStatus

BeginGetBgpPeerStatus - The GetBgpPeerStatus operation retrieves the status of all BGP peers. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetBgpPeerStatus(ctx, "rg1", "vpngw", &armnetwork.VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions{Peer: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginGetLearnedRoutes

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayLearnedRoutes.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetLearnedRoutes(ctx, "rg1", "vpngw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginGetVPNProfilePackageURL

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. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetVPNProfilePackageURL(ctx, "rg1", "vpngw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginGetVpnclientConnectionHealth

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetVpnclientConnectionHealth(ctx, "p2s-vnet-test", "vpnp2sgw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginGetVpnclientIPSecParameters

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. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. virtualNetworkGatewayName - The virtual network gateway name. options - VirtualNetworkGatewaysClientBeginGetVpnclientIPSecParametersOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetVpnclientIPSecParameters method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetVpnclientIPSecParameters(ctx, "rg1", "vpngw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginReset

BeginReset - Resets the primary of the virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayReset.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginReset(ctx, "rg1", "vpngw", &armnetwork.VirtualNetworkGatewaysClientBeginResetOptions{GatewayVip: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginResetVPNClientSharedKey

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. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginResetVPNClientSharedKey(ctx, "rg1", "vpngw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualNetworkGatewaysClient) BeginSetVpnclientIPSecParameters

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. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginSetVpnclientIPSecParameters(ctx, "rg1", "vpngw", armnetwork.VPNClientIPsecParameters{
	DhGroup:             to.Ptr(armnetwork.DhGroupDHGroup2),
	IkeEncryption:       to.Ptr(armnetwork.IkeEncryptionAES256),
	IkeIntegrity:        to.Ptr(armnetwork.IkeIntegritySHA384),
	IPSecEncryption:     to.Ptr(armnetwork.IPSecEncryptionAES256),
	IPSecIntegrity:      to.Ptr(armnetwork.IPSecIntegritySHA256),
	PfsGroup:            to.Ptr(armnetwork.PfsGroupPFS2),
	SaDataSizeKilobytes: to.Ptr[int32](429497),
	SaLifeTimeSeconds:   to.Ptr[int32](86473),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginStartPacketCapture

BeginStartPacketCapture - Starts packet capture on virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (StartPacketCaptureOnVirtualNetworkGatewayWithFilter)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStartPacketCapture(ctx, "rg1", "vpngw", &armnetwork.VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions{Parameters: &armnetwork.VPNPacketCaptureStartParameters{
	FilterData: to.Ptr("{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}"),
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (StartPacketCaptureOnVirtualNetworkGatewayWithoutFilter)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayStartPacketCapture.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStartPacketCapture(ctx, "rg1", "vpngw", &armnetwork.VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions{Parameters: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginStopPacketCapture

BeginStopPacketCapture - Stops packet capture on virtual network gateway in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayStopPacketCapture.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginStopPacketCapture(ctx, "rg1", "vpngw", armnetwork.VPNPacketCaptureStopParameters{
	SasURL: to.Ptr("https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) BeginUpdateTags

func (client *VirtualNetworkGatewaysClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, virtualNetworkGatewayName string, parameters TagsObject, options *VirtualNetworkGatewaysClientBeginUpdateTagsOptions) (*runtime.Poller[VirtualNetworkGatewaysClientUpdateTagsResponse], error)

BeginUpdateTags - Updates a virtual network gateway tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginUpdateTags(ctx, "rg1", "vpngw", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "vpngw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) NewListConnectionsPager

func (client *VirtualNetworkGatewaysClient) NewListConnectionsPager(resourceGroupName string, virtualNetworkGatewayName string, options *VirtualNetworkGatewaysClientListConnectionsOptions) *runtime.Pager[VirtualNetworkGatewaysClientListConnectionsResponse]

NewListConnectionsPager - Gets all the connections in a virtual network gateway. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewaysListConnections.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListConnectionsPager("testrg", "test-vpn-gateway-1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualNetworkGatewaysClient) NewListPager

NewListPager - Gets all virtual network gateways by resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - VirtualNetworkGatewaysClientListOptions contains the optional parameters for the VirtualNetworkGatewaysClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualNetworkGatewaysClient) SupportedVPNDevices

SupportedVPNDevices - Gets a xml format representation for supported vpn devices. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.SupportedVPNDevices(ctx, "rg1", "vpngw", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkGatewaysClient) VPNDeviceConfigurationScript

VPNDeviceConfigurationScript - Gets a xml format representation for vpn device configuration script. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkGatewaysClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.VPNDeviceConfigurationScript(ctx, "rg1", "vpngw", armnetwork.VPNDeviceScriptParameters{
	DeviceFamily:    to.Ptr("ISR"),
	FirmwareVersion: to.Ptr("IOS 15.1 (Preview)"),
	Vendor:          to.Ptr("Cisco"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VirtualNetworkGatewaysClientBeginCreateOrUpdateOptions

type VirtualNetworkGatewaysClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginCreateOrUpdate method.

type VirtualNetworkGatewaysClientBeginDeleteOptions

type VirtualNetworkGatewaysClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginDelete method.

type VirtualNetworkGatewaysClientBeginDisconnectVirtualNetworkGatewayVPNConnectionsOptions

type VirtualNetworkGatewaysClientBeginDisconnectVirtualNetworkGatewayVPNConnectionsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginDisconnectVirtualNetworkGatewayVPNConnectionsOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginDisconnectVirtualNetworkGatewayVPNConnections method.

type VirtualNetworkGatewaysClientBeginGenerateVPNProfileOptions

type VirtualNetworkGatewaysClientBeginGenerateVPNProfileOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginGenerateVPNProfileOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGenerateVPNProfile method.

type VirtualNetworkGatewaysClientBeginGeneratevpnclientpackageOptions

type VirtualNetworkGatewaysClientBeginGeneratevpnclientpackageOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginGeneratevpnclientpackageOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGeneratevpnclientpackage method.

type VirtualNetworkGatewaysClientBeginGetAdvertisedRoutesOptions

type VirtualNetworkGatewaysClientBeginGetAdvertisedRoutesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginGetAdvertisedRoutesOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetAdvertisedRoutes method.

type VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions

type VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions struct {
	// The IP address of the peer to retrieve the status of.
	Peer *string
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginGetBgpPeerStatusOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetBgpPeerStatus method.

type VirtualNetworkGatewaysClientBeginGetLearnedRoutesOptions

type VirtualNetworkGatewaysClientBeginGetLearnedRoutesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginGetLearnedRoutesOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetLearnedRoutes method.

type VirtualNetworkGatewaysClientBeginGetVPNProfilePackageURLOptions

type VirtualNetworkGatewaysClientBeginGetVPNProfilePackageURLOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginGetVPNProfilePackageURLOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetVPNProfilePackageURL method.

type VirtualNetworkGatewaysClientBeginGetVpnclientConnectionHealthOptions

type VirtualNetworkGatewaysClientBeginGetVpnclientConnectionHealthOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginGetVpnclientConnectionHealthOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetVpnclientConnectionHealth method.

type VirtualNetworkGatewaysClientBeginGetVpnclientIPSecParametersOptions

type VirtualNetworkGatewaysClientBeginGetVpnclientIPSecParametersOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginGetVpnclientIPSecParametersOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginGetVpnclientIPSecParameters method.

type VirtualNetworkGatewaysClientBeginResetOptions

type VirtualNetworkGatewaysClientBeginResetOptions struct {
	// Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway.
	GatewayVip *string
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginResetOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginReset method.

type VirtualNetworkGatewaysClientBeginResetVPNClientSharedKeyOptions

type VirtualNetworkGatewaysClientBeginResetVPNClientSharedKeyOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginResetVPNClientSharedKeyOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginResetVPNClientSharedKey method.

type VirtualNetworkGatewaysClientBeginSetVpnclientIPSecParametersOptions

type VirtualNetworkGatewaysClientBeginSetVpnclientIPSecParametersOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginSetVpnclientIPSecParametersOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginSetVpnclientIPSecParameters method.

type VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions

type VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions struct {
	// Virtual network gateway packet capture parameters supplied to start packet capture on gateway.
	Parameters *VPNPacketCaptureStartParameters
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginStartPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginStartPacketCapture method.

type VirtualNetworkGatewaysClientBeginStopPacketCaptureOptions

type VirtualNetworkGatewaysClientBeginStopPacketCaptureOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginStopPacketCaptureOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginStopPacketCapture method.

type VirtualNetworkGatewaysClientBeginUpdateTagsOptions

type VirtualNetworkGatewaysClientBeginUpdateTagsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the VirtualNetworkGatewaysClient.BeginUpdateTags method.

type VirtualNetworkGatewaysClientCreateOrUpdateResponse

type VirtualNetworkGatewaysClientCreateOrUpdateResponse struct {
	VirtualNetworkGateway
}

VirtualNetworkGatewaysClientCreateOrUpdateResponse contains the response from method VirtualNetworkGatewaysClient.CreateOrUpdate.

type VirtualNetworkGatewaysClientDeleteResponse

type VirtualNetworkGatewaysClientDeleteResponse struct {
}

VirtualNetworkGatewaysClientDeleteResponse contains the response from method VirtualNetworkGatewaysClient.Delete.

type VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsResponse

type VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsResponse struct {
}

VirtualNetworkGatewaysClientDisconnectVirtualNetworkGatewayVPNConnectionsResponse contains the response from method VirtualNetworkGatewaysClient.DisconnectVirtualNetworkGatewayVPNConnections.

type VirtualNetworkGatewaysClientGenerateVPNProfileResponse

type VirtualNetworkGatewaysClientGenerateVPNProfileResponse struct {
	Value *string
}

VirtualNetworkGatewaysClientGenerateVPNProfileResponse contains the response from method VirtualNetworkGatewaysClient.GenerateVPNProfile.

func (*VirtualNetworkGatewaysClientGenerateVPNProfileResponse) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewaysClientGenerateVPNProfileResponse.

type VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse

type VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse struct {
	Value *string
}

VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse contains the response from method VirtualNetworkGatewaysClient.Generatevpnclientpackage.

func (*VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewaysClientGeneratevpnclientpackageResponse.

type VirtualNetworkGatewaysClientGetAdvertisedRoutesResponse

type VirtualNetworkGatewaysClientGetAdvertisedRoutesResponse struct {
	GatewayRouteListResult
}

VirtualNetworkGatewaysClientGetAdvertisedRoutesResponse contains the response from method VirtualNetworkGatewaysClient.GetAdvertisedRoutes.

type VirtualNetworkGatewaysClientGetBgpPeerStatusResponse

type VirtualNetworkGatewaysClientGetBgpPeerStatusResponse struct {
	BgpPeerStatusListResult
}

VirtualNetworkGatewaysClientGetBgpPeerStatusResponse contains the response from method VirtualNetworkGatewaysClient.GetBgpPeerStatus.

type VirtualNetworkGatewaysClientGetLearnedRoutesResponse

type VirtualNetworkGatewaysClientGetLearnedRoutesResponse struct {
	GatewayRouteListResult
}

VirtualNetworkGatewaysClientGetLearnedRoutesResponse contains the response from method VirtualNetworkGatewaysClient.GetLearnedRoutes.

type VirtualNetworkGatewaysClientGetOptions

type VirtualNetworkGatewaysClientGetOptions struct {
}

VirtualNetworkGatewaysClientGetOptions contains the optional parameters for the VirtualNetworkGatewaysClient.Get method.

type VirtualNetworkGatewaysClientGetResponse

type VirtualNetworkGatewaysClientGetResponse struct {
	VirtualNetworkGateway
}

VirtualNetworkGatewaysClientGetResponse contains the response from method VirtualNetworkGatewaysClient.Get.

type VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse

type VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse struct {
	Value *string
}

VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse contains the response from method VirtualNetworkGatewaysClient.GetVPNProfilePackageURL.

func (*VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse.

type VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResponse

type VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResponse struct {
	VPNClientConnectionHealthDetailListResult
}

VirtualNetworkGatewaysClientGetVpnclientConnectionHealthResponse contains the response from method VirtualNetworkGatewaysClient.GetVpnclientConnectionHealth.

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse struct {
	VPNClientIPsecParameters
}

VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse contains the response from method VirtualNetworkGatewaysClient.GetVpnclientIPSecParameters.

type VirtualNetworkGatewaysClientListConnectionsOptions

type VirtualNetworkGatewaysClientListConnectionsOptions struct {
}

VirtualNetworkGatewaysClientListConnectionsOptions contains the optional parameters for the VirtualNetworkGatewaysClient.ListConnections method.

type VirtualNetworkGatewaysClientListConnectionsResponse

type VirtualNetworkGatewaysClientListConnectionsResponse struct {
	VirtualNetworkGatewayListConnectionsResult
}

VirtualNetworkGatewaysClientListConnectionsResponse contains the response from method VirtualNetworkGatewaysClient.ListConnections.

type VirtualNetworkGatewaysClientListOptions

type VirtualNetworkGatewaysClientListOptions struct {
}

VirtualNetworkGatewaysClientListOptions contains the optional parameters for the VirtualNetworkGatewaysClient.List method.

type VirtualNetworkGatewaysClientListResponse

type VirtualNetworkGatewaysClientListResponse struct {
	VirtualNetworkGatewayListResult
}

VirtualNetworkGatewaysClientListResponse contains the response from method VirtualNetworkGatewaysClient.List.

type VirtualNetworkGatewaysClientResetResponse

type VirtualNetworkGatewaysClientResetResponse struct {
	VirtualNetworkGateway
}

VirtualNetworkGatewaysClientResetResponse contains the response from method VirtualNetworkGatewaysClient.Reset.

type VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse

type VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse struct {
}

VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse contains the response from method VirtualNetworkGatewaysClient.ResetVPNClientSharedKey.

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse struct {
	VPNClientIPsecParameters
}

VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse contains the response from method VirtualNetworkGatewaysClient.SetVpnclientIPSecParameters.

type VirtualNetworkGatewaysClientStartPacketCaptureResponse

type VirtualNetworkGatewaysClientStartPacketCaptureResponse struct {
	Value *string
}

VirtualNetworkGatewaysClientStartPacketCaptureResponse contains the response from method VirtualNetworkGatewaysClient.StartPacketCapture.

func (*VirtualNetworkGatewaysClientStartPacketCaptureResponse) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewaysClientStartPacketCaptureResponse.

type VirtualNetworkGatewaysClientStopPacketCaptureResponse

type VirtualNetworkGatewaysClientStopPacketCaptureResponse struct {
	Value *string
}

VirtualNetworkGatewaysClientStopPacketCaptureResponse contains the response from method VirtualNetworkGatewaysClient.StopPacketCapture.

func (*VirtualNetworkGatewaysClientStopPacketCaptureResponse) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewaysClientStopPacketCaptureResponse.

type VirtualNetworkGatewaysClientSupportedVPNDevicesOptions

type VirtualNetworkGatewaysClientSupportedVPNDevicesOptions struct {
}

VirtualNetworkGatewaysClientSupportedVPNDevicesOptions contains the optional parameters for the VirtualNetworkGatewaysClient.SupportedVPNDevices method.

type VirtualNetworkGatewaysClientSupportedVPNDevicesResponse

type VirtualNetworkGatewaysClientSupportedVPNDevicesResponse struct {
	Value *string
}

VirtualNetworkGatewaysClientSupportedVPNDevicesResponse contains the response from method VirtualNetworkGatewaysClient.SupportedVPNDevices.

type VirtualNetworkGatewaysClientUpdateTagsResponse

type VirtualNetworkGatewaysClientUpdateTagsResponse struct {
	VirtualNetworkGateway
}

VirtualNetworkGatewaysClientUpdateTagsResponse contains the response from method VirtualNetworkGatewaysClient.UpdateTags.

type VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptOptions

type VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptOptions struct {
}

VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptOptions contains the optional parameters for the VirtualNetworkGatewaysClient.VPNDeviceConfigurationScript method.

type VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResponse

type VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResponse struct {
	Value *string
}

VirtualNetworkGatewaysClientVPNDeviceConfigurationScriptResponse contains the response 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.

func (*VirtualNetworkListResult) UnmarshalJSON

func (v *VirtualNetworkListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VirtualNetworkListUsageResult) UnmarshalJSON

func (v *VirtualNetworkListUsageResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualNetworkPeering) MarshalJSON

func (v VirtualNetworkPeering) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkPeering.

func (*VirtualNetworkPeering) UnmarshalJSON

func (v *VirtualNetworkPeering) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkPeering.

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.

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.

func (*VirtualNetworkPeeringListResult) UnmarshalJSON

func (v *VirtualNetworkPeeringListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualNetworkPeeringPropertiesFormat) MarshalJSON

func (v VirtualNetworkPeeringPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkPeeringPropertiesFormat.

func (*VirtualNetworkPeeringPropertiesFormat) UnmarshalJSON

func (v *VirtualNetworkPeeringPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkPeeringPropertiesFormat.

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.

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, error)

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) (*runtime.Poller[VirtualNetworkPeeringsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a peering in the specified virtual network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreatePeering)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkPeeringCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "peerTest", "vnet1", "peer", armnetwork.VirtualNetworkPeering{
	Properties: &armnetwork.VirtualNetworkPeeringPropertiesFormat{
		AllowForwardedTraffic:     to.Ptr(true),
		AllowGatewayTransit:       to.Ptr(false),
		AllowVirtualNetworkAccess: to.Ptr(true),
		RemoteVirtualNetwork: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2"),
		},
		UseRemoteGateways: to.Ptr(false),
	},
}, &armnetwork.VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions{SyncRemoteAddressSpace: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreatePeeringWithRemoteVirtualNetworkEncryption)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "peerTest", "vnet1", "peer", armnetwork.VirtualNetworkPeering{
	Properties: &armnetwork.VirtualNetworkPeeringPropertiesFormat{
		AllowForwardedTraffic:     to.Ptr(true),
		AllowGatewayTransit:       to.Ptr(false),
		AllowVirtualNetworkAccess: to.Ptr(true),
		RemoteVirtualNetwork: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2"),
		},
		UseRemoteGateways: to.Ptr(false),
	},
}, &armnetwork.VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions{SyncRemoteAddressSpace: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (SyncPeering)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkPeeringSync.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "peerTest", "vnet1", "peer", armnetwork.VirtualNetworkPeering{
	Properties: &armnetwork.VirtualNetworkPeeringPropertiesFormat{
		AllowForwardedTraffic:     to.Ptr(true),
		AllowGatewayTransit:       to.Ptr(false),
		AllowVirtualNetworkAccess: to.Ptr(true),
		RemoteVirtualNetwork: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2"),
		},
		UseRemoteGateways: to.Ptr(false),
	},
}, &armnetwork.VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions{SyncRemoteAddressSpace: to.Ptr(armnetwork.SyncRemoteAddressSpaceTrue)})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkPeeringsClient) BeginDelete

func (client *VirtualNetworkPeeringsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualNetworkName string, virtualNetworkPeeringName string, options *VirtualNetworkPeeringsClientBeginDeleteOptions) (*runtime.Poller[VirtualNetworkPeeringsClientDeleteResponse], error)

BeginDelete - Deletes the specified virtual network peering. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkPeeringDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "peerTest", "vnet1", "peer", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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 (GetPeering)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkPeeringGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "peerTest", "vnet1", "peer", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetPeeringWithRemoteVirtualNetworkEncryption)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "peerTest", "vnet1", "peer", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkPeeringsClient) NewListPager

NewListPager - Gets all virtual network peerings in a virtual network. Generated from API version 2022-05-01 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 (ListPeerings)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkPeeringList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("peerTest", "vnet1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

Example (ListPeeringsWithRemoteVirtualNetworkEncryption)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("peerTest", "vnet1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions

type VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
	// 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

type VirtualNetworkPeeringsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkPeeringsClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkPeeringsClient.BeginDelete method.

type VirtualNetworkPeeringsClientCreateOrUpdateResponse

type VirtualNetworkPeeringsClientCreateOrUpdateResponse struct {
	VirtualNetworkPeering
}

VirtualNetworkPeeringsClientCreateOrUpdateResponse contains the response from method VirtualNetworkPeeringsClient.CreateOrUpdate.

type VirtualNetworkPeeringsClientDeleteResponse

type VirtualNetworkPeeringsClientDeleteResponse struct {
}

VirtualNetworkPeeringsClientDeleteResponse contains the response from method VirtualNetworkPeeringsClient.Delete.

type VirtualNetworkPeeringsClientGetOptions

type VirtualNetworkPeeringsClientGetOptions struct {
}

VirtualNetworkPeeringsClientGetOptions contains the optional parameters for the VirtualNetworkPeeringsClient.Get method.

type VirtualNetworkPeeringsClientGetResponse

type VirtualNetworkPeeringsClientGetResponse struct {
	VirtualNetworkPeering
}

VirtualNetworkPeeringsClientGetResponse contains the response from method VirtualNetworkPeeringsClient.Get.

type VirtualNetworkPeeringsClientListOptions

type VirtualNetworkPeeringsClientListOptions struct {
}

VirtualNetworkPeeringsClientListOptions contains the optional parameters for the VirtualNetworkPeeringsClient.List method.

type VirtualNetworkPeeringsClientListResponse

type VirtualNetworkPeeringsClientListResponse struct {
	VirtualNetworkPeeringListResult
}

VirtualNetworkPeeringsClientListResponse contains the response 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.

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.

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.

func (*VirtualNetworkPropertiesFormat) UnmarshalJSON

func (v *VirtualNetworkPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VirtualNetworkTap) UnmarshalJSON

func (v *VirtualNetworkTap) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VirtualNetworkTapListResult) UnmarshalJSON

func (v *VirtualNetworkTapListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VirtualNetworkTapPropertiesFormat) UnmarshalJSON

func (v *VirtualNetworkTapPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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

BeginCreateOrUpdate - Creates or updates a Virtual Network Tap. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkTapCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkTapsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-vtap", armnetwork.VirtualNetworkTap{
	Location: to.Ptr("centraluseuap"),
	Properties: &armnetwork.VirtualNetworkTapPropertiesFormat{
		DestinationNetworkInterfaceIPConfiguration: &armnetwork.InterfaceIPConfiguration{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/ipconfig1"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkTapsClient) BeginDelete

BeginDelete - Deletes the specified virtual network tap. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkTapDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkTapsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-vtap", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualNetworkTapsClient) Get

Get - Gets information about the specified virtual network tap. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkTapGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkTapsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "testvtap", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworkTapsClient) NewListAllPager

NewListAllPager - Gets all the VirtualNetworkTaps in a subscription. Generated from API version 2022-05-01 options - VirtualNetworkTapsClientListAllOptions contains the optional parameters for the VirtualNetworkTapsClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkTapListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkTapsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualNetworkTapsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Gets all the VirtualNetworkTaps in a subscription. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - VirtualNetworkTapsClientListByResourceGroupOptions contains the optional parameters for the VirtualNetworkTapsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkTapList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkTapsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualNetworkTapsClient) UpdateTags

UpdateTags - Updates an VirtualNetworkTap tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkTapUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworkTapsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-vtap", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VirtualNetworkTapsClientBeginCreateOrUpdateOptions

type VirtualNetworkTapsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkTapsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworkTapsClient.BeginCreateOrUpdate method.

type VirtualNetworkTapsClientBeginDeleteOptions

type VirtualNetworkTapsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworkTapsClientBeginDeleteOptions contains the optional parameters for the VirtualNetworkTapsClient.BeginDelete method.

type VirtualNetworkTapsClientCreateOrUpdateResponse

type VirtualNetworkTapsClientCreateOrUpdateResponse struct {
	VirtualNetworkTap
}

VirtualNetworkTapsClientCreateOrUpdateResponse contains the response from method VirtualNetworkTapsClient.CreateOrUpdate.

type VirtualNetworkTapsClientDeleteResponse

type VirtualNetworkTapsClientDeleteResponse struct {
}

VirtualNetworkTapsClientDeleteResponse contains the response from method VirtualNetworkTapsClient.Delete.

type VirtualNetworkTapsClientGetOptions

type VirtualNetworkTapsClientGetOptions struct {
}

VirtualNetworkTapsClientGetOptions contains the optional parameters for the VirtualNetworkTapsClient.Get method.

type VirtualNetworkTapsClientGetResponse

type VirtualNetworkTapsClientGetResponse struct {
	VirtualNetworkTap
}

VirtualNetworkTapsClientGetResponse contains the response from method VirtualNetworkTapsClient.Get.

type VirtualNetworkTapsClientListAllOptions

type VirtualNetworkTapsClientListAllOptions struct {
}

VirtualNetworkTapsClientListAllOptions contains the optional parameters for the VirtualNetworkTapsClient.ListAll method.

type VirtualNetworkTapsClientListAllResponse

type VirtualNetworkTapsClientListAllResponse struct {
	VirtualNetworkTapListResult
}

VirtualNetworkTapsClientListAllResponse contains the response from method VirtualNetworkTapsClient.ListAll.

type VirtualNetworkTapsClientListByResourceGroupOptions

type VirtualNetworkTapsClientListByResourceGroupOptions struct {
}

VirtualNetworkTapsClientListByResourceGroupOptions contains the optional parameters for the VirtualNetworkTapsClient.ListByResourceGroup method.

type VirtualNetworkTapsClientListByResourceGroupResponse

type VirtualNetworkTapsClientListByResourceGroupResponse struct {
	VirtualNetworkTapListResult
}

VirtualNetworkTapsClientListByResourceGroupResponse contains the response from method VirtualNetworkTapsClient.ListByResourceGroup.

type VirtualNetworkTapsClientUpdateTagsOptions

type VirtualNetworkTapsClientUpdateTagsOptions struct {
}

VirtualNetworkTapsClientUpdateTagsOptions contains the optional parameters for the VirtualNetworkTapsClient.UpdateTags method.

type VirtualNetworkTapsClientUpdateTagsResponse

type VirtualNetworkTapsClientUpdateTagsResponse struct {
	VirtualNetworkTap
}

VirtualNetworkTapsClientUpdateTagsResponse contains the response 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.

func (VirtualNetworkUsage) MarshalJSON

func (v VirtualNetworkUsage) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkUsage.

func (*VirtualNetworkUsage) UnmarshalJSON

func (v *VirtualNetworkUsage) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkUsage.

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.

func (VirtualNetworkUsageName) MarshalJSON

func (v VirtualNetworkUsageName) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkUsageName.

func (*VirtualNetworkUsageName) UnmarshalJSON

func (v *VirtualNetworkUsageName) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkUsageName.

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, error)

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) (*runtime.Poller[VirtualNetworksClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a virtual network in the specified resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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 (CreateVirtualNetwork)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-vnet", armnetwork.VirtualNetwork{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.VirtualNetworkPropertiesFormat{
		AddressSpace: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("10.0.0.0/16")},
		},
		FlowTimeoutInMinutes: to.Ptr[int32](10),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateVirtualNetworkWithBgpCommunities)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkCreateWithBgpCommunities.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-vnet", armnetwork.VirtualNetwork{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.VirtualNetworkPropertiesFormat{
		AddressSpace: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("10.0.0.0/16")},
		},
		BgpCommunities: &armnetwork.VirtualNetworkBgpCommunities{
			VirtualNetworkCommunity: to.Ptr("12076:20000"),
		},
		Subnets: []*armnetwork.Subnet{
			{
				Name: to.Ptr("test-1"),
				Properties: &armnetwork.SubnetPropertiesFormat{
					AddressPrefix: to.Ptr("10.0.0.0/24"),
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateVirtualNetworkWithDelegatedSubnets)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkCreateSubnetWithDelegation.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-vnet", armnetwork.VirtualNetwork{
	Location: to.Ptr("westcentralus"),
	Properties: &armnetwork.VirtualNetworkPropertiesFormat{
		AddressSpace: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("10.0.0.0/16")},
		},
		Subnets: []*armnetwork.Subnet{
			{
				Name: to.Ptr("test-1"),
				Properties: &armnetwork.SubnetPropertiesFormat{
					AddressPrefix: to.Ptr("10.0.0.0/24"),
					Delegations: []*armnetwork.Delegation{
						{
							Name: to.Ptr("myDelegation"),
							Properties: &armnetwork.ServiceDelegationPropertiesFormat{
								ServiceName: to.Ptr("Microsoft.Sql/managedInstances"),
							},
						}},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateVirtualNetworkWithEncryption)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkCreateWithEncryption.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-vnet", armnetwork.VirtualNetwork{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.VirtualNetworkPropertiesFormat{
		AddressSpace: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("10.0.0.0/16")},
		},
		Encryption: &armnetwork.VirtualNetworkEncryption{
			Enabled:     to.Ptr(true),
			Enforcement: to.Ptr(armnetwork.VirtualNetworkEncryptionEnforcementAllowUnencrypted),
		},
		Subnets: []*armnetwork.Subnet{
			{
				Name: to.Ptr("test-1"),
				Properties: &armnetwork.SubnetPropertiesFormat{
					AddressPrefix: to.Ptr("10.0.0.0/24"),
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateVirtualNetworkWithServiceEndpoints)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkCreateServiceEndpoints.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "vnetTest", "vnet1", armnetwork.VirtualNetwork{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.VirtualNetworkPropertiesFormat{
		AddressSpace: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("10.0.0.0/16")},
		},
		Subnets: []*armnetwork.Subnet{
			{
				Name: to.Ptr("test-1"),
				Properties: &armnetwork.SubnetPropertiesFormat{
					AddressPrefix: to.Ptr("10.0.0.0/16"),
					ServiceEndpoints: []*armnetwork.ServiceEndpointPropertiesFormat{
						{
							Service: to.Ptr("Microsoft.Storage"),
						}},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateVirtualNetworkWithServiceEndpointsAndServiceEndpointPolicy)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "vnetTest", "vnet1", armnetwork.VirtualNetwork{
	Location: to.Ptr("eastus2euap"),
	Properties: &armnetwork.VirtualNetworkPropertiesFormat{
		AddressSpace: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("10.0.0.0/16")},
		},
		Subnets: []*armnetwork.Subnet{
			{
				Name: to.Ptr("test-1"),
				Properties: &armnetwork.SubnetPropertiesFormat{
					AddressPrefix: to.Ptr("10.0.0.0/16"),
					ServiceEndpointPolicies: []*armnetwork.ServiceEndpointPolicy{
						{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1"),
						}},
					ServiceEndpoints: []*armnetwork.ServiceEndpointPropertiesFormat{
						{
							Service: to.Ptr("Microsoft.Storage"),
						}},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateVirtualNetworkWithSubnet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkCreateSubnet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-vnet", armnetwork.VirtualNetwork{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.VirtualNetworkPropertiesFormat{
		AddressSpace: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("10.0.0.0/16")},
		},
		Subnets: []*armnetwork.Subnet{
			{
				Name: to.Ptr("test-1"),
				Properties: &armnetwork.SubnetPropertiesFormat{
					AddressPrefix: to.Ptr("10.0.0.0/24"),
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (CreateVirtualNetworkWithSubnetContainingAddressPrefixes)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "test-vnet", armnetwork.VirtualNetwork{
	Location: to.Ptr("eastus"),
	Properties: &armnetwork.VirtualNetworkPropertiesFormat{
		AddressSpace: &armnetwork.AddressSpace{
			AddressPrefixes: []*string{
				to.Ptr("10.0.0.0/16")},
		},
		Subnets: []*armnetwork.Subnet{
			{
				Name: to.Ptr("test-2"),
				Properties: &armnetwork.SubnetPropertiesFormat{
					AddressPrefixes: []*string{
						to.Ptr("10.0.0.0/28"),
						to.Ptr("10.0.1.0/28")},
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworksClient) BeginDelete

func (client *VirtualNetworksClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualNetworkName string, options *VirtualNetworksClientBeginDeleteOptions) (*runtime.Poller[VirtualNetworksClientDeleteResponse], error)

BeginDelete - Deletes the specified virtual network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "test-vnet", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*VirtualNetworksClient) BeginListDdosProtectionStatus

BeginListDdosProtectionStatus - Gets the Ddos Protection Status of all IP Addresses under the Virtual Network Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. virtualNetworkName - The name of the virtual network. options - VirtualNetworksClientBeginListDdosProtectionStatusOptions contains the optional parameters for the VirtualNetworksClient.BeginListDdosProtectionStatus method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGetDdosProtectionStatus.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListDdosProtectionStatus(ctx, "rg1", "test-vnet", &armnetwork.VirtualNetworksClientBeginListDdosProtectionStatusOptions{Top: to.Ptr[int32](75),
	SkipToken: nil,
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
for res.More() {
	nextResult, err := res.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkCheckIPAddressAvailability.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CheckIPAddressAvailability(ctx, "rg1", "test-vnet", "10.0.1.4", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
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. Generated from API version 2022-05-01 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 (GetVirtualNetwork)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "test-vnet", &armnetwork.VirtualNetworksClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

Example (GetVirtualNetworkWithADelegatedSubnet)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkGetWithSubnetDelegation.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subId", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "test-vnet", &armnetwork.VirtualNetworksClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualNetworksClient) NewListAllPager

NewListAllPager - Gets all virtual networks in a subscription. Generated from API version 2022-05-01 options - VirtualNetworksClientListAllOptions contains the optional parameters for the VirtualNetworksClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualNetworksClient) NewListPager

NewListPager - Gets all virtual networks in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - VirtualNetworksClientListOptions contains the optional parameters for the VirtualNetworksClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualNetworksClient) NewListUsagePager

func (client *VirtualNetworksClient) NewListUsagePager(resourceGroupName string, virtualNetworkName string, options *VirtualNetworksClientListUsageOptions) *runtime.Pager[VirtualNetworksClientListUsageResponse]

NewListUsagePager - Lists usage stats. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkListUsage.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListUsagePager("rg1", "vnetName", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualNetworkUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualNetworksClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "test-vnet", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VirtualNetworksClientBeginCreateOrUpdateOptions

type VirtualNetworksClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworksClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualNetworksClient.BeginCreateOrUpdate method.

type VirtualNetworksClientBeginDeleteOptions

type VirtualNetworksClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualNetworksClientBeginDeleteOptions contains the optional parameters for the VirtualNetworksClient.BeginDelete method.

type VirtualNetworksClientBeginListDdosProtectionStatusOptions

type VirtualNetworksClientBeginListDdosProtectionStatusOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
	// The skipToken that is given with nextLink.
	SkipToken *string
	// The max number of ip addresses to return.
	Top *int32
}

VirtualNetworksClientBeginListDdosProtectionStatusOptions contains the optional parameters for the VirtualNetworksClient.BeginListDdosProtectionStatus method.

type VirtualNetworksClientCheckIPAddressAvailabilityOptions

type VirtualNetworksClientCheckIPAddressAvailabilityOptions struct {
}

VirtualNetworksClientCheckIPAddressAvailabilityOptions contains the optional parameters for the VirtualNetworksClient.CheckIPAddressAvailability method.

type VirtualNetworksClientCheckIPAddressAvailabilityResponse

type VirtualNetworksClientCheckIPAddressAvailabilityResponse struct {
	IPAddressAvailabilityResult
}

VirtualNetworksClientCheckIPAddressAvailabilityResponse contains the response from method VirtualNetworksClient.CheckIPAddressAvailability.

type VirtualNetworksClientCreateOrUpdateResponse

type VirtualNetworksClientCreateOrUpdateResponse struct {
	VirtualNetwork
}

VirtualNetworksClientCreateOrUpdateResponse contains the response from method VirtualNetworksClient.CreateOrUpdate.

type VirtualNetworksClientDeleteResponse

type VirtualNetworksClientDeleteResponse struct {
}

VirtualNetworksClientDeleteResponse contains the response from method VirtualNetworksClient.Delete.

type VirtualNetworksClientGetOptions

type VirtualNetworksClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

VirtualNetworksClientGetOptions contains the optional parameters for the VirtualNetworksClient.Get method.

type VirtualNetworksClientGetResponse

type VirtualNetworksClientGetResponse struct {
	VirtualNetwork
}

VirtualNetworksClientGetResponse contains the response from method VirtualNetworksClient.Get.

type VirtualNetworksClientListAllOptions

type VirtualNetworksClientListAllOptions struct {
}

VirtualNetworksClientListAllOptions contains the optional parameters for the VirtualNetworksClient.ListAll method.

type VirtualNetworksClientListAllResponse

type VirtualNetworksClientListAllResponse struct {
	VirtualNetworkListResult
}

VirtualNetworksClientListAllResponse contains the response from method VirtualNetworksClient.ListAll.

type VirtualNetworksClientListDdosProtectionStatusResponse

type VirtualNetworksClientListDdosProtectionStatusResponse struct {
	VirtualNetworkDdosProtectionStatusResult
}

VirtualNetworksClientListDdosProtectionStatusResponse contains the response from method VirtualNetworksClient.ListDdosProtectionStatus.

type VirtualNetworksClientListOptions

type VirtualNetworksClientListOptions struct {
}

VirtualNetworksClientListOptions contains the optional parameters for the VirtualNetworksClient.List method.

type VirtualNetworksClientListResponse

type VirtualNetworksClientListResponse struct {
	VirtualNetworkListResult
}

VirtualNetworksClientListResponse contains the response from method VirtualNetworksClient.List.

type VirtualNetworksClientListUsageOptions

type VirtualNetworksClientListUsageOptions struct {
}

VirtualNetworksClientListUsageOptions contains the optional parameters for the VirtualNetworksClient.ListUsage method.

type VirtualNetworksClientListUsageResponse

type VirtualNetworksClientListUsageResponse struct {
	VirtualNetworkListUsageResult
}

VirtualNetworksClientListUsageResponse contains the response from method VirtualNetworksClient.ListUsage.

type VirtualNetworksClientUpdateTagsOptions

type VirtualNetworksClientUpdateTagsOptions struct {
}

VirtualNetworksClientUpdateTagsOptions contains the optional parameters for the VirtualNetworksClient.UpdateTags method.

type VirtualNetworksClientUpdateTagsResponse

type VirtualNetworksClientUpdateTagsResponse struct {
	VirtualNetwork
}

VirtualNetworksClientUpdateTagsResponse contains the response 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.

func (*VirtualRouter) UnmarshalJSON

func (v *VirtualRouter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualRouter.

type VirtualRouterAutoScaleConfiguration

type VirtualRouterAutoScaleConfiguration struct {
	// The minimum number of scale units for VirtualHub Router.
	MinCapacity *int32 `json:"minCapacity,omitempty"`
}

VirtualRouterAutoScaleConfiguration - The VirtualHub Router autoscale configuration.

func (VirtualRouterAutoScaleConfiguration) MarshalJSON

func (v VirtualRouterAutoScaleConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualRouterAutoScaleConfiguration.

func (*VirtualRouterAutoScaleConfiguration) UnmarshalJSON

func (v *VirtualRouterAutoScaleConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualRouterAutoScaleConfiguration.

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.

func (*VirtualRouterListResult) UnmarshalJSON

func (v *VirtualRouterListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualRouterPeering) MarshalJSON

func (v VirtualRouterPeering) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualRouterPeering.

func (*VirtualRouterPeering) UnmarshalJSON

func (v *VirtualRouterPeering) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualRouterPeering.

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.

func (*VirtualRouterPeeringListResult) UnmarshalJSON

func (v *VirtualRouterPeeringListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualRouterPeeringProperties) MarshalJSON

func (v VirtualRouterPeeringProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualRouterPeeringProperties.

func (*VirtualRouterPeeringProperties) UnmarshalJSON

func (v *VirtualRouterPeeringProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualRouterPeeringProperties.

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, error)

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

BeginCreateOrUpdate - Creates or updates the specified Virtual Router Peering. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterPeeringPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualRouterPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "virtualRouter", "peering1", armnetwork.VirtualRouterPeering{
	Properties: &armnetwork.VirtualRouterPeeringProperties{
		PeerAsn: to.Ptr[int64](20000),
		PeerIP:  to.Ptr("192.168.1.5"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualRouterPeeringsClient) BeginDelete

func (client *VirtualRouterPeeringsClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualRouterName string, peeringName string, options *VirtualRouterPeeringsClientBeginDeleteOptions) (*runtime.Poller[VirtualRouterPeeringsClientDeleteResponse], error)

BeginDelete - Deletes the specified peering from a Virtual Router. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterPeeringDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualRouterPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "virtualRouter", "peering1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterPeeringGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualRouterPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "virtualRouter", "peering1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualRouterPeeringsClient) NewListPager

func (client *VirtualRouterPeeringsClient) NewListPager(resourceGroupName string, virtualRouterName string, options *VirtualRouterPeeringsClientListOptions) *runtime.Pager[VirtualRouterPeeringsClientListResponse]

NewListPager - Lists all Virtual Router Peerings in a Virtual Router resource. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterPeeringList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualRouterPeeringsClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", "virtualRouter", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VirtualRouterPeeringsClientBeginCreateOrUpdateOptions

type VirtualRouterPeeringsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualRouterPeeringsClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualRouterPeeringsClient.BeginCreateOrUpdate method.

type VirtualRouterPeeringsClientBeginDeleteOptions

type VirtualRouterPeeringsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualRouterPeeringsClientBeginDeleteOptions contains the optional parameters for the VirtualRouterPeeringsClient.BeginDelete method.

type VirtualRouterPeeringsClientCreateOrUpdateResponse

type VirtualRouterPeeringsClientCreateOrUpdateResponse struct {
	VirtualRouterPeering
}

VirtualRouterPeeringsClientCreateOrUpdateResponse contains the response from method VirtualRouterPeeringsClient.CreateOrUpdate.

type VirtualRouterPeeringsClientDeleteResponse

type VirtualRouterPeeringsClientDeleteResponse struct {
}

VirtualRouterPeeringsClientDeleteResponse contains the response from method VirtualRouterPeeringsClient.Delete.

type VirtualRouterPeeringsClientGetOptions

type VirtualRouterPeeringsClientGetOptions struct {
}

VirtualRouterPeeringsClientGetOptions contains the optional parameters for the VirtualRouterPeeringsClient.Get method.

type VirtualRouterPeeringsClientGetResponse

type VirtualRouterPeeringsClientGetResponse struct {
	VirtualRouterPeering
}

VirtualRouterPeeringsClientGetResponse contains the response from method VirtualRouterPeeringsClient.Get.

type VirtualRouterPeeringsClientListOptions

type VirtualRouterPeeringsClientListOptions struct {
}

VirtualRouterPeeringsClientListOptions contains the optional parameters for the VirtualRouterPeeringsClient.List method.

type VirtualRouterPeeringsClientListResponse

type VirtualRouterPeeringsClientListResponse struct {
	VirtualRouterPeeringListResult
}

VirtualRouterPeeringsClientListResponse contains the response 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.

func (*VirtualRouterPropertiesFormat) UnmarshalJSON

func (v *VirtualRouterPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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, error)

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) (*runtime.Poller[VirtualRoutersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates the specified Virtual Router. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualRoutersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "virtualRouter", armnetwork.VirtualRouter{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.VirtualRouterPropertiesFormat{
		HostedGateway: &armnetwork.SubResource{
			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway"),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualRoutersClient) BeginDelete

func (client *VirtualRoutersClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualRouterName string, options *VirtualRoutersClientBeginDeleteOptions) (*runtime.Poller[VirtualRoutersClientDeleteResponse], error)

BeginDelete - Deletes the specified Virtual Router. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualRoutersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "virtualRouter", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualRoutersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "virtualRouter", &armnetwork.VirtualRoutersClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualRoutersClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all Virtual Routers in a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - VirtualRoutersClientListByResourceGroupOptions contains the optional parameters for the VirtualRoutersClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualRoutersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualRoutersClient) NewListPager

NewListPager - Gets all the Virtual Routers in a subscription. Generated from API version 2022-05-01 options - VirtualRoutersClientListOptions contains the optional parameters for the VirtualRoutersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualRouterListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualRoutersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type VirtualRoutersClientBeginCreateOrUpdateOptions

type VirtualRoutersClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualRoutersClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualRoutersClient.BeginCreateOrUpdate method.

type VirtualRoutersClientBeginDeleteOptions

type VirtualRoutersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualRoutersClientBeginDeleteOptions contains the optional parameters for the VirtualRoutersClient.BeginDelete method.

type VirtualRoutersClientCreateOrUpdateResponse

type VirtualRoutersClientCreateOrUpdateResponse struct {
	VirtualRouter
}

VirtualRoutersClientCreateOrUpdateResponse contains the response from method VirtualRoutersClient.CreateOrUpdate.

type VirtualRoutersClientDeleteResponse

type VirtualRoutersClientDeleteResponse struct {
}

VirtualRoutersClientDeleteResponse contains the response from method VirtualRoutersClient.Delete.

type VirtualRoutersClientGetOptions

type VirtualRoutersClientGetOptions struct {
	// Expands referenced resources.
	Expand *string
}

VirtualRoutersClientGetOptions contains the optional parameters for the VirtualRoutersClient.Get method.

type VirtualRoutersClientGetResponse

type VirtualRoutersClientGetResponse struct {
	VirtualRouter
}

VirtualRoutersClientGetResponse contains the response from method VirtualRoutersClient.Get.

type VirtualRoutersClientListByResourceGroupOptions

type VirtualRoutersClientListByResourceGroupOptions struct {
}

VirtualRoutersClientListByResourceGroupOptions contains the optional parameters for the VirtualRoutersClient.ListByResourceGroup method.

type VirtualRoutersClientListByResourceGroupResponse

type VirtualRoutersClientListByResourceGroupResponse struct {
	VirtualRouterListResult
}

VirtualRoutersClientListByResourceGroupResponse contains the response from method VirtualRoutersClient.ListByResourceGroup.

type VirtualRoutersClientListOptions

type VirtualRoutersClientListOptions struct {
}

VirtualRoutersClientListOptions contains the optional parameters for the VirtualRoutersClient.List method.

type VirtualRoutersClientListResponse

type VirtualRoutersClientListResponse struct {
	VirtualRouterListResult
}

VirtualRoutersClientListResponse contains the response 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.

func (*VirtualWAN) UnmarshalJSON

func (v *VirtualWAN) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*VirtualWanProperties) UnmarshalJSON

func (v *VirtualWanProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualWanSecurityProvider) MarshalJSON

func (v VirtualWanSecurityProvider) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualWanSecurityProvider.

func (*VirtualWanSecurityProvider) UnmarshalJSON

func (v *VirtualWanSecurityProvider) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualWanSecurityProvider.

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.

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.

func (*VirtualWanSecurityProviders) UnmarshalJSON

func (v *VirtualWanSecurityProviders) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (VirtualWanVPNProfileParameters) MarshalJSON

func (v VirtualWanVPNProfileParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualWanVPNProfileParameters.

func (*VirtualWanVPNProfileParameters) UnmarshalJSON

func (v *VirtualWanVPNProfileParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualWanVPNProfileParameters.

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, error)

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) (*runtime.Poller[VirtualWansClientCreateOrUpdateResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualWANPut.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualWansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCreateOrUpdate(ctx, "rg1", "wan1", armnetwork.VirtualWAN{
	Location: to.Ptr("West US"),
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
	},
	Properties: &armnetwork.VirtualWanProperties{
		Type:                 to.Ptr("Basic"),
		DisableVPNEncryption: to.Ptr(false),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualWansClient) BeginDelete

func (client *VirtualWansClient) BeginDelete(ctx context.Context, resourceGroupName string, virtualWANName string, options *VirtualWansClientBeginDeleteOptions) (*runtime.Poller[VirtualWansClientDeleteResponse], error)

BeginDelete - Deletes a VirtualWAN. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualWANDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualWansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "virtualWan1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualWANGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualWansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "wan1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*VirtualWansClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all the VirtualWANs in a resource group. Generated from API version 2022-05-01 resourceGroupName - The resource group name of the VirtualWan. options - VirtualWansClientListByResourceGroupOptions contains the optional parameters for the VirtualWansClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualWANListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualWansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*VirtualWansClient) NewListPager

NewListPager - Lists all the VirtualWANs in a subscription. Generated from API version 2022-05-01 options - VirtualWansClientListOptions contains the optional parameters for the VirtualWansClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualWANList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualWansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/VirtualWANUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewVirtualWansClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "wan1", armnetwork.TagsObject{
	Tags: map[string]*string{
		"key1": to.Ptr("value1"),
		"key2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type VirtualWansClientBeginCreateOrUpdateOptions

type VirtualWansClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualWansClientBeginCreateOrUpdateOptions contains the optional parameters for the VirtualWansClient.BeginCreateOrUpdate method.

type VirtualWansClientBeginDeleteOptions

type VirtualWansClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

VirtualWansClientBeginDeleteOptions contains the optional parameters for the VirtualWansClient.BeginDelete method.

type VirtualWansClientCreateOrUpdateResponse

type VirtualWansClientCreateOrUpdateResponse struct {
	VirtualWAN
}

VirtualWansClientCreateOrUpdateResponse contains the response from method VirtualWansClient.CreateOrUpdate.

type VirtualWansClientDeleteResponse

type VirtualWansClientDeleteResponse struct {
}

VirtualWansClientDeleteResponse contains the response from method VirtualWansClient.Delete.

type VirtualWansClientGetOptions

type VirtualWansClientGetOptions struct {
}

VirtualWansClientGetOptions contains the optional parameters for the VirtualWansClient.Get method.

type VirtualWansClientGetResponse

type VirtualWansClientGetResponse struct {
	VirtualWAN
}

VirtualWansClientGetResponse contains the response from method VirtualWansClient.Get.

type VirtualWansClientListByResourceGroupOptions

type VirtualWansClientListByResourceGroupOptions struct {
}

VirtualWansClientListByResourceGroupOptions contains the optional parameters for the VirtualWansClient.ListByResourceGroup method.

type VirtualWansClientListByResourceGroupResponse

type VirtualWansClientListByResourceGroupResponse struct {
	ListVirtualWANsResult
}

VirtualWansClientListByResourceGroupResponse contains the response from method VirtualWansClient.ListByResourceGroup.

type VirtualWansClientListOptions

type VirtualWansClientListOptions struct {
}

VirtualWansClientListOptions contains the optional parameters for the VirtualWansClient.List method.

type VirtualWansClientListResponse

type VirtualWansClientListResponse struct {
	ListVirtualWANsResult
}

VirtualWansClientListResponse contains the response from method VirtualWansClient.List.

type VirtualWansClientUpdateTagsOptions

type VirtualWansClientUpdateTagsOptions struct {
}

VirtualWansClientUpdateTagsOptions contains the optional parameters for the VirtualWansClient.UpdateTags method.

type VirtualWansClientUpdateTagsResponse

type VirtualWansClientUpdateTagsResponse struct {
	VirtualWAN
}

VirtualWansClientUpdateTagsResponse contains the response from method VirtualWansClient.UpdateTags.

type VnetLocalRouteOverrideCriteria

type VnetLocalRouteOverrideCriteria string

VnetLocalRouteOverrideCriteria - Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet.

const (
	VnetLocalRouteOverrideCriteriaContains VnetLocalRouteOverrideCriteria = "Contains"
	VnetLocalRouteOverrideCriteriaEqual    VnetLocalRouteOverrideCriteria = "Equal"
)

func PossibleVnetLocalRouteOverrideCriteriaValues

func PossibleVnetLocalRouteOverrideCriteriaValues() []VnetLocalRouteOverrideCriteria

PossibleVnetLocalRouteOverrideCriteriaValues returns the possible values for the VnetLocalRouteOverrideCriteria const type.

type VnetRoute

type VnetRoute struct {
	// List of all Static Routes.
	StaticRoutes []*StaticRoute `json:"staticRoutes,omitempty"`

	// Configuration for static routes on this HubVnetConnection.
	StaticRoutesConfig *StaticRoutesConfig `json:"staticRoutesConfig,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.

func (*VnetRoute) UnmarshalJSON

func (v *VnetRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VnetRoute.

type VngClientConnectionConfiguration

type VngClientConnectionConfiguration 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 root certificate.
	Properties *VngClientConnectionConfigurationProperties `json:"properties,omitempty"`

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

VngClientConnectionConfiguration - A vpn client connection configuration for client connection configuration.

func (VngClientConnectionConfiguration) MarshalJSON

func (v VngClientConnectionConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VngClientConnectionConfiguration.

func (*VngClientConnectionConfiguration) UnmarshalJSON

func (v *VngClientConnectionConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VngClientConnectionConfiguration.

type VngClientConnectionConfigurationProperties

type VngClientConnectionConfigurationProperties struct {
	// REQUIRED; The reference to the address space resource which represents Address space for P2S VpnClient.
	VPNClientAddressPool *AddressSpace `json:"vpnClientAddressPool,omitempty"`

	// REQUIRED; List of references to virtualNetworkGatewayPolicyGroups
	VirtualNetworkGatewayPolicyGroups []*SubResource `json:"virtualNetworkGatewayPolicyGroups,omitempty"`

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

VngClientConnectionConfigurationProperties - Properties of VngClientConnectionConfiguration.

func (VngClientConnectionConfigurationProperties) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type VngClientConnectionConfigurationProperties.

func (*VngClientConnectionConfigurationProperties) UnmarshalJSON

func (v *VngClientConnectionConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VngClientConnectionConfigurationProperties.

type Watcher

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

func (w Watcher) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Watcher.

func (*Watcher) UnmarshalJSON

func (w *Watcher) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Watcher.

type WatcherListResult

type WatcherListResult struct {
	// List of network watcher resources.
	Value []*Watcher `json:"value,omitempty"`
}

WatcherListResult - Response for ListNetworkWatchers API service call.

func (WatcherListResult) MarshalJSON

func (w WatcherListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WatcherListResult.

func (*WatcherListResult) UnmarshalJSON

func (w *WatcherListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WatcherListResult.

type WatcherPropertiesFormat

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.

func (WatcherPropertiesFormat) MarshalJSON

func (w WatcherPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WatcherPropertiesFormat.

func (*WatcherPropertiesFormat) UnmarshalJSON

func (w *WatcherPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WatcherPropertiesFormat.

type WatchersClient

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

func NewWatchersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WatchersClient, error)

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

func (client *WatchersClient) BeginCheckConnectivity(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters ConnectivityParameters, options *WatchersClientBeginCheckConnectivityOptions) (*runtime.Poller[WatchersClientCheckConnectivityResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherConnectivityCheck.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginCheckConnectivity(ctx, "rg1", "nw1", armnetwork.ConnectivityParameters{
	Destination: &armnetwork.ConnectivityDestination{
		Address: to.Ptr("192.168.100.4"),
		Port:    to.Ptr[int32](3389),
	},
	PreferredIPVersion: to.Ptr(armnetwork.IPVersionIPv4),
	Source: &armnetwork.ConnectivitySource{
		ResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) BeginDelete

func (client *WatchersClient) BeginDelete(ctx context.Context, resourceGroupName string, networkWatcherName string, options *WatchersClientBeginDeleteOptions) (*runtime.Poller[WatchersClientDeleteResponse], error)

BeginDelete - Deletes the specified network watcher resource. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "nw1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*WatchersClient) BeginGetAzureReachabilityReport

func (client *WatchersClient) BeginGetAzureReachabilityReport(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters AzureReachabilityReportParameters, options *WatchersClientBeginGetAzureReachabilityReportOptions) (*runtime.Poller[WatchersClientGetAzureReachabilityReportResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherAzureReachabilityReportGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetAzureReachabilityReport(ctx, "rg1", "nw1", armnetwork.AzureReachabilityReportParameters{
	AzureLocations: []*string{
		to.Ptr("West US")},
	EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-10T00:00:00Z"); return t }()),
	ProviderLocation: &armnetwork.AzureReachabilityReportLocation{
		Country: to.Ptr("United States"),
		State:   to.Ptr("washington"),
	},
	Providers: []*string{
		to.Ptr("Frontier Communications of America, Inc. - ASN 5650")},
	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-09-07T00:00:00Z"); return t }()),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) BeginGetFlowLogStatus

func (client *WatchersClient) BeginGetFlowLogStatus(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters FlowLogStatusParameters, options *WatchersClientBeginGetFlowLogStatusOptions) (*runtime.Poller[WatchersClientGetFlowLogStatusResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherFlowLogStatusQuery.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetFlowLogStatus(ctx, "rg1", "nw1", armnetwork.FlowLogStatusParameters{
	TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) BeginGetNetworkConfigurationDiagnostic

func (client *WatchersClient) BeginGetNetworkConfigurationDiagnostic(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters ConfigurationDiagnosticParameters, options *WatchersClientBeginGetNetworkConfigurationDiagnosticOptions) (*runtime.Poller[WatchersClientGetNetworkConfigurationDiagnosticResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetNetworkConfigurationDiagnostic(ctx, "rg1", "nw1", armnetwork.ConfigurationDiagnosticParameters{
	Profiles: []*armnetwork.ConfigurationDiagnosticProfile{
		{
			Destination:     to.Ptr("12.11.12.14"),
			DestinationPort: to.Ptr("12100"),
			Direction:       to.Ptr(armnetwork.DirectionInbound),
			Source:          to.Ptr("10.1.0.4"),
			Protocol:        to.Ptr("TCP"),
		}},
	TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) BeginGetNextHop

func (client *WatchersClient) BeginGetNextHop(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters NextHopParameters, options *WatchersClientBeginGetNextHopOptions) (*runtime.Poller[WatchersClientGetNextHopResponse], error)

BeginGetNextHop - Gets the next hop from the specified VM. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherNextHopGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetNextHop(ctx, "rg1", "nw1", armnetwork.NextHopParameters{
	DestinationIPAddress: to.Ptr("10.0.0.10"),
	SourceIPAddress:      to.Ptr("10.0.0.5"),
	TargetNicResourceID:  to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1"),
	TargetResourceID:     to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) BeginGetTroubleshooting

func (client *WatchersClient) BeginGetTroubleshooting(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters TroubleshootingParameters, options *WatchersClientBeginGetTroubleshootingOptions) (*runtime.Poller[WatchersClientGetTroubleshootingResponse], error)

BeginGetTroubleshooting - Initiate troubleshooting on a specified resource. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherTroubleshootGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetTroubleshooting(ctx, "rg1", "nw1", armnetwork.TroubleshootingParameters{
	Properties: &armnetwork.TroubleshootingProperties{
		StorageID:   to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1"),
		StoragePath: to.Ptr("https://st1.blob.core.windows.net/cn1"),
	},
	TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) BeginGetTroubleshootingResult

func (client *WatchersClient) BeginGetTroubleshootingResult(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters QueryTroubleshootingParameters, options *WatchersClientBeginGetTroubleshootingResultOptions) (*runtime.Poller[WatchersClientGetTroubleshootingResultResponse], error)

BeginGetTroubleshootingResult - Get the last completed troubleshooting result on a specified resource. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherTroubleshootResultQuery.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetTroubleshootingResult(ctx, "rg1", "nw1", armnetwork.QueryTroubleshootingParameters{
	TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) BeginGetVMSecurityRules

func (client *WatchersClient) BeginGetVMSecurityRules(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters SecurityGroupViewParameters, options *WatchersClientBeginGetVMSecurityRulesOptions) (*runtime.Poller[WatchersClientGetVMSecurityRulesResponse], error)

BeginGetVMSecurityRules - Gets the configured and effective security group rules on the specified VM. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherSecurityGroupViewGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginGetVMSecurityRules(ctx, "rg1", "nw1", armnetwork.SecurityGroupViewParameters{
	TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) BeginListAvailableProviders

func (client *WatchersClient) BeginListAvailableProviders(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters AvailableProvidersListParameters, options *WatchersClientBeginListAvailableProvidersOptions) (*runtime.Poller[WatchersClientListAvailableProvidersResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherAvailableProvidersListGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginListAvailableProviders(ctx, "rg1", "nw1", armnetwork.AvailableProvidersListParameters{
	AzureLocations: []*string{
		to.Ptr("West US")},
	City:    to.Ptr("seattle"),
	Country: to.Ptr("United States"),
	State:   to.Ptr("washington"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) BeginSetFlowLogConfiguration

func (client *WatchersClient) BeginSetFlowLogConfiguration(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters FlowLogInformation, options *WatchersClientBeginSetFlowLogConfigurationOptions) (*runtime.Poller[WatchersClientSetFlowLogConfigurationResponse], error)

BeginSetFlowLogConfiguration - Configures flow log and traffic analytics (optional) on a specified resource. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherFlowLogConfigure.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginSetFlowLogConfiguration(ctx, "rg1", "nw1", armnetwork.FlowLogInformation{
	Properties: &armnetwork.FlowLogProperties{
		Enabled:   to.Ptr(true),
		StorageID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1"),
	},
	TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) BeginVerifyIPFlow

func (client *WatchersClient) BeginVerifyIPFlow(ctx context.Context, resourceGroupName string, networkWatcherName string, parameters VerificationIPFlowParameters, options *WatchersClientBeginVerifyIPFlowOptions) (*runtime.Poller[WatchersClientVerifyIPFlowResponse], 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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherIpFlowVerify.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginVerifyIPFlow(ctx, "rg1", "nw1", armnetwork.VerificationIPFlowParameters{
	Direction:        to.Ptr(armnetwork.DirectionOutbound),
	LocalIPAddress:   to.Ptr("10.2.0.4"),
	LocalPort:        to.Ptr("80"),
	RemoteIPAddress:  to.Ptr("121.10.1.1"),
	RemotePort:       to.Ptr("80"),
	TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
	Protocol:         to.Ptr(armnetwork.IPFlowProtocolTCP),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) CreateOrUpdate

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "nw1", armnetwork.Watcher{
	Location:   to.Ptr("eastus"),
	Properties: &armnetwork.WatcherPropertiesFormat{},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) Get

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "nw1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) GetTopology

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherTopologyGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.GetTopology(ctx, "rg1", "nw1", armnetwork.TopologyParameters{
	TargetResourceGroupName: to.Ptr("rg2"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WatchersClient) NewListAllPager

NewListAllPager - Gets all network watchers by subscription. Generated from API version 2022-05-01 options - WatchersClientListAllOptions contains the optional parameters for the WatchersClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherListAll.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*WatchersClient) NewListPager

func (client *WatchersClient) NewListPager(resourceGroupName string, options *WatchersClientListOptions) *runtime.Pager[WatchersClientListResponse]

NewListPager - Gets all network watchers by resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - WatchersClientListOptions contains the optional parameters for the WatchersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*WatchersClient) UpdateTags

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. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/NetworkWatcherUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWatchersClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.UpdateTags(ctx, "rg1", "nw1", armnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

type WatchersClientBeginCheckConnectivityOptions

type WatchersClientBeginCheckConnectivityOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginCheckConnectivityOptions contains the optional parameters for the WatchersClient.BeginCheckConnectivity method.

type WatchersClientBeginDeleteOptions

type WatchersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginDeleteOptions contains the optional parameters for the WatchersClient.BeginDelete method.

type WatchersClientBeginGetAzureReachabilityReportOptions

type WatchersClientBeginGetAzureReachabilityReportOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginGetAzureReachabilityReportOptions contains the optional parameters for the WatchersClient.BeginGetAzureReachabilityReport method.

type WatchersClientBeginGetFlowLogStatusOptions

type WatchersClientBeginGetFlowLogStatusOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginGetFlowLogStatusOptions contains the optional parameters for the WatchersClient.BeginGetFlowLogStatus method.

type WatchersClientBeginGetNetworkConfigurationDiagnosticOptions

type WatchersClientBeginGetNetworkConfigurationDiagnosticOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginGetNetworkConfigurationDiagnosticOptions contains the optional parameters for the WatchersClient.BeginGetNetworkConfigurationDiagnostic method.

type WatchersClientBeginGetNextHopOptions

type WatchersClientBeginGetNextHopOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginGetNextHopOptions contains the optional parameters for the WatchersClient.BeginGetNextHop method.

type WatchersClientBeginGetTroubleshootingOptions

type WatchersClientBeginGetTroubleshootingOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginGetTroubleshootingOptions contains the optional parameters for the WatchersClient.BeginGetTroubleshooting method.

type WatchersClientBeginGetTroubleshootingResultOptions

type WatchersClientBeginGetTroubleshootingResultOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginGetTroubleshootingResultOptions contains the optional parameters for the WatchersClient.BeginGetTroubleshootingResult method.

type WatchersClientBeginGetVMSecurityRulesOptions

type WatchersClientBeginGetVMSecurityRulesOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginGetVMSecurityRulesOptions contains the optional parameters for the WatchersClient.BeginGetVMSecurityRules method.

type WatchersClientBeginListAvailableProvidersOptions

type WatchersClientBeginListAvailableProvidersOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginListAvailableProvidersOptions contains the optional parameters for the WatchersClient.BeginListAvailableProviders method.

type WatchersClientBeginSetFlowLogConfigurationOptions

type WatchersClientBeginSetFlowLogConfigurationOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginSetFlowLogConfigurationOptions contains the optional parameters for the WatchersClient.BeginSetFlowLogConfiguration method.

type WatchersClientBeginVerifyIPFlowOptions

type WatchersClientBeginVerifyIPFlowOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WatchersClientBeginVerifyIPFlowOptions contains the optional parameters for the WatchersClient.BeginVerifyIPFlow method.

type WatchersClientCheckConnectivityResponse

type WatchersClientCheckConnectivityResponse struct {
	ConnectivityInformation
}

WatchersClientCheckConnectivityResponse contains the response from method WatchersClient.CheckConnectivity.

type WatchersClientCreateOrUpdateOptions

type WatchersClientCreateOrUpdateOptions struct {
}

WatchersClientCreateOrUpdateOptions contains the optional parameters for the WatchersClient.CreateOrUpdate method.

type WatchersClientCreateOrUpdateResponse

type WatchersClientCreateOrUpdateResponse struct {
	Watcher
}

WatchersClientCreateOrUpdateResponse contains the response from method WatchersClient.CreateOrUpdate.

type WatchersClientDeleteResponse

type WatchersClientDeleteResponse struct {
}

WatchersClientDeleteResponse contains the response from method WatchersClient.Delete.

type WatchersClientGetAzureReachabilityReportResponse

type WatchersClientGetAzureReachabilityReportResponse struct {
	AzureReachabilityReport
}

WatchersClientGetAzureReachabilityReportResponse contains the response from method WatchersClient.GetAzureReachabilityReport.

type WatchersClientGetFlowLogStatusResponse

type WatchersClientGetFlowLogStatusResponse struct {
	FlowLogInformation
}

WatchersClientGetFlowLogStatusResponse contains the response from method WatchersClient.GetFlowLogStatus.

type WatchersClientGetNetworkConfigurationDiagnosticResponse

type WatchersClientGetNetworkConfigurationDiagnosticResponse struct {
	ConfigurationDiagnosticResponse
}

WatchersClientGetNetworkConfigurationDiagnosticResponse contains the response from method WatchersClient.GetNetworkConfigurationDiagnostic.

type WatchersClientGetNextHopResponse

type WatchersClientGetNextHopResponse struct {
	NextHopResult
}

WatchersClientGetNextHopResponse contains the response from method WatchersClient.GetNextHop.

type WatchersClientGetOptions

type WatchersClientGetOptions struct {
}

WatchersClientGetOptions contains the optional parameters for the WatchersClient.Get method.

type WatchersClientGetResponse

type WatchersClientGetResponse struct {
	Watcher
}

WatchersClientGetResponse contains the response from method WatchersClient.Get.

type WatchersClientGetTopologyOptions

type WatchersClientGetTopologyOptions struct {
}

WatchersClientGetTopologyOptions contains the optional parameters for the WatchersClient.GetTopology method.

type WatchersClientGetTopologyResponse

type WatchersClientGetTopologyResponse struct {
	Topology
}

WatchersClientGetTopologyResponse contains the response from method WatchersClient.GetTopology.

type WatchersClientGetTroubleshootingResponse

type WatchersClientGetTroubleshootingResponse struct {
	TroubleshootingResult
}

WatchersClientGetTroubleshootingResponse contains the response from method WatchersClient.GetTroubleshooting.

type WatchersClientGetTroubleshootingResultResponse

type WatchersClientGetTroubleshootingResultResponse struct {
	TroubleshootingResult
}

WatchersClientGetTroubleshootingResultResponse contains the response from method WatchersClient.GetTroubleshootingResult.

type WatchersClientGetVMSecurityRulesResponse

type WatchersClientGetVMSecurityRulesResponse struct {
	SecurityGroupViewResult
}

WatchersClientGetVMSecurityRulesResponse contains the response from method WatchersClient.GetVMSecurityRules.

type WatchersClientListAllOptions

type WatchersClientListAllOptions struct {
}

WatchersClientListAllOptions contains the optional parameters for the WatchersClient.ListAll method.

type WatchersClientListAllResponse

type WatchersClientListAllResponse struct {
	WatcherListResult
}

WatchersClientListAllResponse contains the response from method WatchersClient.ListAll.

type WatchersClientListAvailableProvidersResponse

type WatchersClientListAvailableProvidersResponse struct {
	AvailableProvidersList
}

WatchersClientListAvailableProvidersResponse contains the response from method WatchersClient.ListAvailableProviders.

type WatchersClientListOptions

type WatchersClientListOptions struct {
}

WatchersClientListOptions contains the optional parameters for the WatchersClient.List method.

type WatchersClientListResponse

type WatchersClientListResponse struct {
	WatcherListResult
}

WatchersClientListResponse contains the response from method WatchersClient.List.

type WatchersClientSetFlowLogConfigurationResponse

type WatchersClientSetFlowLogConfigurationResponse struct {
	FlowLogInformation
}

WatchersClientSetFlowLogConfigurationResponse contains the response from method WatchersClient.SetFlowLogConfiguration.

type WatchersClientUpdateTagsOptions

type WatchersClientUpdateTagsOptions struct {
}

WatchersClientUpdateTagsOptions contains the optional parameters for the WatchersClient.UpdateTags method.

type WatchersClientUpdateTagsResponse

type WatchersClientUpdateTagsResponse struct {
	Watcher
}

WatchersClientUpdateTagsResponse contains the response from method WatchersClient.UpdateTags.

type WatchersClientVerifyIPFlowResponse

type WatchersClientVerifyIPFlowResponse struct {
	VerificationIPFlowResult
}

WatchersClientVerifyIPFlowResponse contains the response 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.

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.

func (*WebApplicationFirewallCustomRule) UnmarshalJSON

func (w *WebApplicationFirewallCustomRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

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.

type WebApplicationFirewallOperator

type WebApplicationFirewallOperator string

WebApplicationFirewallOperator - The operator to be matched.

const (
	WebApplicationFirewallOperatorAny                WebApplicationFirewallOperator = "Any"
	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.

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, error)

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

BeginDelete - Deletes Policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/WafPolicyDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWebApplicationFirewallPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := client.BeginDelete(ctx, "rg1", "Policy1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*WebApplicationFirewallPoliciesClient) CreateOrUpdate

CreateOrUpdate - Creates or update policy with specified rule set name within a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/WafPolicyCreateOrUpdate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWebApplicationFirewallPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.CreateOrUpdate(ctx, "rg1", "Policy1", armnetwork.WebApplicationFirewallPolicy{
	Location: to.Ptr("WestUs"),
	Properties: &armnetwork.WebApplicationFirewallPolicyPropertiesFormat{
		CustomRules: []*armnetwork.WebApplicationFirewallCustomRule{
			{
				Name:   to.Ptr("Rule1"),
				Action: to.Ptr(armnetwork.WebApplicationFirewallActionBlock),
				MatchConditions: []*armnetwork.MatchCondition{
					{
						MatchValues: []*string{
							to.Ptr("192.168.1.0/24"),
							to.Ptr("10.0.0.0/24")},
						MatchVariables: []*armnetwork.MatchVariable{
							{
								VariableName: to.Ptr(armnetwork.WebApplicationFirewallMatchVariableRemoteAddr),
							}},
						Operator: to.Ptr(armnetwork.WebApplicationFirewallOperatorIPMatch),
					}},
				Priority: to.Ptr[int32](1),
				RuleType: to.Ptr(armnetwork.WebApplicationFirewallRuleTypeMatchRule),
			},
			{
				Name:   to.Ptr("Rule2"),
				Action: to.Ptr(armnetwork.WebApplicationFirewallActionBlock),
				MatchConditions: []*armnetwork.MatchCondition{
					{
						MatchValues: []*string{
							to.Ptr("192.168.1.0/24")},
						MatchVariables: []*armnetwork.MatchVariable{
							{
								VariableName: to.Ptr(armnetwork.WebApplicationFirewallMatchVariableRemoteAddr),
							}},
						Operator: to.Ptr(armnetwork.WebApplicationFirewallOperatorIPMatch),
					},
					{
						MatchValues: []*string{
							to.Ptr("Windows")},
						MatchVariables: []*armnetwork.MatchVariable{
							{
								Selector:     to.Ptr("UserAgent"),
								VariableName: to.Ptr(armnetwork.WebApplicationFirewallMatchVariableRequestHeaders),
							}},
						Operator: to.Ptr(armnetwork.WebApplicationFirewallOperatorContains),
					}},
				Priority: to.Ptr[int32](2),
				RuleType: to.Ptr(armnetwork.WebApplicationFirewallRuleTypeMatchRule),
			}},
		ManagedRules: &armnetwork.ManagedRulesDefinition{
			Exclusions: []*armnetwork.OwaspCrsExclusionEntry{
				{
					ExclusionManagedRuleSets: []*armnetwork.ExclusionManagedRuleSet{
						{
							RuleGroups: []*armnetwork.ExclusionManagedRuleGroup{
								{
									RuleGroupName: to.Ptr("REQUEST-930-APPLICATION-ATTACK-LFI"),
									Rules: []*armnetwork.ExclusionManagedRule{
										{
											RuleID: to.Ptr("930120"),
										}},
								},
								{
									RuleGroupName: to.Ptr("REQUEST-932-APPLICATION-ATTACK-RCE"),
								}},
							RuleSetType:    to.Ptr("OWASP"),
							RuleSetVersion: to.Ptr("3.2"),
						}},
					MatchVariable:         to.Ptr(armnetwork.OwaspCrsExclusionEntryMatchVariableRequestArgNames),
					Selector:              to.Ptr("hello"),
					SelectorMatchOperator: to.Ptr(armnetwork.OwaspCrsExclusionEntrySelectorMatchOperatorStartsWith),
				},
				{
					ExclusionManagedRuleSets: []*armnetwork.ExclusionManagedRuleSet{
						{
							RuleGroups:     []*armnetwork.ExclusionManagedRuleGroup{},
							RuleSetType:    to.Ptr("OWASP"),
							RuleSetVersion: to.Ptr("3.1"),
						}},
					MatchVariable:         to.Ptr(armnetwork.OwaspCrsExclusionEntryMatchVariableRequestArgNames),
					Selector:              to.Ptr("hello"),
					SelectorMatchOperator: to.Ptr(armnetwork.OwaspCrsExclusionEntrySelectorMatchOperatorEndsWith),
				},
				{
					MatchVariable:         to.Ptr(armnetwork.OwaspCrsExclusionEntryMatchVariableRequestArgNames),
					Selector:              to.Ptr("test"),
					SelectorMatchOperator: to.Ptr(armnetwork.OwaspCrsExclusionEntrySelectorMatchOperatorStartsWith),
				},
				{
					MatchVariable:         to.Ptr(armnetwork.OwaspCrsExclusionEntryMatchVariableRequestArgValues),
					Selector:              to.Ptr("test"),
					SelectorMatchOperator: to.Ptr(armnetwork.OwaspCrsExclusionEntrySelectorMatchOperatorStartsWith),
				}},
			ManagedRuleSets: []*armnetwork.ManagedRuleSet{
				{
					RuleGroupOverrides: []*armnetwork.ManagedRuleGroupOverride{
						{
							RuleGroupName: to.Ptr("REQUEST-931-APPLICATION-ATTACK-RFI"),
							Rules: []*armnetwork.ManagedRuleOverride{
								{
									Action: to.Ptr(armnetwork.ActionTypeLog),
									RuleID: to.Ptr("931120"),
									State:  to.Ptr(armnetwork.ManagedRuleEnabledStateEnabled),
								},
								{
									Action: to.Ptr(armnetwork.ActionTypeAnomalyScoring),
									RuleID: to.Ptr("931130"),
									State:  to.Ptr(armnetwork.ManagedRuleEnabledStateDisabled),
								}},
						}},
					RuleSetType:    to.Ptr("OWASP"),
					RuleSetVersion: to.Ptr("3.2"),
				}},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WebApplicationFirewallPoliciesClient) Get

Get - Retrieve protection policy with specified name within a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/WafPolicyGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWebApplicationFirewallPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "rg1", "Policy1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WebApplicationFirewallPoliciesClient) NewListAllPager

NewListAllPager - Gets all the WAF policies in a subscription. Generated from API version 2022-05-01 options - WebApplicationFirewallPoliciesClientListAllOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/WafListAllPolicies.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWebApplicationFirewallPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListAllPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

func (*WebApplicationFirewallPoliciesClient) NewListPager

NewListPager - Lists all of the protection policies within a resource group. Generated from API version 2022-05-01 resourceGroupName - The name of the resource group. options - WebApplicationFirewallPoliciesClientListOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/WafListPolicies.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWebApplicationFirewallPoliciesClient("subid", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListPager("rg1", nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type WebApplicationFirewallPoliciesClientBeginDeleteOptions

type WebApplicationFirewallPoliciesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WebApplicationFirewallPoliciesClientBeginDeleteOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.BeginDelete method.

type WebApplicationFirewallPoliciesClientCreateOrUpdateOptions

type WebApplicationFirewallPoliciesClientCreateOrUpdateOptions struct {
}

WebApplicationFirewallPoliciesClientCreateOrUpdateOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.CreateOrUpdate method.

type WebApplicationFirewallPoliciesClientCreateOrUpdateResponse

type WebApplicationFirewallPoliciesClientCreateOrUpdateResponse struct {
	WebApplicationFirewallPolicy
}

WebApplicationFirewallPoliciesClientCreateOrUpdateResponse contains the response from method WebApplicationFirewallPoliciesClient.CreateOrUpdate.

type WebApplicationFirewallPoliciesClientDeleteResponse

type WebApplicationFirewallPoliciesClientDeleteResponse struct {
}

WebApplicationFirewallPoliciesClientDeleteResponse contains the response from method WebApplicationFirewallPoliciesClient.Delete.

type WebApplicationFirewallPoliciesClientGetOptions

type WebApplicationFirewallPoliciesClientGetOptions struct {
}

WebApplicationFirewallPoliciesClientGetOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.Get method.

type WebApplicationFirewallPoliciesClientGetResponse

type WebApplicationFirewallPoliciesClientGetResponse struct {
	WebApplicationFirewallPolicy
}

WebApplicationFirewallPoliciesClientGetResponse contains the response from method WebApplicationFirewallPoliciesClient.Get.

type WebApplicationFirewallPoliciesClientListAllOptions

type WebApplicationFirewallPoliciesClientListAllOptions struct {
}

WebApplicationFirewallPoliciesClientListAllOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.ListAll method.

type WebApplicationFirewallPoliciesClientListAllResponse

type WebApplicationFirewallPoliciesClientListAllResponse struct {
	WebApplicationFirewallPolicyListResult
}

WebApplicationFirewallPoliciesClientListAllResponse contains the response from method WebApplicationFirewallPoliciesClient.ListAll.

type WebApplicationFirewallPoliciesClientListOptions

type WebApplicationFirewallPoliciesClientListOptions struct {
}

WebApplicationFirewallPoliciesClientListOptions contains the optional parameters for the WebApplicationFirewallPoliciesClient.List method.

type WebApplicationFirewallPoliciesClientListResponse

type WebApplicationFirewallPoliciesClientListResponse struct {
	WebApplicationFirewallPolicyListResult
}

WebApplicationFirewallPoliciesClientListResponse contains the response 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.

func (*WebApplicationFirewallPolicy) UnmarshalJSON

func (w *WebApplicationFirewallPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

func (*WebApplicationFirewallPolicyListResult) UnmarshalJSON

func (w *WebApplicationFirewallPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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

MarshalJSON implements the json.Marshaller interface for type WebApplicationFirewallPolicyPropertiesFormat.

func (*WebApplicationFirewallPolicyPropertiesFormat) UnmarshalJSON

func (w *WebApplicationFirewallPolicyPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller 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.

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.

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"
	WebApplicationFirewallTransformUppercase        WebApplicationFirewallTransform = "Uppercase"
)

func PossibleWebApplicationFirewallTransformValues

func PossibleWebApplicationFirewallTransformValues() []WebApplicationFirewallTransform

PossibleWebApplicationFirewallTransformValues returns the possible values for the WebApplicationFirewallTransform const type.

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, error)

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

Get - Gets the specified Azure Web Category. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-05-01 name - The name of the azureWebCategory. options - WebCategoriesClientGetOptions contains the optional parameters for the WebCategoriesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureWebCategoryGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWebCategoriesClient("4de8428a-4a92-4cea-90ff-b47128b8cab8", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := client.Get(ctx, "Arts", &armnetwork.WebCategoriesClientGetOptions{Expand: nil})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// TODO: use response item
_ = res
Output:

func (*WebCategoriesClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Gets all the Azure Web Categories in a subscription. Generated from API version 2022-05-01 options - WebCategoriesClientListBySubscriptionOptions contains the optional parameters for the WebCategoriesClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2022-05-01/examples/AzureWebCategoriesListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
client, err := armnetwork.NewWebCategoriesClient("4de8428a-4a92-4cea-90ff-b47128b8cab8", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := client.NewListBySubscriptionPager(nil)
for pager.More() {
	nextResult, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range nextResult.Value {
		// TODO: use page item
		_ = v
	}
}
Output:

type WebCategoriesClientGetOptions

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

type WebCategoriesClientGetResponse struct {
	AzureWebCategory
}

WebCategoriesClientGetResponse contains the response from method WebCategoriesClient.Get.

type WebCategoriesClientListBySubscriptionOptions

type WebCategoriesClientListBySubscriptionOptions struct {
}

WebCategoriesClientListBySubscriptionOptions contains the optional parameters for the WebCategoriesClient.ListBySubscription method.

type WebCategoriesClientListBySubscriptionResponse

type WebCategoriesClientListBySubscriptionResponse struct {
	AzureWebCategoryListResult
}

WebCategoriesClientListBySubscriptionResponse contains the response from method WebCategoriesClient.ListBySubscription.

Source Files

Jump to

Keyboard shortcuts

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