netappresource

package
v0.20240320.1105218 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: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2023-07-01/netappresource Documentation

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

Client Initialization

client := netappresource.NewNetAppResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetAppResourceClient.CheckFilePathAvailability

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

payload := netappresource.FilePathAvailabilityRequest{
	// ...
}


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

Example Usage: NetAppResourceClient.CheckNameAvailability

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

payload := netappresource.ResourceNameAvailabilityRequest{
	// ...
}


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
}

Example Usage: NetAppResourceClient.CheckQuotaAvailability

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

payload := netappresource.QuotaAvailabilityRequest{
	// ...
}


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

Example Usage: NetAppResourceClient.QueryNetworkSiblingSet

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

payload := netappresource.QueryNetworkSiblingSetRequest{
	// ...
}


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

Example Usage: NetAppResourceClient.QueryRegionInfo

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

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

Example Usage: NetAppResourceClient.QuotaLimitsGet

ctx := context.TODO()
id := netappresource.NewQuotaLimitID("12345678-1234-9876-4563-123456789012", "locationValue", "quotaLimitValue")

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

Example Usage: NetAppResourceClient.QuotaLimitsList

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

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

Example Usage: NetAppResourceClient.UpdateNetworkSiblingSet

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

payload := netappresource.UpdateNetworkSiblingSetRequest{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCheckNameResourceTypes

func PossibleValuesForCheckNameResourceTypes() []string

func PossibleValuesForCheckQuotaNameResourceTypes

func PossibleValuesForCheckQuotaNameResourceTypes() []string

func PossibleValuesForInAvailabilityReasonType

func PossibleValuesForInAvailabilityReasonType() []string

func PossibleValuesForNetworkFeatures

func PossibleValuesForNetworkFeatures() []string

func PossibleValuesForNetworkSiblingSetProvisioningState

func PossibleValuesForNetworkSiblingSetProvisioningState() []string

func PossibleValuesForRegionStorageToNetworkProximity

func PossibleValuesForRegionStorageToNetworkProximity() []string

func ValidateLocationID

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

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

func ValidateQuotaLimitID

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

ValidateQuotaLimitID checks that 'input' can be parsed as a Quota Limit ID

Types

type CheckAvailabilityResponse

type CheckAvailabilityResponse struct {
	IsAvailable *bool                     `json:"isAvailable,omitempty"`
	Message     *string                   `json:"message,omitempty"`
	Reason      *InAvailabilityReasonType `json:"reason,omitempty"`
}

type CheckFilePathAvailabilityOperationResponse

type CheckFilePathAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckAvailabilityResponse
}

type CheckNameAvailabilityOperationResponse

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

type CheckNameResourceTypes

type CheckNameResourceTypes string
const (
	CheckNameResourceTypesMicrosoftPointNetAppNetAppAccounts                              CheckNameResourceTypes = "Microsoft.NetApp/netAppAccounts"
	CheckNameResourceTypesMicrosoftPointNetAppNetAppAccountsCapacityPools                 CheckNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools"
	CheckNameResourceTypesMicrosoftPointNetAppNetAppAccountsCapacityPoolsVolumes          CheckNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes"
	CheckNameResourceTypesMicrosoftPointNetAppNetAppAccountsCapacityPoolsVolumesSnapshots CheckNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots"
)

func (*CheckNameResourceTypes) UnmarshalJSON

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

type CheckQuotaAvailabilityOperationResponse

type CheckQuotaAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckAvailabilityResponse
}

type CheckQuotaNameResourceTypes

type CheckQuotaNameResourceTypes string
const (
	CheckQuotaNameResourceTypesMicrosoftPointNetAppNetAppAccounts                              CheckQuotaNameResourceTypes = "Microsoft.NetApp/netAppAccounts"
	CheckQuotaNameResourceTypesMicrosoftPointNetAppNetAppAccountsCapacityPools                 CheckQuotaNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools"
	CheckQuotaNameResourceTypesMicrosoftPointNetAppNetAppAccountsCapacityPoolsVolumes          CheckQuotaNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes"
	CheckQuotaNameResourceTypesMicrosoftPointNetAppNetAppAccountsCapacityPoolsVolumesSnapshots CheckQuotaNameResourceTypes = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots"
)

func (*CheckQuotaNameResourceTypes) UnmarshalJSON

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

type FilePathAvailabilityRequest

type FilePathAvailabilityRequest struct {
	Name     string `json:"name"`
	SubnetId string `json:"subnetId"`
}

