publicipaddress

Documentation

Overview

Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the Apache v2.0 License.

Index

• type PublicIPAddressAgentClient
  • func NewPublicIPAddressClient(cloudFQDN string, authorizer auth.Authorizer) (*PublicIPAddressAgentClient, error)
  • func (c *PublicIPAddressAgentClient) CreateOrUpdate(ctx context.Context, group, name string, pip *network.PublicIPAddress) (*network.PublicIPAddress, error)
  • func (c *PublicIPAddressAgentClient) Delete(ctx context.Context, group, name string) error
  • func (c *PublicIPAddressAgentClient) Get(ctx context.Context, group, name string) (*[]network.PublicIPAddress, error)
  • func (c *PublicIPAddressAgentClient) Precheck(ctx context.Context, group string, pip []*network.PublicIPAddress) (bool, error)
• type Service

Types

type PublicIPAddressAgentClient

type PublicIPAddressAgentClient struct {
	network.BaseClient
	// contains filtered or unexported fields
}

PublicIPAddressAgentClient is a client for managing public IP addresses. It embeds the network.BaseClient and includes an internal Service for additional functionality.

func NewPublicIPAddressClient

func NewPublicIPAddressClient(cloudFQDN string, authorizer auth.Authorizer) (*PublicIPAddressAgentClient, error)

NewPublicIPAddressClient creates a new instance of PublicIPAddressAgentClient. It takes a cloudFQDN string and an authorizer of type auth.Authorizer as parameters. Returns a pointer to PublicIPAddressAgentClient and an error if the client creation fails.

func (*PublicIPAddressAgentClient) CreateOrUpdate

func (c *PublicIPAddressAgentClient) CreateOrUpdate(ctx context.Context, group, name string, pip *network.PublicIPAddress) (*network.PublicIPAddress, error)

CreateOrUpdate creates or updates a Public IP Address in the specified resource group.

func (*PublicIPAddressAgentClient) Delete

func (c *PublicIPAddressAgentClient) Delete(ctx context.Context, group, name string) error

Delete removes a public IP address resource identified by the specified group and name.

func (*PublicIPAddressAgentClient) Get

func (c *PublicIPAddressAgentClient) Get(ctx context.Context, group, name string) (*[]network.PublicIPAddress, error)

Get retrieves a list of PublicIPAddresses from the specified resource group and name.

func (*PublicIPAddressAgentClient) Precheck

func (c *PublicIPAddressAgentClient) Precheck(ctx context.Context, group string, pip []*network.PublicIPAddress) (bool, error)

Prechecks whether the system is able to create specified resources. Returns true if it is possible; or false with reason in error message if not.

type Service

type Service interface {
	Get(context.Context, string, string) (*[]network.PublicIPAddress, error)
	CreateOrUpdate(context.Context, string, string, *network.PublicIPAddress) (*network.PublicIPAddress, error)
	Delete(context.Context, string, string) error
	Precheck(ctx context.Context, group string, pips []*network.PublicIPAddress) (bool, error)
}

Service defines the interface for managing Public IP Addresses in the network service. It provides methods to get, create or update, delete, and precheck public IP addresses.