replicationvcenters

package
v0.20240923.1151247 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicessiterecovery/2023-02-01/replicationvcenters Documentation

The replicationvcenters SDK allows for interaction with Azure Resource Manager recoveryservicessiterecovery (API Version 2023-02-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/recoveryservicessiterecovery/2023-02-01/replicationvcenters"

Client Initialization

client := replicationvcenters.NewReplicationvCentersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationvCentersClient.Create

ctx := context.TODO()
id := replicationvcenters.NewReplicationvCenterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "resourceName", "fabricName", "vcenterName")

payload := replicationvcenters.AddVCenterRequest{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ReplicationvCentersClient.Delete

ctx := context.TODO()
id := replicationvcenters.NewReplicationvCenterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "resourceName", "fabricName", "vcenterName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ReplicationvCentersClient.Get

ctx := context.TODO()
id := replicationvcenters.NewReplicationvCenterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "resourceName", "fabricName", "vcenterName")

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: ReplicationvCentersClient.List

ctx := context.TODO()
id := replicationvcenters.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "resourceName")

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

Example Usage: ReplicationvCentersClient.ListByReplicationFabrics

ctx := context.TODO()
id := replicationvcenters.NewReplicationFabricID("12345678-1234-9876-4563-123456789012", "example-resource-group", "resourceName", "fabricName")

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

Example Usage: ReplicationvCentersClient.Update

ctx := context.TODO()
id := replicationvcenters.NewReplicationvCenterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "resourceName", "fabricName", "vcenterName")

payload := replicationvcenters.UpdateVCenterRequest{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForHealthErrorCustomerResolvability 

func PossibleValuesForHealthErrorCustomerResolvability() []string

func ValidateReplicationFabricID 

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

ValidateReplicationFabricID checks that 'input' can be parsed as a Replication Fabric ID

func ValidateReplicationvCenterID 

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

ValidateReplicationvCenterID checks that 'input' can be parsed as a Replicationv Center ID

func ValidateVaultID 

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

ValidateVaultID checks that 'input' can be parsed as a Vault ID

Types

type AddVCenterRequest 

type AddVCenterRequest struct {
	Properties *AddVCenterRequestProperties `json:"properties,omitempty"`
}

type AddVCenterRequestProperties 

type AddVCenterRequestProperties struct {
	FriendlyName    *string `json:"friendlyName,omitempty"`
	IPAddress       *string `json:"ipAddress,omitempty"`
	Port            *string `json:"port,omitempty"`
	ProcessServerId *string `json:"processServerId,omitempty"`
	RunAsAccountId  *string `json:"runAsAccountId,omitempty"`
}

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VCenter
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

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

type HealthError 

type HealthError struct {
	CreationTimeUtc              *string                           `json:"creationTimeUtc,omitempty"`
	CustomerResolvability        *HealthErrorCustomerResolvability `json:"customerResolvability,omitempty"`
	EntityId                     *string                           `json:"entityId,omitempty"`
	ErrorCategory                *string                           `json:"errorCategory,omitempty"`
	ErrorCode                    *string                           `json:"errorCode,omitempty"`
	ErrorId                      *string                           `json:"errorId,omitempty"`
	ErrorLevel                   *string                           `json:"errorLevel,omitempty"`
	ErrorMessage                 *string                           `json:"errorMessage,omitempty"`
	ErrorSource                  *string                           `json:"errorSource,omitempty"`
	ErrorType                    *string                           `json:"errorType,omitempty"`
	InnerHealthErrors            *[]InnerHealthError               `json:"innerHealthErrors,omitempty"`
	PossibleCauses               *string                           `json:"possibleCauses,omitempty"`
	RecommendedAction            *string                           `json:"recommendedAction,omitempty"`
	RecoveryProviderErrorMessage *string                           `json:"recoveryProviderErrorMessage,omitempty"`
	SummaryMessage               *string                           `json:"summaryMessage,omitempty"`
}

func (*HealthError) GetCreationTimeUtcAsTime 

func (o *HealthError) GetCreationTimeUtcAsTime() (*time.Time, error)

func (*HealthError) SetCreationTimeUtcAsTime 

func (o *HealthError) SetCreationTimeUtcAsTime(input time.Time)

type HealthErrorCustomerResolvability 

type HealthErrorCustomerResolvability string
const (
	HealthErrorCustomerResolvabilityAllowed    HealthErrorCustomerResolvability = "Allowed"
	HealthErrorCustomerResolvabilityNotAllowed HealthErrorCustomerResolvability = "NotAllowed"
)

func (*HealthErrorCustomerResolvability) UnmarshalJSON 

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

type InnerHealthError 

type InnerHealthError struct {
	CreationTimeUtc              *string                           `json:"creationTimeUtc,omitempty"`
	CustomerResolvability        *HealthErrorCustomerResolvability `json:"customerResolvability,omitempty"`
	EntityId                     *string                           `json:"entityId,omitempty"`
	ErrorCategory                *string                           `json:"errorCategory,omitempty"`
	ErrorCode                    *string                           `json:"errorCode,omitempty"`
	ErrorId                      *string                           `json:"errorId,omitempty"`
	ErrorLevel                   *string                           `json:"errorLevel,omitempty"`
	ErrorMessage                 *string                           `json:"errorMessage,omitempty"`
	ErrorSource                  *string                           `json:"errorSource,omitempty"`
	ErrorType                    *string                           `json:"errorType,omitempty"`
	PossibleCauses               *string                           `json:"possibleCauses,omitempty"`
	RecommendedAction            *string                           `json:"recommendedAction,omitempty"`
	RecoveryProviderErrorMessage *string                           `json:"recoveryProviderErrorMessage,omitempty"`
	SummaryMessage               *string                           `json:"summaryMessage,omitempty"`
}

func (*InnerHealthError) GetCreationTimeUtcAsTime 

func (o *InnerHealthError) GetCreationTimeUtcAsTime() (*time.Time, error)

func (*InnerHealthError) SetCreationTimeUtcAsTime 

func (o *InnerHealthError) SetCreationTimeUtcAsTime(input time.Time)

type ListByReplicationFabricsCompleteResult 

type ListByReplicationFabricsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []VCenter
}

