armnetwork

package
v0.1.1 Latest Latest
Warning

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

Go to latest
Published: Nov 28, 2023 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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 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 {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

	// 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 Backend Address Pool of an application gateway.
	Properties *ApplicationGatewayBackendAddressPoolPropertiesFormat `json:"properties,omitempty"`

	// Type of the resource.
	Type *string `json:"type,omitempty"`
}

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

	// Collection of references to IPs defined in network interfaces.
	BackendIPConfigurations []*InterfaceIPConfiguration `json:"backendIPConfigurations,omitempty"`

	// Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

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

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

type ApplicationSecurityGroupPropertiesFormat struct {
	// READ-ONLY; The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating',
	// 'Deleting', and 'Failed'.
	ProvisioningState *string `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 AuthenticationMethod

type AuthenticationMethod string

AuthenticationMethod - VPN client Authentication Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'.

const (
	AuthenticationMethodEAPMSCHAPv2 AuthenticationMethod = "EAPMSCHAPv2"
	AuthenticationMethodEAPTLS      AuthenticationMethod = "EAPTLS"
)

func PossibleAuthenticationMethodValues

func PossibleAuthenticationMethodValues() []AuthenticationMethod

PossibleAuthenticationMethodValues returns the possible values for the AuthenticationMethod 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 AzureAsyncOperationResult

type AzureAsyncOperationResult struct {
	Error *Error `json:"error,omitempty"`

	// Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and 'Failed'.
	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 BackendAddressPool

type BackendAddressPool struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

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

	// Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of load balancer backend address pool.
	Properties *BackendAddressPoolPropertiesFormat `json:"properties,omitempty"`
}

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 {
	// Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`

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

	// READ-ONLY; Gets load balancing rules that use this backend address pool.
	LoadBalancingRules []*SubResource `json:"loadBalancingRules,omitempty" azure:"ro"`

	// READ-ONLY; Gets outbound rules that use this backend address pool.
	OutboundRule *SubResource `json:"outboundRule,omitempty" azure:"ro"`

	// READ-ONLY; Gets outbound rules that use this backend address pool.
	OutboundRules []*SubResource `json:"outboundRules,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 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 *int32 `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 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"`

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

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

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • 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 (*ClientFactory) NewDefaultSecurityRulesClient

func (c *ClientFactory) NewDefaultSecurityRulesClient() *DefaultSecurityRulesClient

func (*ClientFactory) NewInboundNatRulesClient

func (c *ClientFactory) NewInboundNatRulesClient() *InboundNatRulesClient

func (*ClientFactory) NewInterfaceIPConfigurationsClient

func (c *ClientFactory) NewInterfaceIPConfigurationsClient() *InterfaceIPConfigurationsClient

func (*ClientFactory) NewInterfaceLoadBalancersClient

func (c *ClientFactory) NewInterfaceLoadBalancersClient() *InterfaceLoadBalancersClient

func (*ClientFactory) NewInterfaceTapConfigurationsClient

func (c *ClientFactory) NewInterfaceTapConfigurationsClient() *InterfaceTapConfigurationsClient

func (*ClientFactory) NewInterfacesClient

func (c *ClientFactory) NewInterfacesClient() *InterfacesClient

func (*ClientFactory) NewLoadBalancerBackendAddressPoolsClient

func (c *ClientFactory) NewLoadBalancerBackendAddressPoolsClient() *LoadBalancerBackendAddressPoolsClient

func (*ClientFactory) NewLoadBalancerFrontendIPConfigurationsClient

func (c *ClientFactory) NewLoadBalancerFrontendIPConfigurationsClient() *LoadBalancerFrontendIPConfigurationsClient

func (*ClientFactory) NewLoadBalancerLoadBalancingRulesClient

func (c *ClientFactory) NewLoadBalancerLoadBalancingRulesClient() *LoadBalancerLoadBalancingRulesClient

func (*ClientFactory) NewLoadBalancerNetworkInterfacesClient

func (c *ClientFactory) NewLoadBalancerNetworkInterfacesClient() *LoadBalancerNetworkInterfacesClient

func (*ClientFactory) NewLoadBalancerOutboundRulesClient

func (c *ClientFactory) NewLoadBalancerOutboundRulesClient() *LoadBalancerOutboundRulesClient

func (*ClientFactory) NewLoadBalancerProbesClient

func (c *ClientFactory) NewLoadBalancerProbesClient() *LoadBalancerProbesClient

func (*ClientFactory) NewLoadBalancersClient

func (c *ClientFactory) NewLoadBalancersClient() *LoadBalancersClient

func (*ClientFactory) NewLocalNetworkGatewaysClient

func (c *ClientFactory) NewLocalNetworkGatewaysClient() *LocalNetworkGatewaysClient

func (*ClientFactory) NewOperationsClient

func (c *ClientFactory) NewOperationsClient() *OperationsClient

func (*ClientFactory) NewPublicIPAddressesClient

func (c *ClientFactory) NewPublicIPAddressesClient() *PublicIPAddressesClient

func (*ClientFactory) NewRouteTablesClient

func (c *ClientFactory) NewRouteTablesClient() *RouteTablesClient

func (*ClientFactory) NewRoutesClient

func (c *ClientFactory) NewRoutesClient() *RoutesClient

func (*ClientFactory) NewSecurityGroupsClient

func (c *ClientFactory) NewSecurityGroupsClient() *SecurityGroupsClient

func (*ClientFactory) NewSecurityRulesClient

func (c *ClientFactory) NewSecurityRulesClient() *SecurityRulesClient

func (*ClientFactory) NewSubnetsClient

func (c *ClientFactory) NewSubnetsClient() *SubnetsClient

func (*ClientFactory) NewVirtualNetworkGatewayConnectionsClient

func (c *ClientFactory) NewVirtualNetworkGatewayConnectionsClient() *VirtualNetworkGatewayConnectionsClient

func (*ClientFactory) NewVirtualNetworkGatewaysClient

func (c *ClientFactory) NewVirtualNetworkGatewaysClient() *VirtualNetworkGatewaysClient

func (*ClientFactory) NewVirtualNetworkPeeringsClient

func (c *ClientFactory) NewVirtualNetworkPeeringsClient() *VirtualNetworkPeeringsClient

func (*ClientFactory) NewVirtualNetworksClient

func (c *ClientFactory) NewVirtualNetworksClient() *VirtualNetworksClient

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

type DdosSettings struct {
	// The DDoS custom policy associated with the public IP.
	DdosCustomPolicy *SubResource `json:"ddosCustomPolicy,omitempty"`

	// The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.
	ProtectionCoverage *DdosSettingsProtectionCoverage `json:"protectionCoverage,omitempty"`
}

DdosSettings - Contains the DDoS protection settings of the public IP.

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 DdosSettingsProtectionCoverage

type DdosSettingsProtectionCoverage string

DdosSettingsProtectionCoverage - The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

const (
	DdosSettingsProtectionCoverageBasic    DdosSettingsProtectionCoverage = "Basic"
	DdosSettingsProtectionCoverageStandard DdosSettingsProtectionCoverage = "Standard"
)

func PossibleDdosSettingsProtectionCoverageValues

func PossibleDdosSettingsProtectionCoverageValues() []DdosSettingsProtectionCoverage

PossibleDdosSettingsProtectionCoverageValues returns the possible values for the DdosSettingsProtectionCoverage const type.

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

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 2018-11-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.NewListPager method.

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

type DefaultSecurityRulesClientListResponse

type DefaultSecurityRulesClientListResponse struct {
	SecurityRuleListResult
}

DefaultSecurityRulesClientListResponse contains the response from method DefaultSecurityRulesClient.NewListPager.

type Delegation

type Delegation struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

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

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 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 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 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. Possible values are: 'Allow' and 'Deny'.
	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. Possible values are: 'Inbound and Outbound'.
	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. Possible values are: 'Tcp', 'Udp', and 'All'.
	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"`

	// 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. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet',
	// 'VirtualAppliance', and 'None'.
	NextHopType *RouteNextHopType `json:"nextHopType,omitempty"`

	// Who created the route. Possible values are: 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'.
	Source *EffectiveRouteSource `json:"source,omitempty"`

	// The value of effective route. Possible values are: 'Active' and 'Invalid'.
	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 EffectiveRouteSource

type EffectiveRouteSource string

EffectiveRouteSource - Who created the route. Possible values are: 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'.

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. Possible values are: 'Active' and 'Invalid'.

const (
	EffectiveRouteStateActive  EffectiveRouteState = "Active"
	EffectiveRouteStateInvalid EffectiveRouteState = "Invalid"
)

func PossibleEffectiveRouteStateValues

func PossibleEffectiveRouteStateValues() []EffectiveRouteState

PossibleEffectiveRouteStateValues returns the possible values for the EffectiveRouteState const type.

type EffectiveSecurityRuleProtocol

type EffectiveSecurityRuleProtocol string

EffectiveSecurityRuleProtocol - The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and 'All'.

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 EndpointService

type EndpointService struct {
	// A unique identifier of the service being referenced by the interface endpoint.
	ID *string `json:"id,omitempty"`
}

EndpointService - Identifies the service being brought into the virtual network.

func (EndpointService) MarshalJSON

func (e EndpointService) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndpointService.

func (*EndpointService) UnmarshalJSON

func (e *EndpointService) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointService.

type Error

type Error struct {
	Code       *string         `json:"code,omitempty"`
	Details    []*ErrorDetails `json:"details,omitempty"`
	InnerError *string         `json:"innerError,omitempty"`
	Message    *string         `json:"message,omitempty"`
	Target     *string         `json:"target,omitempty"`
}

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 {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
	Target  *string `json:"target,omitempty"`
}

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 FrontendIPConfiguration

type FrontendIPConfiguration struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

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

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 private IP address of the IP configuration.
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`

	// The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The reference of the Public IP resource.
	PublicIPAddress *PublicIPAddress `json:"publicIPAddress,omitempty"`

	// The reference of the Public IP Prefix resource.
	PublicIPPrefix *SubResource `json:"publicIPPrefix,omitempty"`

	// The reference of the subnet resource.
	Subnet *Subnet `json:"subnet,omitempty"`

	// READ-ONLY; Read only. Inbound pools URIs that use this frontend IP.
	InboundNatPools []*SubResource `json:"inboundNatPools,omitempty" azure:"ro"`

	// READ-ONLY; Read only. Inbound rules URIs that use this frontend IP.
	InboundNatRules []*SubResource `json:"inboundNatRules,omitempty" azure:"ro"`

	// READ-ONLY; Gets load balancing rules URIs that use this frontend IP.
	LoadBalancingRules []*SubResource `json:"loadBalancingRules,omitempty" azure:"ro"`

	// READ-ONLY; Read only. Outbound rules URIs that use this frontend IP.
	OutboundRules []*SubResource `json:"outboundRules,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 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 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"`
}

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 IPAllocationMethod

type IPAllocationMethod string

IPAllocationMethod - The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.

const (
	IPAllocationMethodDynamic IPAllocationMethod = "Dynamic"
	IPAllocationMethodStatic  IPAllocationMethod = "Static"
)

func PossibleIPAllocationMethodValues

func PossibleIPAllocationMethodValues() []IPAllocationMethod

PossibleIPAllocationMethodValues returns the possible values for the IPAllocationMethod const type.

type IPConfiguration

type IPConfiguration struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of the IP configuration
	Properties *IPConfigurationPropertiesFormat `json:"properties,omitempty"`
}

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 IPConfigurationProfile

type IPConfigurationProfile struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

	// 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; 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 of the subnet resource to create a container network interface ip configuration.
	Subnet *Subnet `json:"subnet,omitempty"`

	// READ-ONLY; The provisioning state of the resource.
	ProvisioningState *string `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 allocation method. Possible values are 'Static' and 'Dynamic'.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The reference of the public IP resource.
	PublicIPAddress *PublicIPAddress `json:"publicIPAddress,omitempty"`

	// The reference of the subnet resource.
	Subnet *Subnet `json:"subnet,omitempty"`
}

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 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 Groups 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 Groups 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 {
	// Gets or sets the ipTag type: Example FirstPartyUsage.
	IPTagType *string `json:"ipTagType,omitempty"`

	// Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc
	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 - Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.

const (
	IPVersionIPv4 IPVersion = "IPv4"
	IPVersionIPv6 IPVersion = "IPv6"
)

func PossibleIPVersionValues

func PossibleIPVersionValues() []IPVersion

PossibleIPVersionValues returns the possible values for the IPVersion const type.

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 {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of load balancer inbound nat pool.
	Properties *InboundNatPoolPropertiesFormat `json:"properties,omitempty"`
}

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 transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'.
	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"`

	// Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

InboundNatPoolPropertiesFormat - Properties of Inbound NAT pool.

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 {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

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

	// Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of load balancer inbound nat rule.
	Properties *InboundNatRulePropertiesFormat `json:"properties,omitempty"`
}

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 InboundNatRulePropertiesFormat

type InboundNatRulePropertiesFormat struct {
	// 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 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 transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'.
	Protocol *TransportProtocol `json:"protocol,omitempty"`

	// Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,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"`
}

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

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

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

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • loadBalancerName - The name of the load balancer.
  • options - InboundNatRulesClientListOptions contains the optional parameters for the InboundNatRulesClient.NewListPager method.

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

type InboundNatRulesClientDeleteResponse

type InboundNatRulesClientDeleteResponse struct {
}

InboundNatRulesClientDeleteResponse contains the response from method InboundNatRulesClient.BeginDelete.

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

type InboundNatRulesClientListResponse

type InboundNatRulesClientListResponse struct {
	InboundNatRuleListResult
}

InboundNatRulesClientListResponse contains the response from method InboundNatRulesClient.NewListPager.

type Interface

type Interface struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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; 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 InterfaceDNSSettings

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

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

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

	// Fully qualified DNS name supporting internal communications between VMs in the same virtual network.
	InternalFqdn *string `json:"internalFqdn,omitempty"`
}

