sites

package
v0.20240313.1132601 Latest Latest
Warning

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

Go to latest
Published: Mar 13, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

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

The sites 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-sdk/resource-manager/migrate/2020-01-01/sites"

Client Initialization

client := sites.NewSitesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SitesClient.DeleteSite

ctx := context.TODO()
id := sites.NewVMwareSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vmwareSiteValue")

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

Example Usage: SitesClient.GetSite

ctx := context.TODO()
id := sites.NewVMwareSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vmwareSiteValue")

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

Example Usage: SitesClient.GetSiteHealthSummary

ctx := context.TODO()
id := sites.NewVMwareSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vmwareSiteValue")

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

Example Usage: SitesClient.GetSiteUsage

ctx := context.TODO()
id := sites.NewVMwareSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vmwareSiteValue")

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

Example Usage: SitesClient.PatchSite

ctx := context.TODO()
id := sites.NewVMwareSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vmwareSiteValue")

payload := sites.VMwareSite{
	// ...
}


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

Example Usage: SitesClient.PutSite

ctx := context.TODO()
id := sites.NewVMwareSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vmwareSiteValue")

payload := sites.VMwareSite{
	// ...
}


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

Example Usage: SitesClient.RefreshSite

ctx := context.TODO()
id := sites.NewVMwareSiteID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vmwareSiteValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateVMwareSiteID

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

ValidateVMwareSiteID checks that 'input' can be parsed as a V Mware Site ID

Types

type DeleteSiteOperationResponse

type DeleteSiteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetSiteHealthSummaryCompleteResult

type GetSiteHealthSummaryCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SiteHealthSummary
}

type GetSiteHealthSummaryOperationResponse

type GetSiteHealthSummaryOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SiteHealthSummary
}

type GetSiteOperationResponse

type GetSiteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VMwareSite
}

type GetSiteUsageOperationResponse

type GetSiteUsageOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VMwareSiteUsage
}

type PatchSiteOperationResponse

type PatchSiteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VMwareSite
}

type PutSiteOperationResponse

type PutSiteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VMwareSite
}

type RefreshSiteOperationResponse

type RefreshSiteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type SiteAgentProperties

type SiteAgentProperties struct {
	Id               *string `json:"id,omitempty"`
	KeyVaultId       *string `json:"keyVaultId,omitempty"`
	KeyVaultUri      *string `json:"keyVaultUri,omitempty"`
	LastHeartBeatUtc *string `json:"lastHeartBeatUtc,omitempty"`
	Version          *string `json:"version,omitempty"`
}

func (*SiteAgentProperties) GetLastHeartBeatUtcAsTime

func (o *SiteAgentProperties) GetLastHeartBeatUtcAsTime() (*time.Time, error)

func (*SiteAgentProperties) SetLastHeartBeatUtcAsTime

func (o *SiteAgentProperties) SetLastHeartBeatUtcAsTime(input time.Time)

type SiteHealthSummary

type SiteHealthSummary struct {
	AffectedObjectsCount *int64    `json:"affectedObjectsCount,omitempty"`
	AffectedResourceType *string   `json:"affectedResourceType,omitempty"`
	AffectedResources    *[]string `json:"affectedResources,omitempty"`
	ApplianceName        *string   `json:"applianceName,omitempty"`
	ErrorCode            *string   `json:"errorCode,omitempty"`
	ErrorId              *int64    `json:"errorId,omitempty"`
	ErrorMessage         *string   `json:"errorMessage,omitempty"`
	HitCount             *int64    `json:"hitCount,omitempty"`
	RemediationGuidance  *string   `json:"remediationGuidance,omitempty"`
	Severity             *string   `json:"severity,omitempty"`
	SummaryMessage       *string   `json:"summaryMessage,omitempty"`
}

type SiteHealthSummaryOperationPredicate

type SiteHealthSummaryOperationPredicate struct {
	AffectedObjectsCount *int64
	AffectedResourceType *string
	ApplianceName        *string
	ErrorCode            *string
	ErrorId              *int64
	ErrorMessage         *string
	HitCount             *int64
	RemediationGuidance  *string
	Severity             *string
	SummaryMessage       *string
}

func (SiteHealthSummaryOperationPredicate) Matches

type SiteProperties

type SiteProperties struct {
	AgentDetails                    *SiteAgentProperties `json:"agentDetails,omitempty"`
	ApplianceName                   *string              `json:"applianceName,omitempty"`
	DiscoverySolutionId             *string              `json:"discoverySolutionId,omitempty"`
	ServiceEndpoint                 *string              `json:"serviceEndpoint,omitempty"`
	ServicePrincipalIdentityDetails *SiteSpnProperties   `json:"servicePrincipalIdentityDetails,omitempty"`
}