type ListByReplicationFabricsCustomPager added in v0.20240628.1153531 

type ListByReplicationFabricsCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByReplicationFabricsCustomPager) NextPageLink() *odata.Link

type ListByReplicationFabricsOperationResponse 

type ListByReplicationFabricsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]VCenter
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []VCenter
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]VCenter
}

type ReplicationFabricId 

type ReplicationFabricId struct {
	SubscriptionId        string
	ResourceGroupName     string
	VaultName             string
	ReplicationFabricName string
}

ReplicationFabricId is a struct representing the Resource ID for a Replication Fabric

func NewReplicationFabricID 

func NewReplicationFabricID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string) ReplicationFabricId

NewReplicationFabricID returns a new ReplicationFabricId struct

func ParseReplicationFabricID 

func ParseReplicationFabricID(input string) (*ReplicationFabricId, error)

ParseReplicationFabricID parses 'input' into a ReplicationFabricId

func ParseReplicationFabricIDInsensitively 

func ParseReplicationFabricIDInsensitively(input string) (*ReplicationFabricId, error)

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

func (*ReplicationFabricId) FromParseResult 

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

func (ReplicationFabricId) ID 

func (id ReplicationFabricId) ID() string

ID returns the formatted Replication Fabric ID

func (ReplicationFabricId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Replication Fabric ID

func (ReplicationFabricId) String 

func (id ReplicationFabricId) String() string

String returns a human-readable description of this Replication Fabric ID

type ReplicationvCenterId 

type ReplicationvCenterId struct {
	SubscriptionId         string
	ResourceGroupName      string
	VaultName              string
	ReplicationFabricName  string
	ReplicationvCenterName string
}

ReplicationvCenterId is a struct representing the Resource ID for a Replicationv Center

func NewReplicationvCenterID 

func NewReplicationvCenterID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string, replicationvCenterName string) ReplicationvCenterId

NewReplicationvCenterID returns a new ReplicationvCenterId struct

func ParseReplicationvCenterID 

func ParseReplicationvCenterID(input string) (*ReplicationvCenterId, error)

ParseReplicationvCenterID parses 'input' into a ReplicationvCenterId

func ParseReplicationvCenterIDInsensitively 

func ParseReplicationvCenterIDInsensitively(input string) (*ReplicationvCenterId, error)

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

func (*ReplicationvCenterId) FromParseResult 

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

func (ReplicationvCenterId) ID 

func (id ReplicationvCenterId) ID() string

ID returns the formatted Replicationv Center ID

func (ReplicationvCenterId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Replicationv Center ID

func (ReplicationvCenterId) String 

func (id ReplicationvCenterId) String() string

String returns a human-readable description of this Replicationv Center ID

type ReplicationvCentersClient 

type ReplicationvCentersClient struct {
	Client *resourcemanager.Client
}

func NewReplicationvCentersClientWithBaseURI 

func NewReplicationvCentersClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationvCentersClient, error)

func (ReplicationvCentersClient) Create 

func (c ReplicationvCentersClient) Create(ctx context.Context, id ReplicationvCenterId, input AddVCenterRequest) (result CreateOperationResponse, err error)

Create ...

func (ReplicationvCentersClient) CreateThenPoll 

func (c ReplicationvCentersClient) CreateThenPoll(ctx context.Context, id ReplicationvCenterId, input AddVCenterRequest) error

CreateThenPoll performs Create then polls until it's completed

func (ReplicationvCentersClient) Delete 

func (c ReplicationvCentersClient) Delete(ctx context.Context, id ReplicationvCenterId) (result DeleteOperationResponse, err error)

Delete ...

func (ReplicationvCentersClient) DeleteThenPoll 

