replicationnetworks

package
v0.20240603.1222802 Latest Latest
Warning

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

Go to latest
Published: Jun 3, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

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

The replicationnetworks 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/replicationnetworks"

Client Initialization

client := replicationnetworks.NewReplicationNetworksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationNetworksClient.Get

ctx := context.TODO()
id := replicationnetworks.NewReplicationNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationNetworkValue")

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

ctx := context.TODO()
id := replicationnetworks.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
}

Example Usage: ReplicationNetworksClient.ListByReplicationFabrics

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

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 ValidateReplicationNetworkID

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

ValidateReplicationNetworkID checks that 'input' can be parsed as a Replication Network 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 GetOperationResponse

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

type ListByReplicationFabricsCompleteResult

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

type ListByReplicationFabricsOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type Network

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

type NetworkOperationPredicate

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

func (NetworkOperationPredicate) Matches

func (p NetworkOperationPredicate) Matches(input Network) bool

type NetworkProperties

type NetworkProperties struct {
	FabricType   *string   `json:"fabricType,omitempty"`
	FriendlyName *string   `json:"friendlyName,omitempty"`
	NetworkType  *string   `json:"networkType,omitempty"`
	Subnets      *[]Subnet `json:"subnets,omitempty"`
}

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 ReplicationNetworkId

type ReplicationNetworkId struct {
	SubscriptionId         string
	ResourceGroupName      string
	VaultName              string
	ReplicationFabricName  string
	ReplicationNetworkName string
}

ReplicationNetworkId is a struct representing the Resource ID for a Replication Network

func NewReplicationNetworkID

func NewReplicationNetworkID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string, replicationNetworkName string) ReplicationNetworkId

NewReplicationNetworkID returns a new ReplicationNetworkId struct

func ParseReplicationNetworkID

func ParseReplicationNetworkID(input string) (*ReplicationNetworkId, error)

ParseReplicationNetworkID parses 'input' into a ReplicationNetworkId

func ParseReplicationNetworkIDInsensitively

func ParseReplicationNetworkIDInsensitively(input string) (*ReplicationNetworkId, error)

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

func (*ReplicationNetworkId) FromParseResult

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

func (ReplicationNetworkId) ID

func (id ReplicationNetworkId) ID() string

ID returns the formatted Replication Network ID

func (ReplicationNetworkId) Segments

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

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

func (ReplicationNetworkId) String

func (id ReplicationNetworkId) String() string

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

type ReplicationNetworksClient

type ReplicationNetworksClient struct {
	Client *resourcemanager.Client
}

func NewReplicationNetworksClientWithBaseURI

func NewReplicationNetworksClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationNetworksClient, error)

func (ReplicationNetworksClient) Get

Get ...

func (ReplicationNetworksClient) List

List ...

func (ReplicationNetworksClient) ListByReplicationFabrics

ListByReplicationFabrics ...

func (ReplicationNetworksClient) ListByReplicationFabricsComplete

ListByReplicationFabricsComplete retrieves all the results into a single object

func (ReplicationNetworksClient) ListByReplicationFabricsCompleteMatchingPredicate

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

ListByReplicationFabricsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ReplicationNetworksClient) ListComplete

ListComplete retrieves all the results into a single object

func (ReplicationNetworksClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type Subnet

type Subnet struct {
	AddressList  *[]string `json:"addressList,omitempty"`
	FriendlyName *string   `json:"friendlyName,omitempty"`
	Name         *string   `json:"name,omitempty"`
}

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

Jump to

Keyboard shortcuts

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