type InAvailabilityReasonType

type InAvailabilityReasonType string
const (
	InAvailabilityReasonTypeAlreadyExists InAvailabilityReasonType = "AlreadyExists"
	InAvailabilityReasonTypeInvalid       InAvailabilityReasonType = "Invalid"
)

func (*InAvailabilityReasonType) UnmarshalJSON

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

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) FromParseResult

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

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 NetAppResourceClient

type NetAppResourceClient struct {
	Client *resourcemanager.Client
}

func NewNetAppResourceClientWithBaseURI

func NewNetAppResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*NetAppResourceClient, error)

func (NetAppResourceClient) CheckFilePathAvailability

CheckFilePathAvailability ...

func (NetAppResourceClient) CheckNameAvailability

CheckNameAvailability ...

func (NetAppResourceClient) CheckQuotaAvailability

CheckQuotaAvailability ...

func (NetAppResourceClient) QueryNetworkSiblingSet

QueryNetworkSiblingSet ...

func (NetAppResourceClient) QueryRegionInfo

func (c NetAppResourceClient) QueryRegionInfo(ctx context.Context, id LocationId) (result QueryRegionInfoOperationResponse, err error)

QueryRegionInfo ...

func (NetAppResourceClient) QuotaLimitsGet

QuotaLimitsGet ...

func (NetAppResourceClient) QuotaLimitsList

func (c NetAppResourceClient) QuotaLimitsList(ctx context.Context, id LocationId) (result QuotaLimitsListOperationResponse, err error)

QuotaLimitsList ...

func (NetAppResourceClient) UpdateNetworkSiblingSet

UpdateNetworkSiblingSet ...

func (NetAppResourceClient) UpdateNetworkSiblingSetThenPoll

func (c NetAppResourceClient) UpdateNetworkSiblingSetThenPoll(ctx context.Context, id LocationId, input UpdateNetworkSiblingSetRequest) error

UpdateNetworkSiblingSetThenPoll performs UpdateNetworkSiblingSet then polls until it's completed

type NetworkFeatures

type NetworkFeatures string
const (
	NetworkFeaturesBasic         NetworkFeatures = "Basic"
	NetworkFeaturesBasicStandard NetworkFeatures = "Basic_Standard"
	NetworkFeaturesStandard      NetworkFeatures = "Standard"
	NetworkFeaturesStandardBasic NetworkFeatures = "Standard_Basic"
)

func (*NetworkFeatures) UnmarshalJSON

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

type NetworkSiblingSet

type NetworkSiblingSet struct {
	NetworkFeatures          *NetworkFeatures                    `json:"networkFeatures,omitempty"`
	NetworkSiblingSetId      *string                             `json:"networkSiblingSetId,omitempty"`
	NetworkSiblingSetStateId *string                             `json:"networkSiblingSetStateId,omitempty"`
	NicInfoList              *[]NicInfo                          `json:"nicInfoList,omitempty"`
	ProvisioningState        *NetworkSiblingSetProvisioningState `json:"provisioningState,omitempty"`
	SubnetId                 *string                             `json:"subnetId,omitempty"`
}

type NetworkSiblingSetProvisioningState

type NetworkSiblingSetProvisioningState string
const (
	NetworkSiblingSetProvisioningStateCanceled  NetworkSiblingSetProvisioningState = "Canceled"
	NetworkSiblingSetProvisioningStateFailed    NetworkSiblingSetProvisioningState = "Failed"
	NetworkSiblingSetProvisioningStateSucceeded NetworkSiblingSetProvisioningState = "Succeeded"
	NetworkSiblingSetProvisioningStateUpdating  NetworkSiblingSetProvisioningState = "Updating"
)

func (*NetworkSiblingSetProvisioningState) UnmarshalJSON

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

type NicInfo

type NicInfo struct {
	IPAddress         *string   `json:"ipAddress,omitempty"`
	VolumeResourceIds *[]string `json:"volumeResourceIds,omitempty"`
}

type QueryNetworkSiblingSetOperationResponse

type QueryNetworkSiblingSetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkSiblingSet
}

type QueryNetworkSiblingSetRequest

type QueryNetworkSiblingSetRequest struct {
	NetworkSiblingSetId string `json:"networkSiblingSetId"`
	SubnetId            string `json:"subnetId"`
}

type QueryRegionInfoOperationResponse

type QueryRegionInfoOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RegionInfo
}

type QuotaAvailabilityRequest