InterfaceDNSSettings - DNS settings of a network interface.

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 InterfaceEndpoint

type InterfaceEndpoint struct {
	// Gets a unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

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

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

	// Properties of the interface endpoint.
	Properties *InterfaceEndpointProperties `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"`
}

InterfaceEndpoint - Interface endpoint resource.

func (InterfaceEndpoint) MarshalJSON

func (i InterfaceEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceEndpoint.

func (*InterfaceEndpoint) UnmarshalJSON

func (i *InterfaceEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceEndpoint.

type InterfaceEndpointProperties

type InterfaceEndpointProperties struct {
	// A reference to the service being brought into the virtual network.
	EndpointService *EndpointService `json:"endpointService,omitempty"`

	// A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint.
	Fqdn *string `json:"fqdn,omitempty"`

	// The ID of the subnet from which the private IP will be allocated.
	Subnet *Subnet `json:"subnet,omitempty"`

	// READ-ONLY; Gets an array of references to the network interfaces created for this interface endpoint.
	NetworkInterfaces []*Interface `json:"networkInterfaces,omitempty" azure:"ro"`

	// READ-ONLY; A read-only property that identifies who created this interface endpoint.
	Owner *string `json:"owner,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`
}

InterfaceEndpointProperties - Properties of the interface endpoint.

func (InterfaceEndpointProperties) MarshalJSON

func (i InterfaceEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceEndpointProperties.

func (*InterfaceEndpointProperties) UnmarshalJSON

func (i *InterfaceEndpointProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceEndpointProperties.

type InterfaceIPConfiguration

type InterfaceIPConfiguration struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Network interface IP configuration properties.
	Properties *InterfaceIPConfigurationPropertiesFormat `json:"properties,omitempty"`
}

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 InterfaceIPConfigurationPropertiesFormat

type InterfaceIPConfigurationPropertiesFormat struct {
	// The reference of ApplicationGatewayBackendAddressPool resource.
	ApplicationGatewayBackendAddressPools []*ApplicationGatewayBackendAddressPool `json:"applicationGatewayBackendAddressPools,omitempty"`

	// Application security groups in which the IP configuration is included.
	ApplicationSecurityGroups []*ApplicationSecurityGroup `json:"applicationSecurityGroups,omitempty"`

	// The reference of LoadBalancerBackendAddressPool resource.
	LoadBalancerBackendAddressPools []*BackendAddressPool `json:"loadBalancerBackendAddressPools,omitempty"`

	// A list of references of LoadBalancerInboundNatRules.
	LoadBalancerInboundNatRules []*InboundNatRule `json:"loadBalancerInboundNatRules,omitempty"`

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

	// Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default
	// is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.
	PrivateIPAddressVersion *IPVersion `json:"privateIPAddressVersion,omitempty"`

	// Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,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"`
}

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

func (*InterfaceIPConfigurationsClient) NewListPager

NewListPager - Get all ip configurations in a network interface

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • networkInterfaceName - The name of the network interface.
  • options - InterfaceIPConfigurationsClientListOptions contains the optional parameters for the InterfaceIPConfigurationsClient.NewListPager method.

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

type InterfaceIPConfigurationsClientListResponse

type InterfaceIPConfigurationsClientListResponse struct {
	InterfaceIPConfigurationListResult
}

InterfaceIPConfigurationsClientListResponse contains the response from method InterfaceIPConfigurationsClient.NewListPager.

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • networkInterfaceName - The name of the network interface.
  • options - InterfaceLoadBalancersClientListOptions contains the optional parameters for the InterfaceLoadBalancersClient.NewListPager method.

type InterfaceLoadBalancersClientListOptions

type InterfaceLoadBalancersClientListOptions struct {
}

InterfaceLoadBalancersClientListOptions contains the optional parameters for the InterfaceLoadBalancersClient.NewListPager method.

type InterfaceLoadBalancersClientListResponse

type InterfaceLoadBalancersClientListResponse struct {
	InterfaceLoadBalancerListResult
}

InterfaceLoadBalancersClientListResponse contains the response from method InterfaceLoadBalancersClient.NewListPager.

type InterfacePropertiesFormat

type InterfacePropertiesFormat struct {
	// The DNS settings in network interface.
	DNSSettings *InterfaceDNSSettings `json:"dnsSettings,omitempty"`

	// If the network interface is accelerated networking enabled.
	EnableAcceleratedNetworking *bool `json:"enableAcceleratedNetworking,omitempty"`

	// Indicates whether IP forwarding is enabled on this network interface.
	EnableIPForwarding *bool `json:"enableIPForwarding,omitempty"`

	// A list of IPConfigurations of the network interface.
	IPConfigurations []*InterfaceIPConfiguration `json:"ipConfigurations,omitempty"`

	// The MAC address of the network interface.
	MacAddress *string `json:"macAddress,omitempty"`

	// The reference of the NetworkSecurityGroup resource.
	NetworkSecurityGroup *SecurityGroup `json:"networkSecurityGroup,omitempty"`

	// Gets whether this is a primary network interface on a virtual machine.
	Primary *bool `json:"primary,omitempty"`

	// The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The resource GUID property of the network interface resource.
	ResourceGUID *string `json:"resourceGuid,omitempty"`

	// A list of TapConfigurations of the network interface.
	TapConfigurations []*InterfaceTapConfiguration `json:"tapConfigurations,omitempty"`

	// READ-ONLY; A list of references to linked BareMetal resources
	HostedWorkloads []*string `json:"hostedWorkloads,omitempty" azure:"ro"`

	// READ-ONLY; A reference to the interface endpoint to which the network interface is linked.
	InterfaceEndpoint *InterfaceEndpoint `json:"interfaceEndpoint,omitempty" azure:"ro"`

	// READ-ONLY; The reference of a virtual machine.
	VirtualMachine *SubResource `json:"virtualMachine,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 {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of the Virtual Network Tap configuration
	Properties *InterfaceTapConfigurationPropertiesFormat `json:"properties,omitempty"`

	// 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 of the Virtual Network Tap resource.
	VirtualNetworkTap *VirtualNetworkTap `json:"virtualNetworkTap,omitempty"`

	// READ-ONLY; The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting',
	// and 'Failed'.
	ProvisioningState *string `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 2018-11-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.

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

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

func (*InterfaceTapConfigurationsClient) NewListPager

NewListPager - Get all Tap configurations in a network interface

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • networkInterfaceName - The name of the network interface.
  • options - InterfaceTapConfigurationsClientListOptions contains the optional parameters for the InterfaceTapConfigurationsClient.NewListPager method.

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

type InterfaceTapConfigurationsClientDeleteResponse

type InterfaceTapConfigurationsClientDeleteResponse struct {
}

InterfaceTapConfigurationsClientDeleteResponse contains the response from method InterfaceTapConfigurationsClient.BeginDelete.

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

type InterfaceTapConfigurationsClientListResponse

type InterfaceTapConfigurationsClientListResponse struct {
	InterfaceTapConfigurationListResult
}

InterfaceTapConfigurationsClientListResponse contains the response from method InterfaceTapConfigurationsClient.NewListPager.

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

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

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

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

func (*InterfacesClient) BeginUpdateTags

func (client *InterfacesClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, networkInterfaceName string, parameters TagsObject, options *InterfacesClientBeginUpdateTagsOptions) (*runtime.Poller[InterfacesClientUpdateTagsResponse], error)

BeginUpdateTags - Updates a network interface tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • networkInterfaceName - The name of the network interface.
  • parameters - Parameters supplied to update network interface tags.
  • options - InterfacesClientBeginUpdateTagsOptions contains the optional parameters for the InterfacesClient.BeginUpdateTags method.

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

func (*InterfacesClient) NewListAllPager

NewListAllPager - Gets all network interfaces in a subscription.

Generated from API version 2018-11-01

  • options - InterfacesClientListAllOptions contains the optional parameters for the InterfacesClient.NewListAllPager method.

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • options - InterfacesClientListOptions contains the optional parameters for the InterfacesClient.NewListPager method.

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 InterfacesClientBeginUpdateTagsOptions

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

InterfacesClientBeginUpdateTagsOptions contains the optional parameters for the InterfacesClient.BeginUpdateTags method.

type InterfacesClientCreateOrUpdateResponse

type InterfacesClientCreateOrUpdateResponse struct {
	Interface
}

InterfacesClientCreateOrUpdateResponse contains the response from method InterfacesClient.BeginCreateOrUpdate.

type InterfacesClientDeleteResponse

type InterfacesClientDeleteResponse struct {
}

InterfacesClientDeleteResponse contains the response from method InterfacesClient.BeginDelete.

type InterfacesClientGetEffectiveRouteTableResponse

type InterfacesClientGetEffectiveRouteTableResponse struct {
	EffectiveRouteListResult
}

InterfacesClientGetEffectiveRouteTableResponse contains the response from method InterfacesClient.BeginGetEffectiveRouteTable.

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 InterfacesClientListAllOptions

type InterfacesClientListAllOptions struct {
}

InterfacesClientListAllOptions contains the optional parameters for the InterfacesClient.NewListAllPager method.

type InterfacesClientListAllResponse

type InterfacesClientListAllResponse struct {
	InterfaceListResult
}

InterfacesClientListAllResponse contains the response from method InterfacesClient.NewListAllPager.

type InterfacesClientListEffectiveNetworkSecurityGroupsResponse

type InterfacesClientListEffectiveNetworkSecurityGroupsResponse struct {
	EffectiveNetworkSecurityGroupListResult
}

InterfacesClientListEffectiveNetworkSecurityGroupsResponse contains the response from method InterfacesClient.BeginListEffectiveNetworkSecurityGroups.

type InterfacesClientListOptions

type InterfacesClientListOptions struct {
}

InterfacesClientListOptions contains the optional parameters for the InterfacesClient.NewListPager method.

type InterfacesClientListResponse

type InterfacesClientListResponse struct {
	InterfaceListResult
}

InterfacesClientListResponse contains the response from method InterfacesClient.NewListPager.

type InterfacesClientUpdateTagsResponse

type InterfacesClientUpdateTagsResponse struct {
	Interface
}

InterfacesClientUpdateTagsResponse contains the response from method InterfacesClient.BeginUpdateTags.

type LoadBalancer

type LoadBalancer struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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; 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 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) Get

Get - Gets load balancer backend address pool. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-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.

func (*LoadBalancerBackendAddressPoolsClient) NewListPager

NewListPager - Gets all the load balancer backed address pools.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • loadBalancerName - The name of the load balancer.
  • options - LoadBalancerBackendAddressPoolsClientListOptions contains the optional parameters for the LoadBalancerBackendAddressPoolsClient.NewListPager method.

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

type LoadBalancerBackendAddressPoolsClientListResponse

type LoadBalancerBackendAddressPoolsClientListResponse struct {
	LoadBalancerBackendAddressPoolListResult
}

LoadBalancerBackendAddressPoolsClientListResponse contains the response from method LoadBalancerBackendAddressPoolsClient.NewListPager.

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

func (*LoadBalancerFrontendIPConfigurationsClient) NewListPager

NewListPager - Gets all the load balancer frontend IP configurations.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • loadBalancerName - The name of the load balancer.
  • options - LoadBalancerFrontendIPConfigurationsClientListOptions contains the optional parameters for the LoadBalancerFrontendIPConfigurationsClient.NewListPager method.

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

type LoadBalancerFrontendIPConfigurationsClientListResponse

type LoadBalancerFrontendIPConfigurationsClientListResponse struct {
	LoadBalancerFrontendIPConfigurationListResult
}

LoadBalancerFrontendIPConfigurationsClientListResponse contains the response from method LoadBalancerFrontendIPConfigurationsClient.NewListPager.

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

func (*LoadBalancerLoadBalancingRulesClient) NewListPager

NewListPager - Gets all the load balancing rules in a load balancer.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • loadBalancerName - The name of the load balancer.
  • options - LoadBalancerLoadBalancingRulesClientListOptions contains the optional parameters for the LoadBalancerLoadBalancingRulesClient.NewListPager method.

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

type LoadBalancerLoadBalancingRulesClientListResponse

type LoadBalancerLoadBalancingRulesClientListResponse struct {
	LoadBalancerLoadBalancingRuleListResult
}

LoadBalancerLoadBalancingRulesClientListResponse contains the response from method LoadBalancerLoadBalancingRulesClient.NewListPager.

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • loadBalancerName - The name of the load balancer.
  • options - LoadBalancerNetworkInterfacesClientListOptions contains the optional parameters for the LoadBalancerNetworkInterfacesClient.NewListPager method.

type LoadBalancerNetworkInterfacesClientListOptions

type LoadBalancerNetworkInterfacesClientListOptions struct {
}

LoadBalancerNetworkInterfacesClientListOptions contains the optional parameters for the LoadBalancerNetworkInterfacesClient.NewListPager method.

type LoadBalancerNetworkInterfacesClientListResponse

type LoadBalancerNetworkInterfacesClientListResponse struct {
	InterfaceListResult
}

LoadBalancerNetworkInterfacesClientListResponse contains the response from method LoadBalancerNetworkInterfacesClient.NewListPager.

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

func (*LoadBalancerOutboundRulesClient) NewListPager

NewListPager - Gets all the outbound rules in a load balancer.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • loadBalancerName - The name of the load balancer.
  • options - LoadBalancerOutboundRulesClientListOptions contains the optional parameters for the LoadBalancerOutboundRulesClient.NewListPager method.

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

type LoadBalancerOutboundRulesClientListResponse

type LoadBalancerOutboundRulesClientListResponse struct {
	LoadBalancerOutboundRuleListResult
}

LoadBalancerOutboundRulesClientListResponse contains the response from method LoadBalancerOutboundRulesClient.NewListPager.

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

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • loadBalancerName - The name of the load balancer.
  • options - LoadBalancerProbesClientListOptions contains the optional parameters for the LoadBalancerProbesClient.NewListPager method.

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

type LoadBalancerProbesClientListResponse

type LoadBalancerProbesClientListResponse struct {
	LoadBalancerProbeListResult
}

LoadBalancerProbesClientListResponse contains the response from method LoadBalancerProbesClient.NewListPager.

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

	// Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The resource GUID property of the load balancer resource.
	ResourceGUID *string `json:"resourceGuid,omitempty"`
}

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

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"
	LoadBalancerSKUNameStandard LoadBalancerSKUName = "Standard"
)

func PossibleLoadBalancerSKUNameValues

func PossibleLoadBalancerSKUNameValues() []LoadBalancerSKUName

PossibleLoadBalancerSKUNameValues returns the possible values for the LoadBalancerSKUName const type.

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

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

func (*LoadBalancersClient) BeginUpdateTags

func (client *LoadBalancersClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, loadBalancerName string, parameters TagsObject, options *LoadBalancersClientBeginUpdateTagsOptions) (*runtime.Poller[LoadBalancersClientUpdateTagsResponse], error)

BeginUpdateTags - Updates a load balancer tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • loadBalancerName - The name of the load balancer.
  • parameters - Parameters supplied to update load balancer tags.
  • options - LoadBalancersClientBeginUpdateTagsOptions contains the optional parameters for the LoadBalancersClient.BeginUpdateTags method.

func (*LoadBalancersClient) Get

func (client *LoadBalancersClient) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, options *LoadBalancersClientGetOptions) (LoadBalancersClientGetResponse, error)

