machinenetworkprofile

README

github.com/hashicorp/go-azure-sdk/resource-manager/hybridcompute/2024-07-10/machinenetworkprofile Documentation

The machinenetworkprofile SDK allows for interaction with Azure Resource Manager hybridcompute (API Version 2024-07-10).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/hybridcompute/2024-07-10/machinenetworkprofile"

Client Initialization

client := machinenetworkprofile.NewMachineNetworkProfileClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MachineNetworkProfileClient.NetworkProfileGet

ctx := context.TODO()
id := machinenetworkprofile.NewMachineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "machineName")

read, err := client.NetworkProfileGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func ValidateMachineID(input interface{}, key string) (warnings []string, errors []error)
• type IPAddress
• type MachineId
  • func NewMachineID(subscriptionId string, resourceGroupName string, machineName string) MachineId
  • func ParseMachineID(input string) (*MachineId, error)
  • func ParseMachineIDInsensitively(input string) (*MachineId, error)
  • func (id *MachineId) FromParseResult(input resourceids.ParseResult) error
  • func (id MachineId) ID() string
  • func (id MachineId) Segments() []resourceids.Segment
  • func (id MachineId) String() string
• type MachineNetworkProfileClient
  • func NewMachineNetworkProfileClientWithBaseURI(sdkApi sdkEnv.Api) (*MachineNetworkProfileClient, error)
  • func (c MachineNetworkProfileClient) NetworkProfileGet(ctx context.Context, id MachineId) (result NetworkProfileGetOperationResponse, err error)
• type NetworkInterface
• type NetworkProfile
• type NetworkProfileGetOperationResponse
• type Subnet

Functions

func ValidateMachineID

func ValidateMachineID(input interface{}, key string) (warnings []string, errors []error)

ValidateMachineID checks that 'input' can be parsed as a Machine ID

Types

type IPAddress

type IPAddress struct {
	Address          *string `json:"address,omitempty"`
	IPAddressVersion *string `json:"ipAddressVersion,omitempty"`
	Subnet           *Subnet `json:"subnet,omitempty"`
}

type MachineId

type MachineId struct {
	SubscriptionId    string
	ResourceGroupName string
	MachineName       string
}

MachineId is a struct representing the Resource ID for a Machine

func NewMachineID

func NewMachineID(subscriptionId string, resourceGroupName string, machineName string) MachineId

NewMachineID returns a new MachineId struct

func ParseMachineID

func ParseMachineID(input string) (*MachineId, error)

ParseMachineID parses 'input' into a MachineId

func ParseMachineIDInsensitively

func ParseMachineIDInsensitively(input string) (*MachineId, error)

ParseMachineIDInsensitively parses 'input' case-insensitively into a MachineId note: this method should only be used for API response data and not user input

func (*MachineId) FromParseResult

func (id *MachineId) FromParseResult(input resourceids.ParseResult) error

func (MachineId) ID

func (id MachineId) ID() string

ID returns the formatted Machine ID

func (MachineId) Segments

func (id MachineId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Machine ID

func (MachineId) String

func (id MachineId) String() string

String returns a human-readable description of this Machine ID

type MachineNetworkProfileClient

type MachineNetworkProfileClient struct {
	Client *resourcemanager.Client
}

func NewMachineNetworkProfileClientWithBaseURI

func NewMachineNetworkProfileClientWithBaseURI(sdkApi sdkEnv.Api) (*MachineNetworkProfileClient, error)

func (MachineNetworkProfileClient) NetworkProfileGet

func (c MachineNetworkProfileClient) NetworkProfileGet(ctx context.Context, id MachineId) (result NetworkProfileGetOperationResponse, err error)

NetworkProfileGet ...

type NetworkInterface

type NetworkInterface struct {
	IPAddresses *[]IPAddress `json:"ipAddresses,omitempty"`
}

type NetworkProfile

type NetworkProfile struct {
	NetworkInterfaces *[]NetworkInterface `json:"networkInterfaces,omitempty"`
}

type NetworkProfileGetOperationResponse

type NetworkProfileGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkProfile
}

type Subnet

type Subnet struct {
	AddressPrefix *string `json:"addressPrefix,omitempty"`
}