func (c ReplicationvCentersClient) DeleteThenPoll(ctx context.Context, id ReplicationvCenterId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ReplicationvCentersClient) Get 

func (c ReplicationvCentersClient) Get(ctx context.Context, id ReplicationvCenterId) (result GetOperationResponse, err error)

Get ...

func (ReplicationvCentersClient) List 

func (c ReplicationvCentersClient) List(ctx context.Context, id VaultId) (result ListOperationResponse, err error)

List ...

func (ReplicationvCentersClient) ListByReplicationFabrics 

func (c ReplicationvCentersClient) ListByReplicationFabrics(ctx context.Context, id ReplicationFabricId) (result ListByReplicationFabricsOperationResponse, err error)

ListByReplicationFabrics ...

func (ReplicationvCentersClient) ListByReplicationFabricsComplete 

func (c ReplicationvCentersClient) ListByReplicationFabricsComplete(ctx context.Context, id ReplicationFabricId) (ListByReplicationFabricsCompleteResult, error)

ListByReplicationFabricsComplete retrieves all the results into a single object

func (ReplicationvCentersClient) ListByReplicationFabricsCompleteMatchingPredicate 

func (c ReplicationvCentersClient) ListByReplicationFabricsCompleteMatchingPredicate(ctx context.Context, id ReplicationFabricId, predicate VCenterOperationPredicate) (result ListByReplicationFabricsCompleteResult, err error)

ListByReplicationFabricsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ReplicationvCentersClient) ListComplete 

func (c ReplicationvCentersClient) ListComplete(ctx context.Context, id VaultId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ReplicationvCentersClient) ListCompleteMatchingPredicate 

func (c ReplicationvCentersClient) ListCompleteMatchingPredicate(ctx context.Context, id VaultId, predicate VCenterOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ReplicationvCentersClient) Update 

func (c ReplicationvCentersClient) Update(ctx context.Context, id ReplicationvCenterId, input UpdateVCenterRequest) (result UpdateOperationResponse, err error)

Update ...

func (ReplicationvCentersClient) UpdateThenPoll 

func (c ReplicationvCentersClient) UpdateThenPoll(ctx context.Context, id ReplicationvCenterId, input UpdateVCenterRequest) error

UpdateThenPoll performs Update then polls until it's completed

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VCenter
}

type UpdateVCenterRequest 

type UpdateVCenterRequest struct {
	Properties *UpdateVCenterRequestProperties `json:"properties,omitempty"`
}

type UpdateVCenterRequestProperties 

type UpdateVCenterRequestProperties struct {
	FriendlyName    *string `json:"friendlyName,omitempty"`
	IPAddress       *string `json:"ipAddress,omitempty"`
	Port            *string `json:"port,omitempty"`
	ProcessServerId *string `json:"processServerId,omitempty"`
	RunAsAccountId  *string `json:"runAsAccountId,omitempty"`
}

type VCenter 

type VCenter struct {
	Id         *string            `json:"id,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties *VCenterProperties `json:"properties,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type VCenterOperationPredicate 

type VCenterOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (VCenterOperationPredicate) Matches 

func (p VCenterOperationPredicate) Matches(input VCenter) bool

type VCenterProperties 

type VCenterProperties struct {
	DiscoveryStatus       *string        `json:"discoveryStatus,omitempty"`
	FabricArmResourceName *string        `json:"fabricArmResourceName,omitempty"`
	FriendlyName          *string        `json:"friendlyName,omitempty"`
	HealthErrors          *[]HealthError `json:"healthErrors,omitempty"`
	IPAddress             *string        `json:"ipAddress,omitempty"`
	InfrastructureId      *string        `json:"infrastructureId,omitempty"`
	InternalId            *string        `json:"internalId,omitempty"`
	LastHeartbeat         *string        `json:"lastHeartbeat,omitempty"`
	Port                  *string        `json:"port,omitempty"`
	ProcessServerId       *string        `json:"processServerId,omitempty"`
	RunAsAccountId        *string        `json:"runAsAccountId,omitempty"`
}

func (*VCenterProperties) GetLastHeartbeatAsTime 

func (o *VCenterProperties) GetLastHeartbeatAsTime() (*time.Time, error)

func (*VCenterProperties) SetLastHeartbeatAsTime 

func (o *VCenterProperties) SetLastHeartbeatAsTime(input time.Time)

type VaultId 

type VaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
}

VaultId is a struct representing the Resource ID for a Vault

func NewVaultID 

func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId

NewVaultID returns a new VaultId struct

func ParseVaultID 

func ParseVaultID(input string) (*VaultId, error)

ParseVaultID parses 'input' into a VaultId

func ParseVaultIDInsensitively 

func ParseVaultIDInsensitively(input string) (*VaultId, error)

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

func (*VaultId) FromParseResult 

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

func (VaultId) ID 

func (id VaultId) ID() string

ID returns the formatted Vault ID

func (VaultId) Segments 

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

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

func (VaultId) String 

func (id VaultId) String() string

String returns a human-readable description of this Vault ID

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.