type SiteSpnProperties

type SiteSpnProperties struct {
	AadAuthority  *string `json:"aadAuthority,omitempty"`
	ApplicationId *string `json:"applicationId,omitempty"`
	Audience      *string `json:"audience,omitempty"`
	ObjectId      *string `json:"objectId,omitempty"`
	RawCertData   *string `json:"rawCertData,omitempty"`
	TenantId      *string `json:"tenantId,omitempty"`
}

type SitesClient

type SitesClient struct {
	Client *resourcemanager.Client
}

func NewSitesClientWithBaseURI

func NewSitesClientWithBaseURI(sdkApi sdkEnv.Api) (*SitesClient, error)

func (SitesClient) DeleteSite

func (c SitesClient) DeleteSite(ctx context.Context, id VMwareSiteId) (result DeleteSiteOperationResponse, err error)

DeleteSite ...

func (SitesClient) GetSite

func (c SitesClient) GetSite(ctx context.Context, id VMwareSiteId) (result GetSiteOperationResponse, err error)

GetSite ...

func (SitesClient) GetSiteHealthSummary

func (c SitesClient) GetSiteHealthSummary(ctx context.Context, id VMwareSiteId) (result GetSiteHealthSummaryOperationResponse, err error)

GetSiteHealthSummary ...

func (SitesClient) GetSiteHealthSummaryComplete

func (c SitesClient) GetSiteHealthSummaryComplete(ctx context.Context, id VMwareSiteId) (GetSiteHealthSummaryCompleteResult, error)

GetSiteHealthSummaryComplete retrieves all the results into a single object

func (SitesClient) GetSiteHealthSummaryCompleteMatchingPredicate

func (c SitesClient) GetSiteHealthSummaryCompleteMatchingPredicate(ctx context.Context, id VMwareSiteId, predicate SiteHealthSummaryOperationPredicate) (result GetSiteHealthSummaryCompleteResult, err error)

GetSiteHealthSummaryCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SitesClient) GetSiteUsage

func (c SitesClient) GetSiteUsage(ctx context.Context, id VMwareSiteId) (result GetSiteUsageOperationResponse, err error)

GetSiteUsage ...

func (SitesClient) PatchSite

func (c SitesClient) PatchSite(ctx context.Context, id VMwareSiteId, input VMwareSite) (result PatchSiteOperationResponse, err error)

PatchSite ...

func (SitesClient) PutSite

func (c SitesClient) PutSite(ctx context.Context, id VMwareSiteId, input VMwareSite) (result PutSiteOperationResponse, err error)

PutSite ...

func (SitesClient) RefreshSite

func (c SitesClient) RefreshSite(ctx context.Context, id VMwareSiteId) (result RefreshSiteOperationResponse, err error)

RefreshSite ...

type VMwareSite

type VMwareSite struct {
	ETag       *string            `json:"eTag,omitempty"`
	Id         *string            `json:"id,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties *SiteProperties    `json:"properties,omitempty"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type VMwareSiteId

type VMwareSiteId struct {
	SubscriptionId    string
	ResourceGroupName string
	VmwareSiteName    string
}

VMwareSiteId is a struct representing the Resource ID for a V Mware Site

func NewVMwareSiteID

func NewVMwareSiteID(subscriptionId string, resourceGroupName string, vmwareSiteName string) VMwareSiteId

NewVMwareSiteID returns a new VMwareSiteId struct

func ParseVMwareSiteID

func ParseVMwareSiteID(input string) (*VMwareSiteId, error)

ParseVMwareSiteID parses 'input' into a VMwareSiteId

func ParseVMwareSiteIDInsensitively

func ParseVMwareSiteIDInsensitively(input string) (*VMwareSiteId, error)

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

func (*VMwareSiteId) FromParseResult

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

func (VMwareSiteId) ID

func (id VMwareSiteId) ID() string

ID returns the formatted V Mware Site ID

func (VMwareSiteId) Segments

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

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

func (VMwareSiteId) String

func (id VMwareSiteId) String() string

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

type VMwareSiteUsage

type VMwareSiteUsage struct {
	MachineCount      *int64 `json:"machineCount,omitempty"`
	RunAsAccountCount *int64 `json:"runAsAccountCount,omitempty"`
	VCenterCount      *int64 `json:"vCenterCount,omitempty"`
}

Jump to

Keyboard shortcuts

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