Get - Gets the specified load balancer. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-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.

func (*LoadBalancersClient) NewListAllPager

NewListAllPager - Gets all the load balancers in a subscription.

Generated from API version 2018-11-01

  • options - LoadBalancersClientListAllOptions contains the optional parameters for the LoadBalancersClient.NewListAllPager method.

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • options - LoadBalancersClientListOptions contains the optional parameters for the LoadBalancersClient.NewListPager method.

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 LoadBalancersClientBeginUpdateTagsOptions

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

LoadBalancersClientBeginUpdateTagsOptions contains the optional parameters for the LoadBalancersClient.BeginUpdateTags method.

type LoadBalancersClientCreateOrUpdateResponse

type LoadBalancersClientCreateOrUpdateResponse struct {
	LoadBalancer
}

LoadBalancersClientCreateOrUpdateResponse contains the response from method LoadBalancersClient.BeginCreateOrUpdate.

type LoadBalancersClientDeleteResponse

type LoadBalancersClientDeleteResponse struct {
}

LoadBalancersClientDeleteResponse contains the response from method LoadBalancersClient.BeginDelete.

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

type LoadBalancersClientListAllResponse

type LoadBalancersClientListAllResponse struct {
	LoadBalancerListResult
}

LoadBalancersClientListAllResponse contains the response from method LoadBalancersClient.NewListAllPager.