type QuotaAvailabilityRequest struct {
	Name          string                      `json:"name"`
	ResourceGroup string                      `json:"resourceGroup"`
	Type          CheckQuotaNameResourceTypes `json:"type"`
}

type QuotaLimitId

type QuotaLimitId struct {
	SubscriptionId string
	LocationName   string
	QuotaLimitName string
}

QuotaLimitId is a struct representing the Resource ID for a Quota Limit

func NewQuotaLimitID

func NewQuotaLimitID(subscriptionId string, locationName string, quotaLimitName string) QuotaLimitId

NewQuotaLimitID returns a new QuotaLimitId struct

func ParseQuotaLimitID

func ParseQuotaLimitID(input string) (*QuotaLimitId, error)

ParseQuotaLimitID parses 'input' into a QuotaLimitId

func ParseQuotaLimitIDInsensitively

func ParseQuotaLimitIDInsensitively(input string) (*QuotaLimitId, error)

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

func (*QuotaLimitId) FromParseResult

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

func (QuotaLimitId) ID

func (id QuotaLimitId) ID() string

ID returns the formatted Quota Limit ID

func (QuotaLimitId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Quota Limit ID

func (QuotaLimitId) String

func (id QuotaLimitId) String() string

String returns a human-readable description of this Quota Limit ID

type QuotaLimitsGetOperationResponse

type QuotaLimitsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionQuotaItem
}

type QuotaLimitsListOperationResponse

type QuotaLimitsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionQuotaItemList
}

type RegionInfo

type RegionInfo struct {
	AvailabilityZoneMappings  *[]RegionInfoAvailabilityZoneMappingsInlined `json:"availabilityZoneMappings,omitempty"`
	StorageToNetworkProximity *RegionStorageToNetworkProximity             `json:"storageToNetworkProximity,omitempty"`
}

type RegionInfoAvailabilityZoneMappingsInlined

type RegionInfoAvailabilityZoneMappingsInlined struct {
	AvailabilityZone *string `json:"availabilityZone,omitempty"`
	IsAvailable      *bool   `json:"isAvailable,omitempty"`
}

type RegionStorageToNetworkProximity

type RegionStorageToNetworkProximity string
const (
	RegionStorageToNetworkProximityAcrossTTwo               RegionStorageToNetworkProximity = "AcrossT2"
	RegionStorageToNetworkProximityDefault                  RegionStorageToNetworkProximity = "Default"
	RegionStorageToNetworkProximityTOne                     RegionStorageToNetworkProximity = "T1"
	RegionStorageToNetworkProximityTOneAndAcrossTTwo        RegionStorageToNetworkProximity = "T1AndAcrossT2"
	RegionStorageToNetworkProximityTOneAndTTwo              RegionStorageToNetworkProximity = "T1AndT2"
	RegionStorageToNetworkProximityTOneAndTTwoAndAcrossTTwo RegionStorageToNetworkProximity = "T1AndT2AndAcrossT2"
	RegionStorageToNetworkProximityTTwo                     RegionStorageToNetworkProximity = "T2"
	RegionStorageToNetworkProximityTTwoAndAcrossTTwo        RegionStorageToNetworkProximity = "T2AndAcrossT2"
)

func (*RegionStorageToNetworkProximity) UnmarshalJSON

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

type ResourceNameAvailabilityRequest

type ResourceNameAvailabilityRequest struct {
	Name          string                 `json:"name"`
	ResourceGroup string                 `json:"resourceGroup"`
	Type          CheckNameResourceTypes `json:"type"`
}

type SubscriptionQuotaItem

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

type SubscriptionQuotaItemList

type SubscriptionQuotaItemList struct {
	Value *[]SubscriptionQuotaItem `json:"value,omitempty"`
}

type SubscriptionQuotaItemProperties

type SubscriptionQuotaItemProperties struct {
	Current *int64 `json:"current,omitempty"`
	Default *int64 `json:"default,omitempty"`
}

type UpdateNetworkSiblingSetOperationResponse

type UpdateNetworkSiblingSetOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkSiblingSet
}

type UpdateNetworkSiblingSetRequest

type UpdateNetworkSiblingSetRequest struct {
	NetworkFeatures          NetworkFeatures `json:"networkFeatures"`
	NetworkSiblingSetId      string          `json:"networkSiblingSetId"`
	NetworkSiblingSetStateId string          `json:"networkSiblingSetStateId"`
	SubnetId                 string          `json:"subnetId"`
}

Jump to

Keyboard shortcuts

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