syncgroupresource

package
v0.20240320.1000025 Latest Latest
Warning

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

Go to latest
Published: Mar 20, 2024 License: MPL-2.0 Imports: 9 Imported by: 3

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagesync/2020-03-01/syncgroupresource Documentation

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

Client Initialization

client := syncgroupresource.NewSyncGroupResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SyncGroupResourceClient.SyncGroupsCreate

ctx := context.TODO()
id := syncgroupresource.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue")

payload := syncgroupresource.SyncGroupCreateParameters{
	// ...
}


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

Example Usage: SyncGroupResourceClient.SyncGroupsDelete

ctx := context.TODO()
id := syncgroupresource.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue")

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

Example Usage: SyncGroupResourceClient.SyncGroupsGet

ctx := context.TODO()
id := syncgroupresource.NewSyncGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue")

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

Example Usage: SyncGroupResourceClient.SyncGroupsListByStorageSyncService

ctx := context.TODO()
id := syncgroupresource.NewStorageSyncServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue")

read, err := client.SyncGroupsListByStorageSyncService(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 ValidateStorageSyncServiceID

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

ValidateStorageSyncServiceID checks that 'input' can be parsed as a Storage Sync Service ID

func ValidateSyncGroupID

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

ValidateSyncGroupID checks that 'input' can be parsed as a Sync Group ID

Types

type StorageSyncServiceId

type StorageSyncServiceId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
}

StorageSyncServiceId is a struct representing the Resource ID for a Storage Sync Service

func NewStorageSyncServiceID

func NewStorageSyncServiceID(subscriptionId string, resourceGroupName string, storageSyncServiceName string) StorageSyncServiceId

NewStorageSyncServiceID returns a new StorageSyncServiceId struct

func ParseStorageSyncServiceID

func ParseStorageSyncServiceID(input string) (*StorageSyncServiceId, error)

ParseStorageSyncServiceID parses 'input' into a StorageSyncServiceId

func ParseStorageSyncServiceIDInsensitively

func ParseStorageSyncServiceIDInsensitively(input string) (*StorageSyncServiceId, error)

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

func (*StorageSyncServiceId) FromParseResult

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

func (StorageSyncServiceId) ID

func (id StorageSyncServiceId) ID() string

ID returns the formatted Storage Sync Service ID

func (StorageSyncServiceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Storage Sync Service ID

func (StorageSyncServiceId) String

func (id StorageSyncServiceId) String() string

String returns a human-readable description of this Storage Sync Service ID

type SyncGroup

type SyncGroup struct {
	Id         *string              `json:"id,omitempty"`
	Name       *string              `json:"name,omitempty"`
	Properties *SyncGroupProperties `json:"properties,omitempty"`
	Type       *string              `json:"type,omitempty"`
}

type SyncGroupArray

type SyncGroupArray struct {
	Value *[]SyncGroup `json:"value,omitempty"`
}

type SyncGroupCreateParameters

type SyncGroupCreateParameters struct {
	Id         *string      `json:"id,omitempty"`
	Name       *string      `json:"name,omitempty"`
	Properties *interface{} `json:"properties,omitempty"`
	Type       *string      `json:"type,omitempty"`
}

type SyncGroupId

type SyncGroupId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
	SyncGroupName          string
}

SyncGroupId is a struct representing the Resource ID for a Sync Group

func NewSyncGroupID

func NewSyncGroupID(subscriptionId string, resourceGroupName string, storageSyncServiceName string, syncGroupName string) SyncGroupId

NewSyncGroupID returns a new SyncGroupId struct

func ParseSyncGroupID

func ParseSyncGroupID(input string) (*SyncGroupId, error)

ParseSyncGroupID parses 'input' into a SyncGroupId

func ParseSyncGroupIDInsensitively

func ParseSyncGroupIDInsensitively(input string) (*SyncGroupId, error)

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

func (*SyncGroupId) FromParseResult

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

func (SyncGroupId) ID

func (id SyncGroupId) ID() string

ID returns the formatted Sync Group ID

func (SyncGroupId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Sync Group ID

func (SyncGroupId) String

func (id SyncGroupId) String() string

String returns a human-readable description of this Sync Group ID

type SyncGroupProperties

type SyncGroupProperties struct {
	SyncGroupStatus *string `json:"syncGroupStatus,omitempty"`
	UniqueId        *string `json:"uniqueId,omitempty"`
}

type SyncGroupResourceClient

type SyncGroupResourceClient struct {
	Client *resourcemanager.Client
}

func NewSyncGroupResourceClientWithBaseURI

func NewSyncGroupResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*SyncGroupResourceClient, error)

func (SyncGroupResourceClient) SyncGroupsCreate

SyncGroupsCreate ...

func (SyncGroupResourceClient) SyncGroupsDelete

SyncGroupsDelete ...

func (SyncGroupResourceClient) SyncGroupsGet

SyncGroupsGet ...

func (SyncGroupResourceClient) SyncGroupsListByStorageSyncService

SyncGroupsListByStorageSyncService ...

type SyncGroupsCreateOperationResponse

type SyncGroupsCreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SyncGroup
}

type SyncGroupsDeleteOperationResponse

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

type SyncGroupsGetOperationResponse

type SyncGroupsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SyncGroup
}

type SyncGroupsListByStorageSyncServiceOperationResponse

type SyncGroupsListByStorageSyncServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SyncGroupArray
}

Jump to

Keyboard shortcuts

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