replicationvaultsetting

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: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicessiterecovery/2023-06-01/replicationvaultsetting Documentation

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

Client Initialization

client := replicationvaultsetting.NewReplicationVaultSettingClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationVaultSettingClient.Create

ctx := context.TODO()
id := replicationvaultsetting.NewReplicationVaultSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationVaultSettingValue")

payload := replicationvaultsetting.VaultSettingCreationInput{
	// ...
}


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

Example Usage: ReplicationVaultSettingClient.Get

ctx := context.TODO()
id := replicationvaultsetting.NewReplicationVaultSettingID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationVaultSettingValue")

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

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

// 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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateReplicationVaultSettingID 

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

ValidateReplicationVaultSettingID checks that 'input' can be parsed as a Replication Vault Setting 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 CreateOperationResponse 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListOperationResponse 

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

type ReplicationVaultSettingClient 

type ReplicationVaultSettingClient struct {
	Client *resourcemanager.Client
}

func NewReplicationVaultSettingClientWithBaseURI 

func NewReplicationVaultSettingClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationVaultSettingClient, error)

func (ReplicationVaultSettingClient) Create 

func (c ReplicationVaultSettingClient) Create(ctx context.Context, id ReplicationVaultSettingId, input VaultSettingCreationInput) (result CreateOperationResponse, err error)

Create ...

func (ReplicationVaultSettingClient) CreateThenPoll 

func (c ReplicationVaultSettingClient) CreateThenPoll(ctx context.Context, id ReplicationVaultSettingId, input VaultSettingCreationInput) error

CreateThenPoll performs Create then polls until it's completed

func (ReplicationVaultSettingClient) Get 

func (c ReplicationVaultSettingClient) Get(ctx context.Context, id ReplicationVaultSettingId) (result GetOperationResponse, err error)

Get ...

func (ReplicationVaultSettingClient) List 

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

List ...

func (ReplicationVaultSettingClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ReplicationVaultSettingClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ReplicationVaultSettingId 

type ReplicationVaultSettingId struct {
	SubscriptionId              string
	ResourceGroupName           string
	VaultName                   string
	ReplicationVaultSettingName string
}

ReplicationVaultSettingId is a struct representing the Resource ID for a Replication Vault Setting

func NewReplicationVaultSettingID 

func NewReplicationVaultSettingID(subscriptionId string, resourceGroupName string, vaultName string, replicationVaultSettingName string) ReplicationVaultSettingId

NewReplicationVaultSettingID returns a new ReplicationVaultSettingId struct

func ParseReplicationVaultSettingID 

func ParseReplicationVaultSettingID(input string) (*ReplicationVaultSettingId, error)

ParseReplicationVaultSettingID parses 'input' into a ReplicationVaultSettingId

func ParseReplicationVaultSettingIDInsensitively 

func ParseReplicationVaultSettingIDInsensitively(input string) (*ReplicationVaultSettingId, error)

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

func (*ReplicationVaultSettingId) FromParseResult 

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

func (ReplicationVaultSettingId) ID 

func (id ReplicationVaultSettingId) ID() string

ID returns the formatted Replication Vault Setting ID

func (ReplicationVaultSettingId) Segments 

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

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

func (ReplicationVaultSettingId) String 

func (id ReplicationVaultSettingId) String() string

String returns a human-readable description of this Replication Vault Setting ID

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

type VaultSetting 

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

type VaultSettingCreationInput 

type VaultSettingCreationInput struct {
	Properties VaultSettingCreationInputProperties `json:"properties"`
}

type VaultSettingCreationInputProperties 

type VaultSettingCreationInputProperties struct {
	MigrationSolutionId       *string `json:"migrationSolutionId,omitempty"`
	VMwareToAzureProviderType *string `json:"vmwareToAzureProviderType,omitempty"`
}

type VaultSettingOperationPredicate 

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

func (VaultSettingOperationPredicate) Matches 

func (p VaultSettingOperationPredicate) Matches(input VaultSetting) bool

type VaultSettingProperties 

type VaultSettingProperties struct {
	MigrationSolutionId       *string `json:"migrationSolutionId,omitempty"`
	VMwareToAzureProviderType *string `json:"vmwareToAzureProviderType,omitempty"`
}

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.