type LoadBalancersClientListOptions

type LoadBalancersClientListOptions struct {
}

LoadBalancersClientListOptions contains the optional parameters for the LoadBalancersClient.NewListPager method.

type LoadBalancersClientListResponse

type LoadBalancersClientListResponse struct {
	LoadBalancerListResult
}

LoadBalancersClientListResponse contains the response from method LoadBalancersClient.NewListPager.

type LoadBalancersClientUpdateTagsResponse

type LoadBalancersClientUpdateTagsResponse struct {
	LoadBalancer
}

LoadBalancersClientUpdateTagsResponse contains the response from method LoadBalancersClient.BeginUpdateTags.

type LoadBalancingRule

type LoadBalancingRule struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of load balancer load balancing rule.
	Properties *LoadBalancingRulePropertiesFormat `json:"properties,omitempty"`
}

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 transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'.
	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"`

	// 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. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.
	LoadDistribution *LoadDistribution `json:"loadDistribution,omitempty"`

	// The reference of the load balancer probe used by the load balancing rule.
	Probe *SubResource `json:"probe,omitempty"`

	// Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

LoadBalancingRulePropertiesFormat - Properties of the load balancer.

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. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.

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

	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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; 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"`

	// IP address of local network gateway.
	GatewayIPAddress *string `json:"gatewayIpAddress,omitempty"`

	// Local network site address space.
	LocalNetworkAddressSpace *AddressSpace `json:"localNetworkAddressSpace,omitempty"`

	// The resource GUID property of the LocalNetworkGateway resource.
	ResourceGUID *string `json:"resourceGuid,omitempty"`

	// READ-ONLY; The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and
	// 'Failed'.
	ProvisioningState *string `json:"provisioningState,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 2018-11-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.

func (*LocalNetworkGatewaysClient) BeginDelete

BeginDelete - Deletes the specified local network gateway. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-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.

func (*LocalNetworkGatewaysClient) BeginUpdateTags

func (client *LocalNetworkGatewaysClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, localNetworkGatewayName string, parameters TagsObject, options *LocalNetworkGatewaysClientBeginUpdateTagsOptions) (*runtime.Poller[LocalNetworkGatewaysClientUpdateTagsResponse], error)

BeginUpdateTags - Updates a local network gateway tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-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 - LocalNetworkGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the LocalNetworkGatewaysClient.BeginUpdateTags method.

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

func (*LocalNetworkGatewaysClient) NewListPager

NewListPager - Gets all the local network gateways in a resource group.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • options - LocalNetworkGatewaysClientListOptions contains the optional parameters for the LocalNetworkGatewaysClient.NewListPager method.

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 LocalNetworkGatewaysClientBeginUpdateTagsOptions

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

LocalNetworkGatewaysClientBeginUpdateTagsOptions contains the optional parameters for the LocalNetworkGatewaysClient.BeginUpdateTags method.

type LocalNetworkGatewaysClientCreateOrUpdateResponse

type LocalNetworkGatewaysClientCreateOrUpdateResponse struct {
	LocalNetworkGateway
}

LocalNetworkGatewaysClientCreateOrUpdateResponse contains the response from method LocalNetworkGatewaysClient.BeginCreateOrUpdate.

type LocalNetworkGatewaysClientDeleteResponse

type LocalNetworkGatewaysClientDeleteResponse struct {
}

LocalNetworkGatewaysClientDeleteResponse contains the response from method LocalNetworkGatewaysClient.BeginDelete.

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

type LocalNetworkGatewaysClientListResponse

type LocalNetworkGatewaysClientListResponse struct {
	LocalNetworkGatewayListResult
}

LocalNetworkGatewaysClientListResponse contains the response from method LocalNetworkGatewaysClient.NewListPager.

type LocalNetworkGatewaysClientUpdateTagsResponse

type LocalNetworkGatewaysClientUpdateTagsResponse struct {
	LocalNetworkGateway
}

LocalNetworkGatewaysClientUpdateTagsResponse contains the response from method LocalNetworkGatewaysClient.BeginUpdateTags.

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

type NetworkOperationStatus string

NetworkOperationStatus - Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and 'Failed'.

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 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 2018-11-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListOptions

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse

type OperationsClientListResponse struct {
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type OutboundRule

type OutboundRule struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of load balancer outbound rule.
	Properties *OutboundRulePropertiesFormat `json:"properties,omitempty"`
}

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; Protocol - TCP, UDP or All
	Protocol *OutboundRulePropertiesFormatProtocol `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"`

	// Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

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 OutboundRulePropertiesFormatProtocol

type OutboundRulePropertiesFormatProtocol string

OutboundRulePropertiesFormatProtocol - Protocol - TCP, UDP or All

const (
	OutboundRulePropertiesFormatProtocolAll OutboundRulePropertiesFormatProtocol = "All"
	OutboundRulePropertiesFormatProtocolTCP OutboundRulePropertiesFormatProtocol = "Tcp"
	OutboundRulePropertiesFormatProtocolUDP OutboundRulePropertiesFormatProtocol = "Udp"
)

func PossibleOutboundRulePropertiesFormatProtocolValues

func PossibleOutboundRulePropertiesFormatProtocolValues() []OutboundRulePropertiesFormatProtocol

PossibleOutboundRulePropertiesFormatProtocolValues returns the possible values for the OutboundRulePropertiesFormatProtocol const type.

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 Probe

type Probe struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

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

	// Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
	Name *string `json:"name,omitempty"`

	// Properties of load balancer probe.
	Properties *ProbePropertiesFormat `json:"properties,omitempty"`
}

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. Possible values are: 'Http', 'Tcp', or 'Https'. 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"`

	// Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,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"`
}

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. Possible values are: 'Http', 'Tcp', or 'Https'. 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. Possible values are: 'AMD64' and 'X86'.

const (
	ProcessorArchitectureAmd64 ProcessorArchitecture = "Amd64"
	ProcessorArchitectureX86   ProcessorArchitecture = "X86"
)

func PossibleProcessorArchitectureValues

