hybrididentitymetadata

README

github.com/hashicorp/go-azure-sdk/resource-manager/hybridcompute/2024-05-20-preview/hybrididentitymetadata Documentation

The hybrididentitymetadata SDK allows for interaction with Azure Resource Manager hybridcompute (API Version 2024-05-20-preview).

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-05-20-preview/hybrididentitymetadata"

Client Initialization

client := hybrididentitymetadata.NewHybridIdentityMetadataClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: HybridIdentityMetadataClient.Get

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

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

Example Usage: HybridIdentityMetadataClient.ListByMachines

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

// alternatively `client.ListByMachines(ctx, id)` can be used to do batched pagination
items, err := client.ListByMachinesComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func ValidateHybridIdentityMetadataID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateMachineID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type HybridIdentityMetadata
• type HybridIdentityMetadataClient
  • func NewHybridIdentityMetadataClientWithBaseURI(sdkApi sdkEnv.Api) (*HybridIdentityMetadataClient, error)
  • func (c HybridIdentityMetadataClient) Get(ctx context.Context, id HybridIdentityMetadataId) (result GetOperationResponse, err error)
  • func (c HybridIdentityMetadataClient) ListByMachines(ctx context.Context, id MachineId) (result ListByMachinesOperationResponse, err error)
  • func (c HybridIdentityMetadataClient) ListByMachinesComplete(ctx context.Context, id MachineId) (ListByMachinesCompleteResult, error)
  • func (c HybridIdentityMetadataClient) ListByMachinesCompleteMatchingPredicate(ctx context.Context, id MachineId, ...) (result ListByMachinesCompleteResult, err error)
• type HybridIdentityMetadataId
  • func NewHybridIdentityMetadataID(subscriptionId string, resourceGroupName string, machineName string, ...) HybridIdentityMetadataId
  • func ParseHybridIdentityMetadataID(input string) (*HybridIdentityMetadataId, error)
  • func ParseHybridIdentityMetadataIDInsensitively(input string) (*HybridIdentityMetadataId, error)
  • func (id *HybridIdentityMetadataId) FromParseResult(input resourceids.ParseResult) error
  • func (id HybridIdentityMetadataId) ID() string
  • func (id HybridIdentityMetadataId) Segments() []resourceids.Segment
  • func (id HybridIdentityMetadataId) String() string
• type HybridIdentityMetadataOperationPredicate
  • func (p HybridIdentityMetadataOperationPredicate) Matches(input HybridIdentityMetadata) bool
• type HybridIdentityMetadataProperties
• type ListByMachinesCompleteResult
• type ListByMachinesCustomPager
  • func (p *ListByMachinesCustomPager) NextPageLink() *odata.Link
• type ListByMachinesOperationResponse
• 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

Functions

func ValidateHybridIdentityMetadataID

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

ValidateHybridIdentityMetadataID checks that 'input' can be parsed as a Hybrid Identity Metadata ID

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 GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *HybridIdentityMetadata
}

type HybridIdentityMetadata

type HybridIdentityMetadata struct {
	Id         *string                          `json:"id,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties HybridIdentityMetadataProperties `json:"properties"`
	SystemData *systemdata.SystemData           `json:"systemData,omitempty"`
	Type       *string                          `json:"type,omitempty"`
}

type HybridIdentityMetadataClient

type HybridIdentityMetadataClient struct {
	Client *resourcemanager.Client
}

func NewHybridIdentityMetadataClientWithBaseURI

func NewHybridIdentityMetadataClientWithBaseURI(sdkApi sdkEnv.Api) (*HybridIdentityMetadataClient, error)

func (HybridIdentityMetadataClient) Get

func (c HybridIdentityMetadataClient) Get(ctx context.Context, id HybridIdentityMetadataId) (result GetOperationResponse, err error)

Get ...

func (HybridIdentityMetadataClient) ListByMachines

func (c HybridIdentityMetadataClient) ListByMachines(ctx context.Context, id MachineId) (result ListByMachinesOperationResponse, err error)

ListByMachines ...

func (HybridIdentityMetadataClient) ListByMachinesComplete

func (c HybridIdentityMetadataClient) ListByMachinesComplete(ctx context.Context, id MachineId) (ListByMachinesCompleteResult, error)

ListByMachinesComplete retrieves all the results into a single object

func (HybridIdentityMetadataClient) ListByMachinesCompleteMatchingPredicate

func (c HybridIdentityMetadataClient) ListByMachinesCompleteMatchingPredicate(ctx context.Context, id MachineId, predicate HybridIdentityMetadataOperationPredicate) (result ListByMachinesCompleteResult, err error)

ListByMachinesCompleteMatchingPredicate retrieves all the results and then applies the predicate

type HybridIdentityMetadataId

type HybridIdentityMetadataId struct {
	SubscriptionId             string
	ResourceGroupName          string
	MachineName                string
	HybridIdentityMetadataName string
}

HybridIdentityMetadataId is a struct representing the Resource ID for a Hybrid Identity Metadata

func NewHybridIdentityMetadataID

func NewHybridIdentityMetadataID(subscriptionId string, resourceGroupName string, machineName string, hybridIdentityMetadataName string) HybridIdentityMetadataId

NewHybridIdentityMetadataID returns a new HybridIdentityMetadataId struct

func ParseHybridIdentityMetadataID

func ParseHybridIdentityMetadataID(input string) (*HybridIdentityMetadataId, error)

ParseHybridIdentityMetadataID parses 'input' into a HybridIdentityMetadataId

func ParseHybridIdentityMetadataIDInsensitively

func ParseHybridIdentityMetadataIDInsensitively(input string) (*HybridIdentityMetadataId, error)

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

func (*HybridIdentityMetadataId) FromParseResult

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

func (HybridIdentityMetadataId) ID

func (id HybridIdentityMetadataId) ID() string

ID returns the formatted Hybrid Identity Metadata ID

func (HybridIdentityMetadataId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Hybrid Identity Metadata ID

func (HybridIdentityMetadataId) String

func (id HybridIdentityMetadataId) String() string

String returns a human-readable description of this Hybrid Identity Metadata ID

type HybridIdentityMetadataOperationPredicate

type HybridIdentityMetadataOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (HybridIdentityMetadataOperationPredicate) Matches

func (p HybridIdentityMetadataOperationPredicate) Matches(input HybridIdentityMetadata) bool

type HybridIdentityMetadataProperties

type HybridIdentityMetadataProperties struct {
	Identity  *identity.SystemAssigned `json:"identity,omitempty"`
	PublicKey *string                  `json:"publicKey,omitempty"`
	VMId      *string                  `json:"vmId,omitempty"`
}

type ListByMachinesCompleteResult

type ListByMachinesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []HybridIdentityMetadata
}

type ListByMachinesCustomPager

type ListByMachinesCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByMachinesCustomPager) NextPageLink

func (p *ListByMachinesCustomPager) NextPageLink() *odata.Link

type ListByMachinesOperationResponse

type ListByMachinesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]HybridIdentityMetadata
}

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