privateendpoint

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2022-03-01/privateendpoint Documentation

The privateendpoint SDK allows for interaction with the Azure Resource Manager Service recoveryservicesbackup (API Version 2022-03-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/recoveryservicesbackup/2022-03-01/privateendpoint"

Client Initialization

client := privateendpoint.NewPrivateEndpointClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateEndpointClient.GetOperationStatus

ctx := context.TODO()
id := privateendpoint.NewOperationsStatusID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "privateEndpointConnectionValue", "operationIdValue")

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

Documentation

Index

• func PossibleValuesForOperationStatusValues() []string
• func ValidateOperationsStatusID(input interface{}, key string) (warnings []string, errors []error)
• type ClientScriptForConnect
• type ErrorDetail
• type GetOperationStatusOperationResponse
• type InstantItemRecoveryTarget
• type OperationStatus
  • func (o *OperationStatus) GetEndTimeAsTime() (*time.Time, error)
  • func (o *OperationStatus) GetStartTimeAsTime() (*time.Time, error)
  • func (o *OperationStatus) SetEndTimeAsTime(input time.Time)
  • func (o *OperationStatus) SetStartTimeAsTime(input time.Time)
  • func (s *OperationStatus) UnmarshalJSON(bytes []byte) error
• type OperationStatusError
• type OperationStatusExtendedInfo
• type OperationStatusJobExtendedInfo
  • func (s OperationStatusJobExtendedInfo) MarshalJSON() ([]byte, error)
• type OperationStatusJobsExtendedInfo
  • func (s OperationStatusJobsExtendedInfo) MarshalJSON() ([]byte, error)
• type OperationStatusProvisionILRExtendedInfo
  • func (s OperationStatusProvisionILRExtendedInfo) MarshalJSON() ([]byte, error)
• type OperationStatusValidateOperationExtendedInfo
  • func (s OperationStatusValidateOperationExtendedInfo) MarshalJSON() ([]byte, error)
• type OperationStatusValues
• type OperationsStatusId
  • func NewOperationsStatusID(subscriptionId string, resourceGroupName string, vaultName string, ...) OperationsStatusId
  • func ParseOperationsStatusID(input string) (*OperationsStatusId, error)
  • func ParseOperationsStatusIDInsensitively(input string) (*OperationsStatusId, error)
  • func (id OperationsStatusId) ID() string
  • func (id OperationsStatusId) Segments() []resourceids.Segment
  • func (id OperationsStatusId) String() string
• type PrivateEndpointClient
  • func NewPrivateEndpointClientWithBaseURI(endpoint string) PrivateEndpointClient
  • func (c PrivateEndpointClient) GetOperationStatus(ctx context.Context, id OperationsStatusId) (result GetOperationStatusOperationResponse, err error)
• type ValidateOperationResponse

Functions

func PossibleValuesForOperationStatusValues

func PossibleValuesForOperationStatusValues() []string

func ValidateOperationsStatusID

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

ValidateOperationsStatusID checks that 'input' can be parsed as a Operations Status ID

Types

type ClientScriptForConnect

type ClientScriptForConnect struct {
	OsType           *string `json:"osType,omitempty"`
	ScriptContent    *string `json:"scriptContent,omitempty"`
	ScriptExtension  *string `json:"scriptExtension,omitempty"`
	ScriptNameSuffix *string `json:"scriptNameSuffix,omitempty"`
	Url              *string `json:"url,omitempty"`
}

type ErrorDetail

type ErrorDetail struct {
	Code            *string   `json:"code,omitempty"`
	Message         *string   `json:"message,omitempty"`
	Recommendations *[]string `json:"recommendations,omitempty"`
}

type GetOperationStatusOperationResponse

type GetOperationStatusOperationResponse struct {
	HttpResponse *http.Response
	Model        *OperationStatus
}

type InstantItemRecoveryTarget

type InstantItemRecoveryTarget struct {
	ClientScripts *[]ClientScriptForConnect `json:"clientScripts,omitempty"`
}

type OperationStatus

type OperationStatus struct {
	EndTime    *string                     `json:"endTime,omitempty"`
	Error      *OperationStatusError       `json:"error,omitempty"`
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties OperationStatusExtendedInfo `json:"properties"`
	StartTime  *string                     `json:"startTime,omitempty"`
	Status     *OperationStatusValues      `json:"status,omitempty"`
}

func (*OperationStatus) GetEndTimeAsTime

