elasticsan

README

github.com/hashicorp/go-azure-sdk/resource-manager/elasticsan/2023-01-01/elasticsan Documentation

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

Client Initialization

client := elasticsan.NewElasticSanClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ElasticSanClient.ListByResourceGroup

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

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

Documentation

Index

• func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string
• func PossibleValuesForProvisioningStates() []string
• func PossibleValuesForPublicNetworkAccess() []string
• func PossibleValuesForSkuName() []string
• func PossibleValuesForSkuTier() []string
• type ElasticSan
• type ElasticSanClient
  • func NewElasticSanClientWithBaseURI(sdkApi sdkEnv.Api) (*ElasticSanClient, error)
  • func (c ElasticSanClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
  • func (c ElasticSanClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
  • func (c ElasticSanClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupCompleteResult, err error)
• type ElasticSanOperationPredicate
  • func (p ElasticSanOperationPredicate) Matches(input ElasticSan) bool
• type ElasticSanProperties
• type ListByResourceGroupCompleteResult
• type ListByResourceGroupOperationResponse
• type PrivateEndpoint
• type PrivateEndpointConnection
• type PrivateEndpointConnectionProperties
• type PrivateEndpointServiceConnectionStatus
  • func (s *PrivateEndpointServiceConnectionStatus) UnmarshalJSON(bytes []byte) error
• type PrivateLinkServiceConnectionState
• type ProvisioningStates
  • func (s *ProvisioningStates) UnmarshalJSON(bytes []byte) error
• type PublicNetworkAccess
  • func (s *PublicNetworkAccess) UnmarshalJSON(bytes []byte) error
• type Sku
• type SkuName
  • func (s *SkuName) UnmarshalJSON(bytes []byte) error
• type SkuTier
  • func (s *SkuTier) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForPrivateEndpointServiceConnectionStatus

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func PossibleValuesForProvisioningStates

func PossibleValuesForProvisioningStates() []string

func PossibleValuesForPublicNetworkAccess

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

Types

type ElasticSan

type ElasticSan struct {
	Id         *string                `json:"id,omitempty"`
	Location   string                 `json:"location"`
	Name       *string                `json:"name,omitempty"`
	Properties ElasticSanProperties   `json:"properties"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ElasticSanClient

type ElasticSanClient struct {
	Client *resourcemanager.Client
}

func NewElasticSanClientWithBaseURI

func NewElasticSanClientWithBaseURI(sdkApi sdkEnv.Api) (*ElasticSanClient, error)

func (ElasticSanClient) ListByResourceGroup

func (c ElasticSanClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ElasticSanClient) ListByResourceGroupComplete

func (c ElasticSanClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (ElasticSanClient) ListByResourceGroupCompleteMatchingPredicate

func (c ElasticSanClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ElasticSanOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ElasticSanOperationPredicate

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

func (ElasticSanOperationPredicate) Matches

func (p ElasticSanOperationPredicate) Matches(input ElasticSan) bool

type ElasticSanProperties

type ElasticSanProperties struct {
	AvailabilityZones          *zones.Schema                `json:"availabilityZones,omitempty"`
	BaseSizeTiB                int64                        `json:"baseSizeTiB"`
	ExtendedCapacitySizeTiB    int64                        `json:"extendedCapacitySizeTiB"`
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *ProvisioningStates          `json:"provisioningState,omitempty"`
	PublicNetworkAccess        *PublicNetworkAccess         `json:"publicNetworkAccess,omitempty"`
	Sku                        Sku                          `json:"sku"`
	TotalIops                  *int64                       `json:"totalIops,omitempty"`
	TotalMBps                  *int64                       `json:"totalMBps,omitempty"`
	TotalSizeTiB               *int64                       `json:"totalSizeTiB,omitempty"`
	TotalVolumeSizeGiB         *int64                       `json:"totalVolumeSizeGiB,omitempty"`
	VolumeGroupCount           *int64                       `json:"volumeGroupCount,omitempty"`
}

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []ElasticSan
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ElasticSan
}

type PrivateEndpoint

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection

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

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                         `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint                  `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *ProvisioningStates               `json:"provisioningState,omitempty"`
}

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string

const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusFailed   PrivateEndpointServiceConnectionStatus = "Failed"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON

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

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                                 `json:"actionsRequired,omitempty"`
	Description     *string                                 `json:"description,omitempty"`
	Status          *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

type ProvisioningStates

type ProvisioningStates string

const (
	ProvisioningStatesCanceled  ProvisioningStates = "Canceled"
	ProvisioningStatesCreating  ProvisioningStates = "Creating"
	ProvisioningStatesDeleting  ProvisioningStates = "Deleting"
	ProvisioningStatesFailed    ProvisioningStates = "Failed"
	ProvisioningStatesInvalid   ProvisioningStates = "Invalid"
	ProvisioningStatesPending   ProvisioningStates = "Pending"
	ProvisioningStatesSucceeded ProvisioningStates = "Succeeded"
	ProvisioningStatesUpdating  ProvisioningStates = "Updating"
)

func (*ProvisioningStates) UnmarshalJSON

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

type PublicNetworkAccess

type PublicNetworkAccess string

const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON

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

type Sku

type Sku struct {
	Name SkuName  `json:"name"`
	Tier *SkuTier `json:"tier,omitempty"`
}

type SkuName

type SkuName string

const (
	SkuNamePremiumLRS SkuName = "Premium_LRS"
	SkuNamePremiumZRS SkuName = "Premium_ZRS"
)

func (*SkuName) UnmarshalJSON

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

type SkuTier

type SkuTier string

const (
	SkuTierPremium SkuTier = "Premium"
)

func (*SkuTier) UnmarshalJSON

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