func PossibleProcessorArchitectureValues() []ProcessorArchitecture

PossibleProcessorArchitectureValues returns the possible values for the ProcessorArchitecture const type.

type PublicIPAddress

type PublicIPAddress struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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; 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 {
	// Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the
	// fully qualified domain name associated with the public IP address. If a domain
	// name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.
	DomainNameLabel *string `json:"domainNameLabel,omitempty"`

	// Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation
	// of the domainNameLabel and the regionalized DNS zone.
	Fqdn *string `json:"fqdn,omitempty"`

	// Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If
	// the reverseFqdn is specified, then a PTR DNS record is created pointing from the
	// IP address in the in-addr.arpa domain to the reverse FQDN.
	ReverseFqdn *string `json:"reverseFqdn,omitempty"`
}

PublicIPAddressDNSSettings - Contains FQDN of the DNS record associated with the public IP address

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

	// 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 provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The public IP address version. Possible values are: 'IPv4' and 'IPv6'.
	PublicIPAddressVersion *IPVersion `json:"publicIPAddressVersion,omitempty"`

	// The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.
	PublicIPAllocationMethod *IPAllocationMethod `json:"publicIPAllocationMethod,omitempty"`

	// The Public IP Prefix this Public IP Address should be allocated from.
	PublicIPPrefix *SubResource `json:"publicIPPrefix,omitempty"`

	// The resource GUID property of the public IP resource.
	ResourceGUID *string `json:"resourceGuid,omitempty"`

	// READ-ONLY; The IP configuration associated with the public IP address.
	IPConfiguration *IPConfiguration `json:"ipConfiguration,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"`
}

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

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • publicIPAddressName - The name of the subnet.
  • options - PublicIPAddressesClientBeginDeleteOptions contains the optional parameters for the PublicIPAddressesClient.BeginDelete method.

func (*PublicIPAddressesClient) BeginUpdateTags

func (client *PublicIPAddressesClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, publicIPAddressName string, parameters TagsObject, options *PublicIPAddressesClientBeginUpdateTagsOptions) (*runtime.Poller[PublicIPAddressesClientUpdateTagsResponse], error)

BeginUpdateTags - Updates public IP address tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-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 - PublicIPAddressesClientBeginUpdateTagsOptions contains the optional parameters for the PublicIPAddressesClient.BeginUpdateTags method.

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • publicIPAddressName - The name of the subnet.
  • options - PublicIPAddressesClientGetOptions contains the optional parameters for the PublicIPAddressesClient.Get method.

func (*PublicIPAddressesClient) NewListAllPager

NewListAllPager - Gets all the public IP addresses in a subscription.

Generated from API version 2018-11-01

  • options - PublicIPAddressesClientListAllOptions contains the optional parameters for the PublicIPAddressesClient.NewListAllPager method.

func (*PublicIPAddressesClient) NewListPager

NewListPager - Gets all public IP addresses in a resource group.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • options - PublicIPAddressesClientListOptions contains the optional parameters for the PublicIPAddressesClient.NewListPager method.

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 PublicIPAddressesClientBeginDeleteOptions

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

PublicIPAddressesClientBeginDeleteOptions contains the optional parameters for the PublicIPAddressesClient.BeginDelete method.

type PublicIPAddressesClientBeginUpdateTagsOptions

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

PublicIPAddressesClientBeginUpdateTagsOptions contains the optional parameters for the PublicIPAddressesClient.BeginUpdateTags method.

type PublicIPAddressesClientCreateOrUpdateResponse

type PublicIPAddressesClientCreateOrUpdateResponse struct {
	PublicIPAddress
}

PublicIPAddressesClientCreateOrUpdateResponse contains the response from method PublicIPAddressesClient.BeginCreateOrUpdate.

type PublicIPAddressesClientDeleteResponse

type PublicIPAddressesClientDeleteResponse struct {
}

PublicIPAddressesClientDeleteResponse contains the response from method PublicIPAddressesClient.BeginDelete.

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 PublicIPAddressesClientListAllOptions

type PublicIPAddressesClientListAllOptions struct {
}

PublicIPAddressesClientListAllOptions contains the optional parameters for the PublicIPAddressesClient.NewListAllPager method.

type PublicIPAddressesClientListAllResponse

type PublicIPAddressesClientListAllResponse struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListAllResponse contains the response from method PublicIPAddressesClient.NewListAllPager.

type PublicIPAddressesClientListOptions

type PublicIPAddressesClientListOptions struct {
}

PublicIPAddressesClientListOptions contains the optional parameters for the PublicIPAddressesClient.NewListPager method.

type PublicIPAddressesClientListResponse

type PublicIPAddressesClientListResponse struct {
	PublicIPAddressListResult
}

PublicIPAddressesClientListResponse contains the response from method PublicIPAddressesClient.NewListPager.

type PublicIPAddressesClientUpdateTagsResponse

type PublicIPAddressesClientUpdateTagsResponse struct {
	PublicIPAddress
}

PublicIPAddressesClientUpdateTagsResponse contains the response from method PublicIPAddressesClient.BeginUpdateTags.

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

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; Provisioning state of the ResourceNavigationLink resource.
	ProvisioningState *string `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 Route

type Route struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of the route.
	Properties *RoutePropertiesFormat `json:"properties,omitempty"`
}

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 RouteListResult

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

	// Gets 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 RouteNextHopType

type RouteNextHopType string

RouteNextHopType - The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.

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. Possible values are: 'VirtualNetworkGateway', 'VnetLocal',
	// 'Internet', 'VirtualAppliance', and 'None'
	NextHopType *RouteNextHopType `json:"nextHopType,omitempty"`

	// The destination CIDR to which the route applies.
	AddressPrefix *string `json:"addressPrefix,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"`

	// The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

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 {
	// Gets a unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

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

	// Gets 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 {
	// Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.
	DisableBgpRoutePropagation *bool `json:"disableBgpRoutePropagation,omitempty"`

	// The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// Collection of routes contained within a route table.
	Routes []*Route `json:"routes,omitempty"`

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

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

func (*RouteTablesClient) BeginUpdateTags

func (client *RouteTablesClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, routeTableName string, parameters TagsObject, options *RouteTablesClientBeginUpdateTagsOptions) (*runtime.Poller[RouteTablesClientUpdateTagsResponse], error)

BeginUpdateTags - Updates a route table tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • routeTableName - The name of the route table.
  • parameters - Parameters supplied to update route table tags.
  • options - RouteTablesClientBeginUpdateTagsOptions contains the optional parameters for the RouteTablesClient.BeginUpdateTags method.

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

func (*RouteTablesClient) NewListAllPager

NewListAllPager - Gets all route tables in a subscription.

Generated from API version 2018-11-01

  • options - RouteTablesClientListAllOptions contains the optional parameters for the RouteTablesClient.NewListAllPager method.

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • options - RouteTablesClientListOptions contains the optional parameters for the RouteTablesClient.NewListPager method.

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 RouteTablesClientBeginUpdateTagsOptions

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

RouteTablesClientBeginUpdateTagsOptions contains the optional parameters for the RouteTablesClient.BeginUpdateTags method.

type RouteTablesClientCreateOrUpdateResponse

type RouteTablesClientCreateOrUpdateResponse struct {
	RouteTable
}

RouteTablesClientCreateOrUpdateResponse contains the response from method RouteTablesClient.BeginCreateOrUpdate.

type RouteTablesClientDeleteResponse

type RouteTablesClientDeleteResponse struct {
}

RouteTablesClientDeleteResponse contains the response from method RouteTablesClient.BeginDelete.

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

type RouteTablesClientListAllResponse

type RouteTablesClientListAllResponse struct {
	RouteTableListResult
}

RouteTablesClientListAllResponse contains the response from method RouteTablesClient.NewListAllPager.

type RouteTablesClientListOptions

type RouteTablesClientListOptions struct {
}

RouteTablesClientListOptions contains the optional parameters for the RouteTablesClient.NewListPager method.

type RouteTablesClientListResponse

type RouteTablesClientListResponse struct {
	RouteTableListResult
}

RouteTablesClientListResponse contains the response from method RouteTablesClient.NewListPager.

type RouteTablesClientUpdateTagsResponse

type RouteTablesClientUpdateTagsResponse struct {
	RouteTable
}

RouteTablesClientUpdateTagsResponse contains the response from method RouteTablesClient.BeginUpdateTags.

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

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

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

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • routeTableName - The name of the route table.
  • options - RoutesClientListOptions contains the optional parameters for the RoutesClient.NewListPager method.

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

type RoutesClientDeleteResponse

type RoutesClientDeleteResponse struct {
}

RoutesClientDeleteResponse contains the response from method RoutesClient.BeginDelete.

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

type RoutesClientListResponse

type RoutesClientListResponse struct {
	RouteListResult
}

RoutesClientListResponse contains the response from method RoutesClient.NewListPager.

type SecurityGroup

type SecurityGroup struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

	// 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; 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 SecurityGroupPropertiesFormat

type SecurityGroupPropertiesFormat struct {
	// The default security rules of network security group.
	DefaultSecurityRules []*SecurityRule `json:"defaultSecurityRules,omitempty"`

	// The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The resource GUID property of the network security group resource.
	ResourceGUID *string `json:"resourceGuid,omitempty"`

	// A collection of security rules of the network security group.
	SecurityRules []*SecurityRule `json:"securityRules,omitempty"`

	// READ-ONLY; A collection of references to network interfaces.
	NetworkInterfaces []*Interface `json:"networkInterfaces,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 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 2018-11-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.

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

