hypervrunasaccounts

README

github.com/hashicorp/go-azure-sdk/resource-manager/migrate/2020-01-01/hypervrunasaccounts Documentation

The hypervrunasaccounts SDK allows for interaction with the Azure Resource Manager Service migrate (API Version 2020-01-01).

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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/migrate/2020-01-01/hypervrunasaccounts"

Client Initialization

client := hypervrunasaccounts.NewHyperVRunAsAccountsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: HyperVRunAsAccountsClient.GetAllRunAsAccountsInSite

ctx := context.TODO()
id := hypervrunasaccounts.NewHyperVSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "hyperVSiteValue")

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

Example Usage: HyperVRunAsAccountsClient.GetRunAsAccount

ctx := context.TODO()
id := commonids.NewHyperVSiteRunAsAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "hyperVSiteValue", "runAsAccountValue")

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

Documentation

Index

• func PossibleValuesForCredentialType() []string
• func ValidateHyperVSiteID(input interface{}, key string) (warnings []string, errors []error)
• type CredentialType
  • func (s *CredentialType) UnmarshalJSON(bytes []byte) error
• type GetAllRunAsAccountsInSiteCompleteResult
• type GetAllRunAsAccountsInSiteOperationResponse
• type GetRunAsAccountOperationResponse
• type HyperVRunAsAccount
• type HyperVRunAsAccountOperationPredicate
  • func (p HyperVRunAsAccountOperationPredicate) Matches(input HyperVRunAsAccount) bool
• type HyperVRunAsAccountsClient
  • func NewHyperVRunAsAccountsClientWithBaseURI(sdkApi sdkEnv.Api) (*HyperVRunAsAccountsClient, error)
  • func (c HyperVRunAsAccountsClient) GetAllRunAsAccountsInSite(ctx context.Context, id HyperVSiteId) (result GetAllRunAsAccountsInSiteOperationResponse, err error)
  • func (c HyperVRunAsAccountsClient) GetAllRunAsAccountsInSiteComplete(ctx context.Context, id HyperVSiteId) (GetAllRunAsAccountsInSiteCompleteResult, error)
  • func (c HyperVRunAsAccountsClient) GetAllRunAsAccountsInSiteCompleteMatchingPredicate(ctx context.Context, id HyperVSiteId, ...) (result GetAllRunAsAccountsInSiteCompleteResult, err error)
  • func (c HyperVRunAsAccountsClient) GetRunAsAccount(ctx context.Context, id commonids.HyperVSiteRunAsAccountId) (result GetRunAsAccountOperationResponse, err error)
• type HyperVSiteId
  • func NewHyperVSiteID(subscriptionId string, resourceGroupName string, hyperVSiteName string) HyperVSiteId
  • func ParseHyperVSiteID(input string) (*HyperVSiteId, error)
  • func ParseHyperVSiteIDInsensitively(input string) (*HyperVSiteId, error)
  • func (id *HyperVSiteId) FromParseResult(input resourceids.ParseResult) error
  • func (id HyperVSiteId) ID() string
  • func (id HyperVSiteId) Segments() []resourceids.Segment
  • func (id HyperVSiteId) String() string
• type RunAsAccountProperties

Functions

func PossibleValuesForCredentialType

func PossibleValuesForCredentialType() []string

func ValidateHyperVSiteID

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

ValidateHyperVSiteID checks that 'input' can be parsed as a Hyper V Site ID

Types

type CredentialType

type CredentialType string

const (
	CredentialTypeHyperVFabric  CredentialType = "HyperVFabric"
	CredentialTypeLinuxGuest    CredentialType = "LinuxGuest"
	CredentialTypeLinuxServer   CredentialType = "LinuxServer"
	CredentialTypeVMwareFabric  CredentialType = "VMwareFabric"
	CredentialTypeWindowsGuest  CredentialType = "WindowsGuest"
	CredentialTypeWindowsServer CredentialType = "WindowsServer"
)

func (*CredentialType) UnmarshalJSON

func (s *CredentialType) UnmarshalJSON(bytes []byte) error

