iscsipaths

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2023-09-01/iscsipaths Documentation

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

Client Initialization

client := iscsipaths.NewIscsiPathsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IscsiPathsClient.CreateOrUpdate

ctx := context.TODO()
id := iscsipaths.NewPrivateCloudID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue")

payload := iscsipaths.IscsiPath{
	// ...
}


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

Example Usage: IscsiPathsClient.Delete

ctx := context.TODO()
id := iscsipaths.NewPrivateCloudID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue")

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

Example Usage: IscsiPathsClient.Get

ctx := context.TODO()
id := iscsipaths.NewPrivateCloudID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue")

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: IscsiPathsClient.ListByPrivateCloud

ctx := context.TODO()
id := iscsipaths.NewPrivateCloudID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue")

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

Documentation

Index

• func PossibleValuesForIscsiPathProvisioningState() []string
• func ValidatePrivateCloudID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type IscsiPath
• type IscsiPathOperationPredicate
  • func (p IscsiPathOperationPredicate) Matches(input IscsiPath) bool
• type IscsiPathProperties
• type IscsiPathProvisioningState
  • func (s *IscsiPathProvisioningState) UnmarshalJSON(bytes []byte) error
• type IscsiPathsClient
  • func NewIscsiPathsClientWithBaseURI(sdkApi sdkEnv.Api) (*IscsiPathsClient, error)
  • func (c IscsiPathsClient) CreateOrUpdate(ctx context.Context, id PrivateCloudId, input IscsiPath) (result CreateOrUpdateOperationResponse, err error)
  • func (c IscsiPathsClient) CreateOrUpdateThenPoll(ctx context.Context, id PrivateCloudId, input IscsiPath) error
  • func (c IscsiPathsClient) Delete(ctx context.Context, id PrivateCloudId) (result DeleteOperationResponse, err error)
  • func (c IscsiPathsClient) DeleteThenPoll(ctx context.Context, id PrivateCloudId) error
  • func (c IscsiPathsClient) Get(ctx context.Context, id PrivateCloudId) (result GetOperationResponse, err error)
  • func (c IscsiPathsClient) ListByPrivateCloud(ctx context.Context, id PrivateCloudId) (result ListByPrivateCloudOperationResponse, err error)
  • func (c IscsiPathsClient) ListByPrivateCloudComplete(ctx context.Context, id PrivateCloudId) (ListByPrivateCloudCompleteResult, error)
  • func (c IscsiPathsClient) ListByPrivateCloudCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate IscsiPathOperationPredicate) (result ListByPrivateCloudCompleteResult, err error)
• type ListByPrivateCloudCompleteResult
• type ListByPrivateCloudOperationResponse
• type PrivateCloudId
  • func NewPrivateCloudID(subscriptionId string, resourceGroupName string, privateCloudName string) PrivateCloudId
  • func ParsePrivateCloudID(input string) (*PrivateCloudId, error)
  • func ParsePrivateCloudIDInsensitively(input string) (*PrivateCloudId, error)
  • func (id *PrivateCloudId) FromParseResult(input resourceids.ParseResult) error
  • func (id PrivateCloudId) ID() string
  • func (id PrivateCloudId) Segments() []resourceids.Segment
  • func (id PrivateCloudId) String() string

Functions

func PossibleValuesForIscsiPathProvisioningState

func PossibleValuesForIscsiPathProvisioningState() []string

func ValidatePrivateCloudID

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

ValidatePrivateCloudID checks that 'input' can be parsed as a Private Cloud ID

Types

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IscsiPath
}

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        *IscsiPath
}

type IscsiPath