func (*SecurityGroupsClient) BeginUpdateTags

func (client *SecurityGroupsClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, parameters TagsObject, options *SecurityGroupsClientBeginUpdateTagsOptions) (*runtime.Poller[SecurityGroupsClientUpdateTagsResponse], error)

BeginUpdateTags - Updates a network security group tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-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 - SecurityGroupsClientBeginUpdateTagsOptions contains the optional parameters for the SecurityGroupsClient.BeginUpdateTags method.

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

func (*SecurityGroupsClient) NewListAllPager

NewListAllPager - Gets all network security groups in a subscription.

Generated from API version 2018-11-01

  • options - SecurityGroupsClientListAllOptions contains the optional parameters for the SecurityGroupsClient.NewListAllPager method.

func (*SecurityGroupsClient) NewListPager

NewListPager - Gets all network security groups in a resource group.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • options - SecurityGroupsClientListOptions contains the optional parameters for the SecurityGroupsClient.NewListPager method.

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 SecurityGroupsClientBeginUpdateTagsOptions

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

SecurityGroupsClientBeginUpdateTagsOptions contains the optional parameters for the SecurityGroupsClient.BeginUpdateTags method.

type SecurityGroupsClientCreateOrUpdateResponse

type SecurityGroupsClientCreateOrUpdateResponse struct {
	SecurityGroup
}

SecurityGroupsClientCreateOrUpdateResponse contains the response from method SecurityGroupsClient.BeginCreateOrUpdate.

type SecurityGroupsClientDeleteResponse

type SecurityGroupsClientDeleteResponse struct {
}

SecurityGroupsClientDeleteResponse contains the response from method SecurityGroupsClient.BeginDelete.

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

type SecurityGroupsClientListAllResponse

type SecurityGroupsClientListAllResponse struct {
	SecurityGroupListResult
}

SecurityGroupsClientListAllResponse contains the response from method SecurityGroupsClient.NewListAllPager.

type SecurityGroupsClientListOptions

type SecurityGroupsClientListOptions struct {
}

SecurityGroupsClientListOptions contains the optional parameters for the SecurityGroupsClient.NewListPager method.

type SecurityGroupsClientListResponse

type SecurityGroupsClientListResponse struct {
	SecurityGroupListResult
}

SecurityGroupsClientListResponse contains the response from method SecurityGroupsClient.NewListPager.

type SecurityGroupsClientUpdateTagsResponse

type SecurityGroupsClientUpdateTagsResponse struct {
	SecurityGroup
}

SecurityGroupsClientUpdateTagsResponse contains the response from method SecurityGroupsClient.BeginUpdateTags.

type SecurityRule

type SecurityRule struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of the security rule
	Properties *SecurityRulePropertiesFormat `json:"properties,omitempty"`
}

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. Possible values are: 'Allow' and 'Deny'.

const (
	SecurityRuleAccessAllow SecurityRuleAccess = "Allow"
	SecurityRuleAccessDeny  SecurityRuleAccess = "Deny"
)

func PossibleSecurityRuleAccessValues

func PossibleSecurityRuleAccessValues() []SecurityRuleAccess

PossibleSecurityRuleAccessValues returns the possible values for the SecurityRuleAccess const type.

type SecurityRuleDirection

type SecurityRuleDirection string

SecurityRuleDirection - The direction of the rule. Possible values are: 'Inbound and Outbound'.

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. Possible values are: 'Allow' and 'Deny'.
	Access *SecurityRuleAccess `json:"access,omitempty"`

	// REQUIRED; The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.
	// Possible values are: 'Inbound' and 'Outbound'.
	Direction *SecurityRuleDirection `json:"direction,omitempty"`

	// REQUIRED; Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.
	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. Asterisks '*' 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. Asterisks '*' 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 provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The CIDR or source IP range. Asterisks '*' 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. Asterisks '*' can also be used to match all ports.
	SourcePortRange *string `json:"sourcePortRange,omitempty"`

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

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. Possible values are 'Tcp', 'Udp', and '*'.

const (
	SecurityRuleProtocolAsterisk SecurityRuleProtocol = "*"
	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 2018-11-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.

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

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

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 2018-11-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.NewListPager method.

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

type SecurityRulesClientDeleteResponse

type SecurityRulesClientDeleteResponse struct {
}

SecurityRulesClientDeleteResponse contains the response from method SecurityRulesClient.BeginDelete.

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

type SecurityRulesClientListResponse

type SecurityRulesClientListResponse struct {
	SecurityRuleListResult
}

SecurityRulesClientListResponse contains the response from method SecurityRulesClient.NewListPager.

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

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 {
	// Link to the external resource.
	Link *string `json:"link,omitempty"`

	// Resource type of the linked resource.
	LinkedResourceType *string `json:"linkedResourceType,omitempty"`

	// READ-ONLY; Provisioning state of the ServiceAssociationLink resource.
	ProvisioningState *string `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 ServiceDelegationPropertiesFormat

type ServiceDelegationPropertiesFormat struct {
	// Describes the actions permitted to the service upon delegation
	Actions []*string `json:"actions,omitempty"`

	// 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 provisioning state of the resource.
	ProvisioningState *string `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 ServiceEndpointPolicy

type ServiceEndpointPolicy struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

	// 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; 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 {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of the service endpoint policy definition
	Properties *ServiceEndpointPolicyDefinitionPropertiesFormat `json:"properties,omitempty"`
}

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 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 end point policy definition. Possible values are: 'Updating', 'Deleting',
	// and 'Failed'.
	ProvisioningState *string `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 ServiceEndpointPolicyPropertiesFormat

type ServiceEndpointPolicyPropertiesFormat struct {
	// 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. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `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 provisioning state of the resource.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The type of the endpoint service.
	Service *string `json:"service,omitempty"`
}

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 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 {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of the subnet.
	Properties *SubnetPropertiesFormat `json:"properties,omitempty"`
}

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

	// Gets an array of references to the delegations on the subnet.
	Delegations []*Delegation `json:"delegations,omitempty"`

	// The reference of the NetworkSecurityGroup resource.
	NetworkSecurityGroup *SecurityGroup `json:"networkSecurityGroup,omitempty"`

	// The provisioning state of the resource.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// Gets an array of references to the external resources using subnet.
	ResourceNavigationLinks []*ResourceNavigationLink `json:"resourceNavigationLinks,omitempty"`

	// The reference of the RouteTable resource.
	RouteTable *RouteTable `json:"routeTable,omitempty"`

	// Gets an array of references to services injecting into this subnet.
	ServiceAssociationLinks []*ServiceAssociationLink `json:"serviceAssociationLinks,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; Gets 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 interface endpoints
	InterfaceEndpoints []*InterfaceEndpoint `json:"interfaceEndpoints,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"`
}

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

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

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

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 2018-11-01

  • resourceGroupName - The name of the resource group.
  • virtualNetworkName - The name of the virtual network.
  • options - SubnetsClientListOptions contains the optional parameters for the SubnetsClient.NewListPager method.

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 SubnetsClientCreateOrUpdateResponse

type SubnetsClientCreateOrUpdateResponse struct {
	Subnet
}

SubnetsClientCreateOrUpdateResponse contains the response from method SubnetsClient.BeginCreateOrUpdate.

type SubnetsClientDeleteResponse

type SubnetsClientDeleteResponse struct {
}

SubnetsClientDeleteResponse contains the response from method SubnetsClient.BeginDelete.

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

type SubnetsClientListResponse

type SubnetsClientListResponse struct {
	SubnetListResult
}

SubnetsClientListResponse contains the response from method SubnetsClient.NewListPager.

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 TransportProtocol

type TransportProtocol string

TransportProtocol - The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'.

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

type VPNClientConfiguration struct {
	// 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 reference of the address space resource which represents Address space for P2S VpnClient.
	VPNClientAddressPool *AddressSpace `json:"vpnClientAddressPool,omitempty"`

	// VpnClientIpsecPolicies for virtual network gateway P2S client.
	VPNClientIPSecPolicies []*IPSecPolicy `json:"vpnClientIpsecPolicies,omitempty"`

	// VpnClientProtocols for Virtual network gateway.
	VPNClientProtocols []*VPNClientProtocol `json:"vpnClientProtocols,omitempty"`

	// VpnClientRevokedCertificate for Virtual network gateway.
	VPNClientRevokedCertificates []*VPNClientRevokedCertificate `json:"vpnClientRevokedCertificates,omitempty"`

	// VpnClientRootCertificate for virtual network gateway.
	VPNClientRootCertificates []*VPNClientRootCertificate `json:"vpnClientRootCertificates,omitempty"`
}

VPNClientConfiguration - VpnClientConfiguration for P2S client.

func (VPNClientConfiguration) MarshalJSON

func (v VPNClientConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VPNClientConfiguration.

func (*VPNClientConfiguration) UnmarshalJSON

func (v *VPNClientConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VPNClientConfiguration.

type VPNClientIPsecParameters

type VPNClientIPsecParameters struct {
	// REQUIRED; The DH Groups 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 Groups 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. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'.
	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. Possible values are: 'AMD64' and 'X86'.
	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 {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of the vpn client revoked certificate.
	Properties *VPNClientRevokedCertificatePropertiesFormat `json:"properties,omitempty"`
}

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. Possible values are: 'Updating', 'Deleting',
	// and 'Failed'.
	ProvisioningState *string `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"`

	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`
}

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. Possible values are: 'Updating', 'Deleting',
	// and 'Failed'.
	ProvisioningState *string `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 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 VPNType