type GetAllRunAsAccountsInSiteCompleteResult

type GetAllRunAsAccountsInSiteCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []HyperVRunAsAccount
}

type GetAllRunAsAccountsInSiteOperationResponse

type GetAllRunAsAccountsInSiteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]HyperVRunAsAccount
}

type GetRunAsAccountOperationResponse

type GetRunAsAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *HyperVRunAsAccount
}

type HyperVRunAsAccount

type HyperVRunAsAccount struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *RunAsAccountProperties `json:"properties,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type HyperVRunAsAccountOperationPredicate

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

func (HyperVRunAsAccountOperationPredicate) Matches

func (p HyperVRunAsAccountOperationPredicate) Matches(input HyperVRunAsAccount) bool

type HyperVRunAsAccountsClient

type HyperVRunAsAccountsClient struct {
	Client *resourcemanager.Client
}

func NewHyperVRunAsAccountsClientWithBaseURI

func NewHyperVRunAsAccountsClientWithBaseURI(sdkApi sdkEnv.Api) (*HyperVRunAsAccountsClient, error)

func (HyperVRunAsAccountsClient) GetAllRunAsAccountsInSite

func (c HyperVRunAsAccountsClient) GetAllRunAsAccountsInSite(ctx context.Context, id HyperVSiteId) (result GetAllRunAsAccountsInSiteOperationResponse, err error)

GetAllRunAsAccountsInSite ...

func (HyperVRunAsAccountsClient) GetAllRunAsAccountsInSiteComplete

func (c HyperVRunAsAccountsClient) GetAllRunAsAccountsInSiteComplete(ctx context.Context, id HyperVSiteId) (GetAllRunAsAccountsInSiteCompleteResult, error)

GetAllRunAsAccountsInSiteComplete retrieves all the results into a single object

func (HyperVRunAsAccountsClient) GetAllRunAsAccountsInSiteCompleteMatchingPredicate

func (c HyperVRunAsAccountsClient) GetAllRunAsAccountsInSiteCompleteMatchingPredicate(ctx context.Context, id HyperVSiteId, predicate HyperVRunAsAccountOperationPredicate) (result GetAllRunAsAccountsInSiteCompleteResult, err error)

GetAllRunAsAccountsInSiteCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (HyperVRunAsAccountsClient) GetRunAsAccount

func (c HyperVRunAsAccountsClient) GetRunAsAccount(ctx context.Context, id commonids.HyperVSiteRunAsAccountId) (result GetRunAsAccountOperationResponse, err error)

GetRunAsAccount ...

type HyperVSiteId

type HyperVSiteId struct {
	SubscriptionId    string
	ResourceGroupName string
	HyperVSiteName    string
}

HyperVSiteId is a struct representing the Resource ID for a Hyper V Site

func NewHyperVSiteID

func NewHyperVSiteID(subscriptionId string, resourceGroupName string, hyperVSiteName string) HyperVSiteId

NewHyperVSiteID returns a new HyperVSiteId struct

func ParseHyperVSiteID

func ParseHyperVSiteID(input string) (*HyperVSiteId, error)

ParseHyperVSiteID parses 'input' into a HyperVSiteId

func ParseHyperVSiteIDInsensitively

func ParseHyperVSiteIDInsensitively(input string) (*HyperVSiteId, error)

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

func (*HyperVSiteId) FromParseResult

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

func (HyperVSiteId) ID

func (id HyperVSiteId) ID() string

ID returns the formatted Hyper V Site ID

func (HyperVSiteId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Hyper V Site ID

func (HyperVSiteId) String

func (id HyperVSiteId) String() string

String returns a human-readable description of this Hyper V Site ID

type RunAsAccountProperties

type RunAsAccountProperties struct {
	CreatedTimestamp *string         `json:"createdTimestamp,omitempty"`
	CredentialType   *CredentialType `json:"credentialType,omitempty"`
	DisplayName      *string         `json:"displayName,omitempty"`
	UpdatedTimestamp *string         `json:"updatedTimestamp,omitempty"`
}