storagesyncservice

package
v0.20230627.1091640 Latest Latest
Warning

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

Go to latest
Published: Jun 27, 2023 License: MPL-2.0 Imports: 10 Imported by: 1

README

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

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

Client Initialization

client := storagesyncservice.NewStorageSyncServiceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StorageSyncServiceClient.CheckNameAvailability

ctx := context.TODO()
id := storagesyncservice.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

payload := storagesyncservice.CheckNameAvailabilityParameters{
	// ...
}


read, err := client.CheckNameAvailability(ctx, id, payload)
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 PossibleValuesForNameAvailabilityReason

func PossibleValuesForNameAvailabilityReason() []string

func PossibleValuesForType

func PossibleValuesForType() []string

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type CheckNameAvailabilityOperationResponse

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameAvailabilityResult
}

type CheckNameAvailabilityParameters

type CheckNameAvailabilityParameters struct {
	Name string `json:"name"`
	Type Type   `json:"type"`
}

type CheckNameAvailabilityResult

type CheckNameAvailabilityResult struct {
	Message       *string                 `json:"message,omitempty"`
	NameAvailable *bool                   `json:"nameAvailable,omitempty"`
	Reason        *NameAvailabilityReason `json:"reason,omitempty"`
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type NameAvailabilityReason

type NameAvailabilityReason string
const (
	NameAvailabilityReasonAlreadyExists NameAvailabilityReason = "AlreadyExists"
	NameAvailabilityReasonInvalid       NameAvailabilityReason = "Invalid"
)

func (*NameAvailabilityReason) UnmarshalJSON added in v0.20230516.1215417

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

type StorageSyncServiceClient

type StorageSyncServiceClient struct {
	Client *resourcemanager.Client
}

func NewStorageSyncServiceClientWithBaseURI

func NewStorageSyncServiceClientWithBaseURI(api environments.Api) (*StorageSyncServiceClient, error)

func (StorageSyncServiceClient) CheckNameAvailability

CheckNameAvailability ...

type Type

type Type string
const (
	TypeMicrosoftPointStorageSyncStorageSyncServices Type = "Microsoft.StorageSync/storageSyncServices"
)

func (*Type) UnmarshalJSON added in v0.20230516.1215417

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

Jump to

Keyboard shortcuts

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