type IscsiPath struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *IscsiPathProperties   `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type IscsiPathOperationPredicate

type IscsiPathOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (IscsiPathOperationPredicate) Matches

func (p IscsiPathOperationPredicate) Matches(input IscsiPath) bool

type IscsiPathProperties

type IscsiPathProperties struct {
	NetworkBlock      string                      `json:"networkBlock"`
	ProvisioningState *IscsiPathProvisioningState `json:"provisioningState,omitempty"`
}

type IscsiPathProvisioningState

type IscsiPathProvisioningState string

const (
	IscsiPathProvisioningStateBuilding  IscsiPathProvisioningState = "Building"
	IscsiPathProvisioningStateCanceled  IscsiPathProvisioningState = "Canceled"
	IscsiPathProvisioningStateDeleting  IscsiPathProvisioningState = "Deleting"
	IscsiPathProvisioningStateFailed    IscsiPathProvisioningState = "Failed"
	IscsiPathProvisioningStatePending   IscsiPathProvisioningState = "Pending"
	IscsiPathProvisioningStateSucceeded IscsiPathProvisioningState = "Succeeded"
	IscsiPathProvisioningStateUpdating  IscsiPathProvisioningState = "Updating"
)

func (*IscsiPathProvisioningState) UnmarshalJSON

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

type IscsiPathsClient

type IscsiPathsClient struct {
	Client *resourcemanager.Client
}

func NewIscsiPathsClientWithBaseURI

func NewIscsiPathsClientWithBaseURI(sdkApi sdkEnv.Api) (*IscsiPathsClient, error)

func (IscsiPathsClient) CreateOrUpdate

func (c IscsiPathsClient) CreateOrUpdate(ctx context.Context, id PrivateCloudId, input IscsiPath) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (IscsiPathsClient) CreateOrUpdateThenPoll

func (c IscsiPathsClient) CreateOrUpdateThenPoll(ctx context.Context, id PrivateCloudId, input IscsiPath) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (IscsiPathsClient) Delete

func (c IscsiPathsClient) Delete(ctx context.Context, id PrivateCloudId) (result DeleteOperationResponse, err error)

Delete ...

func (IscsiPathsClient) DeleteThenPoll

func (c IscsiPathsClient) DeleteThenPoll(ctx context.Context, id PrivateCloudId) error

DeleteThenPoll performs Delete then polls until it's completed

func (IscsiPathsClient) Get

func (c IscsiPathsClient) Get(ctx context.Context, id PrivateCloudId) (result GetOperationResponse, err error)

Get ...

func (IscsiPathsClient) ListByPrivateCloud

func (c IscsiPathsClient) ListByPrivateCloud(ctx context.Context, id PrivateCloudId) (result ListByPrivateCloudOperationResponse, err error)

ListByPrivateCloud ...

func (IscsiPathsClient) ListByPrivateCloudComplete

func (c IscsiPathsClient) ListByPrivateCloudComplete(ctx context.Context, id PrivateCloudId) (ListByPrivateCloudCompleteResult, error)

ListByPrivateCloudComplete retrieves all the results into a single object

func (IscsiPathsClient) ListByPrivateCloudCompleteMatchingPredicate

func (c IscsiPathsClient) ListByPrivateCloudCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate IscsiPathOperationPredicate) (result ListByPrivateCloudCompleteResult, err error)

ListByPrivateCloudCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListByPrivateCloudCompleteResult

type ListByPrivateCloudCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []IscsiPath
}

type ListByPrivateCloudOperationResponse

type ListByPrivateCloudOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]IscsiPath
}

type PrivateCloudId

type PrivateCloudId struct {
	SubscriptionId    string
	ResourceGroupName string
	PrivateCloudName  string
}

PrivateCloudId is a struct representing the Resource ID for a Private Cloud

func NewPrivateCloudID

func NewPrivateCloudID(subscriptionId string, resourceGroupName string, privateCloudName string) PrivateCloudId

NewPrivateCloudID returns a new PrivateCloudId struct

func ParsePrivateCloudID

func ParsePrivateCloudID(input string) (*PrivateCloudId, error)

ParsePrivateCloudID parses 'input' into a PrivateCloudId

func ParsePrivateCloudIDInsensitively

func ParsePrivateCloudIDInsensitively(input string) (*PrivateCloudId, error)

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

func (*PrivateCloudId) FromParseResult

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

func (PrivateCloudId) ID

func (id PrivateCloudId) ID() string

ID returns the formatted Private Cloud ID

func (PrivateCloudId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Private Cloud ID

func (PrivateCloudId) String

func (id PrivateCloudId) String() string

String returns a human-readable description of this Private Cloud ID