func (o *OperationStatus) GetEndTimeAsTime() (*time.Time, error)

func (*OperationStatus) GetStartTimeAsTime

func (o *OperationStatus) GetStartTimeAsTime() (*time.Time, error)

func (*OperationStatus) SetEndTimeAsTime

func (o *OperationStatus) SetEndTimeAsTime(input time.Time)

func (*OperationStatus) SetStartTimeAsTime

func (o *OperationStatus) SetStartTimeAsTime(input time.Time)

func (*OperationStatus) UnmarshalJSON

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

type OperationStatusError

type OperationStatusError struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type OperationStatusExtendedInfo

type OperationStatusExtendedInfo interface {
}

type OperationStatusJobExtendedInfo

type OperationStatusJobExtendedInfo struct {
	JobId *string `json:"jobId,omitempty"`
}

func (OperationStatusJobExtendedInfo) MarshalJSON

func (s OperationStatusJobExtendedInfo) MarshalJSON() ([]byte, error)

type OperationStatusJobsExtendedInfo

type OperationStatusJobsExtendedInfo struct {
	FailedJobsError *map[string]string `json:"failedJobsError,omitempty"`
	JobIds          *[]string          `json:"jobIds,omitempty"`
}

func (OperationStatusJobsExtendedInfo) MarshalJSON

func (s OperationStatusJobsExtendedInfo) MarshalJSON() ([]byte, error)

type OperationStatusProvisionILRExtendedInfo

type OperationStatusProvisionILRExtendedInfo struct {
	RecoveryTarget *InstantItemRecoveryTarget `json:"recoveryTarget,omitempty"`
}

func (OperationStatusProvisionILRExtendedInfo) MarshalJSON

func (s OperationStatusProvisionILRExtendedInfo) MarshalJSON() ([]byte, error)

type OperationStatusValidateOperationExtendedInfo

type OperationStatusValidateOperationExtendedInfo struct {
	ValidateOperationResponse *ValidateOperationResponse `json:"validateOperationResponse,omitempty"`
}

func (OperationStatusValidateOperationExtendedInfo) MarshalJSON

func (s OperationStatusValidateOperationExtendedInfo) MarshalJSON() ([]byte, error)

type OperationStatusValues

type OperationStatusValues string

const (
	OperationStatusValuesCanceled   OperationStatusValues = "Canceled"
	OperationStatusValuesFailed     OperationStatusValues = "Failed"
	OperationStatusValuesInProgress OperationStatusValues = "InProgress"
	OperationStatusValuesInvalid    OperationStatusValues = "Invalid"
	OperationStatusValuesSucceeded  OperationStatusValues = "Succeeded"
)

type OperationsStatusId

type OperationsStatusId struct {
	SubscriptionId                string
	ResourceGroupName             string
	VaultName                     string
	PrivateEndpointConnectionName string
	OperationId                   string
}

OperationsStatusId is a struct representing the Resource ID for a Operations Status

func NewOperationsStatusID

func NewOperationsStatusID(subscriptionId string, resourceGroupName string, vaultName string, privateEndpointConnectionName string, operationId string) OperationsStatusId

NewOperationsStatusID returns a new OperationsStatusId struct

func ParseOperationsStatusID

func ParseOperationsStatusID(input string) (*OperationsStatusId, error)

ParseOperationsStatusID parses 'input' into a OperationsStatusId

func ParseOperationsStatusIDInsensitively

func ParseOperationsStatusIDInsensitively(input string) (*OperationsStatusId, error)

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

func (OperationsStatusId) ID

func (id OperationsStatusId) ID() string

ID returns the formatted Operations Status ID

func (OperationsStatusId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Operations Status ID

func (OperationsStatusId) String

func (id OperationsStatusId) String() string

String returns a human-readable description of this Operations Status ID

type PrivateEndpointClient

type PrivateEndpointClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewPrivateEndpointClientWithBaseURI

func NewPrivateEndpointClientWithBaseURI(endpoint string) PrivateEndpointClient

func (PrivateEndpointClient) GetOperationStatus

func (c PrivateEndpointClient) GetOperationStatus(ctx context.Context, id OperationsStatusId) (result GetOperationStatusOperationResponse, err error)

GetOperationStatus ...

type ValidateOperationResponse

type ValidateOperationResponse struct {
	ValidationResults *[]ErrorDetail `json:"validationResults,omitempty"`
}