type VPNType string

VPNType - The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.

const (
	VPNTypePolicyBased VPNType = "PolicyBased"
	VPNTypeRouteBased  VPNType = "RouteBased"
)

func PossibleVPNTypeValues

func PossibleVPNTypeValues() []VPNType

PossibleVPNTypeValues returns the possible values for the VPNType const type.

type VirtualNetwork

type VirtualNetwork struct {
	// Gets a unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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; 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 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 VirtualNetworkGateway

type VirtualNetworkGateway struct {
	// REQUIRED; Properties of the virtual network gateway.
	Properties *VirtualNetworkGatewayPropertiesFormat `json:"properties,omitempty"`

	// Gets a unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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; 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"`

	// Gets a unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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; 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"`

	// Gets a unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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; 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. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.
	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"`

	// Connection protocol used for this connection
	ConnectionProtocol *VirtualNetworkGatewayConnectionProtocol `json:"connectionProtocol,omitempty"`

	// EnableBgp flag
	EnableBgp *bool `json:"enableBgp,omitempty"`

	// Bypass ExpressRoute Gateway for data forwarding
	ExpressRouteGatewayBypass *bool `json:"expressRouteGatewayBypass,omitempty"`

	// The IPSec Policies to be considered by this connection.
	IPSecPolicies []*IPSecPolicy `json:"ipsecPolicies,omitempty"`

	// The reference to local network gateway resource.
	LocalNetworkGateway2 *VirtualNetworkConnectionGatewayReference `json:"localNetworkGateway2,omitempty"`

	// The reference to peerings resource.
	Peer *SubResource `json:"peer,omitempty"`

	// The resource GUID property of the VirtualNetworkGatewayConnection resource.
	ResourceGUID *string `json:"resourceGuid,omitempty"`

	// The routing weight.
	RoutingWeight *int32 `json:"routingWeight,omitempty"`

	// The IPSec shared key.
	SharedKey *string `json:"sharedKey,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. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.
	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 VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting',
	// and 'Failed'.
	ProvisioningState *string `json:"provisioningState,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 {
	// Gets 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 VirtualNetworkGatewayConnectionPropertiesFormat

type VirtualNetworkGatewayConnectionPropertiesFormat struct {
	// REQUIRED; Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.
	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"`

	// Connection protocol used for this connection
	ConnectionProtocol *VirtualNetworkGatewayConnectionProtocol `json:"connectionProtocol,omitempty"`

	// EnableBgp flag
	EnableBgp *bool `json:"enableBgp,omitempty"`

	// Bypass ExpressRoute Gateway for data forwarding
	ExpressRouteGatewayBypass *bool `json:"expressRouteGatewayBypass,omitempty"`

	// The IPSec Policies to be considered by this connection.
	IPSecPolicies []*IPSecPolicy `json:"ipsecPolicies,omitempty"`

	// The reference to local network gateway resource.
	LocalNetworkGateway2 *LocalNetworkGateway `json:"localNetworkGateway2,omitempty"`

	// The reference to peerings resource.
	Peer *SubResource `json:"peer,omitempty"`

	// The resource GUID property of the VirtualNetworkGatewayConnection resource.
	ResourceGUID *string `json:"resourceGuid,omitempty"`

	// The routing weight.
	RoutingWeight *int32 `json:"routingWeight,omitempty"`

	// The IPSec shared key.
	SharedKey *string `json:"sharedKey,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. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.
	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 VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting',
	// and 'Failed'.
	ProvisioningState *string `json:"provisioningState,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. Possible values are: 'IKEv2', 'IKEv1'.

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. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.

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

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

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

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

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

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

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

func (*VirtualNetworkGatewayConnectionsClient) NewListPager

NewListPager - The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • options - VirtualNetworkGatewayConnectionsClientListOptions contains the optional parameters for the VirtualNetworkGatewayConnectionsClient.NewListPager method.

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

type VirtualNetworkGatewayConnectionsClientDeleteResponse

type VirtualNetworkGatewayConnectionsClientDeleteResponse struct {
}

VirtualNetworkGatewayConnectionsClientDeleteResponse contains the response from method VirtualNetworkGatewayConnectionsClient.BeginDelete.

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

type VirtualNetworkGatewayConnectionsClientListResponse

type VirtualNetworkGatewayConnectionsClientListResponse struct {
	VirtualNetworkGatewayConnectionListResult
}

VirtualNetworkGatewayConnectionsClientListResponse contains the response from method VirtualNetworkGatewayConnectionsClient.NewListPager.

type VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse

type VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse struct {
	ConnectionResetSharedKey
}

VirtualNetworkGatewayConnectionsClientResetSharedKeyResponse contains the response from method VirtualNetworkGatewayConnectionsClient.BeginResetSharedKey.

type VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse

type VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse struct {
	ConnectionSharedKey
}

VirtualNetworkGatewayConnectionsClientSetSharedKeyResponse contains the response from method VirtualNetworkGatewayConnectionsClient.BeginSetSharedKey.

type VirtualNetworkGatewayConnectionsClientUpdateTagsResponse

type VirtualNetworkGatewayConnectionsClientUpdateTagsResponse struct {
	VirtualNetworkGatewayConnection
}

VirtualNetworkGatewayConnectionsClientUpdateTagsResponse contains the response from method VirtualNetworkGatewayConnectionsClient.BeginUpdateTags.

type VirtualNetworkGatewayIPConfiguration

type VirtualNetworkGatewayIPConfiguration struct {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of the virtual network gateway ip configuration.
	Properties *VirtualNetworkGatewayIPConfigurationPropertiesFormat `json:"properties,omitempty"`
}

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 allocation method. Possible values are: 'Static' and 'Dynamic'.
	PrivateIPAllocationMethod *IPAllocationMethod `json:"privateIPAllocationMethod,omitempty"`

	// The reference of the public IP resource.
	PublicIPAddress *SubResource `json:"publicIPAddress,omitempty"`

	// The reference of the subnet resource.
	Subnet *SubResource `json:"subnet,omitempty"`

	// READ-ONLY; The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `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 {
	// Gets 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 {
	// Gets 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 VirtualNetworkGatewayPropertiesFormat

type VirtualNetworkGatewayPropertiesFormat struct {
	// ActiveActive flag
	Active *bool `json:"activeActive,omitempty"`

	// Virtual network gateway's BGP speaker settings.
	BgpSettings *BgpSettings `json:"bgpSettings,omitempty"`

	// Whether BGP is enabled for this virtual network gateway or not.
	EnableBgp *bool `json:"enableBgp,omitempty"`

	// The reference of 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. Possible values are: 'Vpn' and 'ExpressRoute'.
	GatewayType *VirtualNetworkGatewayType `json:"gatewayType,omitempty"`

	// IP configurations for virtual network gateway.
	IPConfigurations []*VirtualNetworkGatewayIPConfiguration `json:"ipConfigurations,omitempty"`

	// The resource GUID property of the VirtualNetworkGateway resource.
	ResourceGUID *string `json:"resourceGuid,omitempty"`

	// The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
	SKU *VirtualNetworkGatewaySKU `json:"sku,omitempty"`

	// The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
	VPNClientConfiguration *VPNClientConfiguration `json:"vpnClientConfiguration,omitempty"`

	// The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.
	VPNType *VPNType `json:"vpnType,omitempty"`

	// READ-ONLY; The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and
	// 'Failed'.
	ProvisioningState *string `json:"provisioningState,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 {
	// The capacity.
	Capacity *int32 `json:"capacity,omitempty"`

	// Gateway SKU name.
	Name *VirtualNetworkGatewaySKUName `json:"name,omitempty"`

	// Gateway SKU tier.
	Tier *VirtualNetworkGatewaySKUTier `json:"tier,omitempty"`
}

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

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

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. Possible values are: 'Vpn' and 'ExpressRoute'.

const (
	VirtualNetworkGatewayTypeExpressRoute VirtualNetworkGatewayType = "ExpressRoute"
	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 2018-11-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.

func (*VirtualNetworkGatewaysClient) BeginDelete

BeginDelete - Deletes the specified virtual network gateway. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-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.

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

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

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

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

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

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

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

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

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

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

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

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

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 2018-11-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.NewListConnectionsPager method.

func (*VirtualNetworkGatewaysClient) NewListPager

NewListPager - Gets all virtual network gateways by resource group.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • options - VirtualNetworkGatewaysClientListOptions contains the optional parameters for the VirtualNetworkGatewaysClient.NewListPager method.

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

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

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

type VirtualNetworkGatewaysClientDeleteResponse

type VirtualNetworkGatewaysClientDeleteResponse struct {
}

VirtualNetworkGatewaysClientDeleteResponse contains the response from method VirtualNetworkGatewaysClient.BeginDelete.

type VirtualNetworkGatewaysClientGenerateVPNProfileResponse

type VirtualNetworkGatewaysClientGenerateVPNProfileResponse struct {
	Value *string
}

VirtualNetworkGatewaysClientGenerateVPNProfileResponse contains the response from method VirtualNetworkGatewaysClient.BeginGenerateVPNProfile.

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

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

type VirtualNetworkGatewaysClientGetBgpPeerStatusResponse

type VirtualNetworkGatewaysClientGetBgpPeerStatusResponse struct {
	BgpPeerStatusListResult
}

VirtualNetworkGatewaysClientGetBgpPeerStatusResponse contains the response from method VirtualNetworkGatewaysClient.BeginGetBgpPeerStatus.

type VirtualNetworkGatewaysClientGetLearnedRoutesResponse

type VirtualNetworkGatewaysClientGetLearnedRoutesResponse struct {
	GatewayRouteListResult
}

VirtualNetworkGatewaysClientGetLearnedRoutesResponse contains the response from method VirtualNetworkGatewaysClient.BeginGetLearnedRoutes.

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

func (*VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkGatewaysClientGetVPNProfilePackageURLResponse.

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse

type VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse struct {
	VPNClientIPsecParameters
}

VirtualNetworkGatewaysClientGetVpnclientIPSecParametersResponse contains the response from method VirtualNetworkGatewaysClient.BeginGetVpnclientIPSecParameters.

type VirtualNetworkGatewaysClientListConnectionsOptions

type VirtualNetworkGatewaysClientListConnectionsOptions struct {
}

VirtualNetworkGatewaysClientListConnectionsOptions contains the optional parameters for the VirtualNetworkGatewaysClient.NewListConnectionsPager method.

type VirtualNetworkGatewaysClientListConnectionsResponse

type VirtualNetworkGatewaysClientListConnectionsResponse struct {
	VirtualNetworkGatewayListConnectionsResult
}

VirtualNetworkGatewaysClientListConnectionsResponse contains the response from method VirtualNetworkGatewaysClient.NewListConnectionsPager.

type VirtualNetworkGatewaysClientListOptions

type VirtualNetworkGatewaysClientListOptions struct {
}

VirtualNetworkGatewaysClientListOptions contains the optional parameters for the VirtualNetworkGatewaysClient.NewListPager method.

type VirtualNetworkGatewaysClientListResponse

type VirtualNetworkGatewaysClientListResponse struct {
	VirtualNetworkGatewayListResult
}

VirtualNetworkGatewaysClientListResponse contains the response from method VirtualNetworkGatewaysClient.NewListPager.

type VirtualNetworkGatewaysClientResetResponse

type VirtualNetworkGatewaysClientResetResponse struct {
	VirtualNetworkGateway
}

VirtualNetworkGatewaysClientResetResponse contains the response from method VirtualNetworkGatewaysClient.BeginReset.

type VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse

type VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse struct {
}

VirtualNetworkGatewaysClientResetVPNClientSharedKeyResponse contains the response from method VirtualNetworkGatewaysClient.BeginResetVPNClientSharedKey.

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse

type VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse struct {
	VPNClientIPsecParameters
}

VirtualNetworkGatewaysClientSetVpnclientIPSecParametersResponse contains the response from method VirtualNetworkGatewaysClient.BeginSetVpnclientIPSecParameters.

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

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

	// Gets 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 {
	// A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,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"`

	// Properties of the virtual network peering.
	Properties *VirtualNetworkPeeringPropertiesFormat `json:"properties,omitempty"`
}

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 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 remote virtual network will be allowed/disallowed.
	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 linked virtual network space would be able to access all the VMs in local Virtual network space.
	AllowVirtualNetworkAccess *bool `json:"allowVirtualNetworkAccess,omitempty"`

	// The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.
	PeeringState *VirtualNetworkPeeringState `json:"peeringState,omitempty"`

	// The provisioning state of the resource.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The reference of the remote virtual network address space.
	RemoteAddressSpace *AddressSpace `json:"remoteAddressSpace,omitempty"`

	// The reference of 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"`

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

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. Possible values are 'Initiated', 'Connected', and 'Disconnected'.

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

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

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

func (*VirtualNetworkPeeringsClient) NewListPager

NewListPager - Gets all virtual network peerings in a virtual network.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • virtualNetworkName - The name of the virtual network.
  • options - VirtualNetworkPeeringsClientListOptions contains the optional parameters for the VirtualNetworkPeeringsClient.NewListPager method.

type VirtualNetworkPeeringsClientBeginCreateOrUpdateOptions

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

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

type VirtualNetworkPeeringsClientDeleteResponse

type VirtualNetworkPeeringsClientDeleteResponse struct {
}

VirtualNetworkPeeringsClientDeleteResponse contains the response from method VirtualNetworkPeeringsClient.BeginDelete.

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

type VirtualNetworkPeeringsClientListResponse

type VirtualNetworkPeeringsClientListResponse struct {
	VirtualNetworkPeeringListResult
}

VirtualNetworkPeeringsClientListResponse contains the response from method VirtualNetworkPeeringsClient.NewListPager.

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

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

	// The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// The resourceGuid property of the Virtual Network resource.
	ResourceGUID *string `json:"resourceGuid,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"`
}

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 {
	// Gets a unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty"`

	// 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; 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 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. Possible values are: 'Updating', 'Deleting', and 'Failed'.
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The resourceGuid property of the virtual network tap.
	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 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 2018-11-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.

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

func (*VirtualNetworksClient) BeginUpdateTags

func (client *VirtualNetworksClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, virtualNetworkName string, parameters TagsObject, options *VirtualNetworksClientBeginUpdateTagsOptions) (*runtime.Poller[VirtualNetworksClientUpdateTagsResponse], error)

BeginUpdateTags - Updates a virtual network tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • virtualNetworkName - The name of the virtual network.
  • parameters - Parameters supplied to update virtual network tags.
  • options - VirtualNetworksClientBeginUpdateTagsOptions contains the optional parameters for the VirtualNetworksClient.BeginUpdateTags method.

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

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

func (*VirtualNetworksClient) NewListAllPager

NewListAllPager - Gets all virtual networks in a subscription.

Generated from API version 2018-11-01

  • options - VirtualNetworksClientListAllOptions contains the optional parameters for the VirtualNetworksClient.NewListAllPager method.

func (*VirtualNetworksClient) NewListPager

NewListPager - Gets all virtual networks in a resource group.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • options - VirtualNetworksClientListOptions contains the optional parameters for the VirtualNetworksClient.NewListPager method.

func (*VirtualNetworksClient) NewListUsagePager

func (client *VirtualNetworksClient) NewListUsagePager(resourceGroupName string, virtualNetworkName string, options *VirtualNetworksClientListUsageOptions) *runtime.Pager[VirtualNetworksClientListUsageResponse]

NewListUsagePager - Lists usage stats.

Generated from API version 2018-11-01

  • resourceGroupName - The name of the resource group.
  • virtualNetworkName - The name of the virtual network.
  • options - VirtualNetworksClientListUsageOptions contains the optional parameters for the VirtualNetworksClient.NewListUsagePager method.

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 VirtualNetworksClientBeginUpdateTagsOptions

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

VirtualNetworksClientBeginUpdateTagsOptions contains the optional parameters for the VirtualNetworksClient.BeginUpdateTags 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.BeginCreateOrUpdate.

type VirtualNetworksClientDeleteResponse

type VirtualNetworksClientDeleteResponse struct {
}

VirtualNetworksClientDeleteResponse contains the response from method VirtualNetworksClient.BeginDelete.

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

type VirtualNetworksClientListAllResponse

type VirtualNetworksClientListAllResponse struct {
	VirtualNetworkListResult
}

VirtualNetworksClientListAllResponse contains the response from method VirtualNetworksClient.NewListAllPager.

type VirtualNetworksClientListOptions

type VirtualNetworksClientListOptions struct {
}

VirtualNetworksClientListOptions contains the optional parameters for the VirtualNetworksClient.NewListPager method.

type VirtualNetworksClientListResponse

type VirtualNetworksClientListResponse struct {
	VirtualNetworkListResult
}

VirtualNetworksClientListResponse contains the response from method VirtualNetworksClient.NewListPager.

type VirtualNetworksClientListUsageOptions

type VirtualNetworksClientListUsageOptions struct {
}

VirtualNetworksClientListUsageOptions contains the optional parameters for the VirtualNetworksClient.NewListUsagePager method.

type VirtualNetworksClientListUsageResponse

type VirtualNetworksClientListUsageResponse struct {
	VirtualNetworkListUsageResult
}

VirtualNetworksClientListUsageResponse contains the response from method VirtualNetworksClient.NewListUsagePager.

type VirtualNetworksClientUpdateTagsResponse

type VirtualNetworksClientUpdateTagsResponse struct {
	VirtualNetwork
}

VirtualNetworksClientUpdateTagsResponse contains the response from method VirtualNetworksClient.BeginUpdateTags.

Jump to

Keyboard shortcuts

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