diskaccesses

package
v0.20240923.1142107 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 16 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2023-04-02/diskaccesses Documentation

The diskaccesses SDK allows for interaction with Azure Resource Manager compute (API Version 2023-04-02).

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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/compute/2023-04-02/diskaccesses"

Client Initialization

client := diskaccesses.NewDiskAccessesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DiskAccessesClient.CreateOrUpdate

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

payload := diskaccesses.DiskAccess{
	// ...
}


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

Example Usage: DiskAccessesClient.Delete

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

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

Example Usage: DiskAccessesClient.DeleteAPrivateEndpointConnection

ctx := context.TODO()
id := diskaccesses.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "diskAccessName", "privateEndpointConnectionName")

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

Example Usage: DiskAccessesClient.Get

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

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: DiskAccessesClient.GetAPrivateEndpointConnection

ctx := context.TODO()
id := diskaccesses.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "diskAccessName", "privateEndpointConnectionName")

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

Example Usage: DiskAccessesClient.GetPrivateLinkResources

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

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

Example Usage: DiskAccessesClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: DiskAccessesClient.ListByResourceGroup

ctx := context.TODO()
id := commonids.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
}

Example Usage: DiskAccessesClient.ListPrivateEndpointConnections

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

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

Example Usage: DiskAccessesClient.Update

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

payload := diskaccesses.DiskAccessUpdate{
	// ...
}


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

Example Usage: DiskAccessesClient.UpdateAPrivateEndpointConnection

ctx := context.TODO()
id := diskaccesses.NewPrivateEndpointConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "diskAccessName", "privateEndpointConnectionName")

payload := diskaccesses.PrivateEndpointConnection{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForPrivateEndpointConnectionProvisioningState 

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus 

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func ValidateDiskAccessID 

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

ValidateDiskAccessID checks that 'input' can be parsed as a Disk Access ID

func ValidatePrivateEndpointConnectionID 

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

ValidatePrivateEndpointConnectionID checks that 'input' can be parsed as a Private Endpoint Connection ID

Types

type CreateOrUpdateOperationResponse 

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

type DeleteAPrivateEndpointConnectionOperationResponse 

type DeleteAPrivateEndpointConnectionOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DiskAccess 

type DiskAccess struct {
	ExtendedLocation *edgezones.Model      `json:"extendedLocation,omitempty"`
	Id               *string               `json:"id,omitempty"`
	Location         string                `json:"location"`
	Name             *string               `json:"name,omitempty"`
	Properties       *DiskAccessProperties `json:"properties,omitempty"`
	Tags             *map[string]string    `json:"tags,omitempty"`
	Type             *string               `json:"type,omitempty"`
}

type DiskAccessId 

type DiskAccessId struct {
	SubscriptionId    string
	ResourceGroupName string
	DiskAccessName    string
}

DiskAccessId is a struct representing the Resource ID for a Disk Access

func NewDiskAccessID 

func NewDiskAccessID(subscriptionId string, resourceGroupName string, diskAccessName string) DiskAccessId

NewDiskAccessID returns a new DiskAccessId struct

func ParseDiskAccessID 

func ParseDiskAccessID(input string) (*DiskAccessId, error)

ParseDiskAccessID parses 'input' into a DiskAccessId

func ParseDiskAccessIDInsensitively 

func ParseDiskAccessIDInsensitively(input string) (*DiskAccessId, error)

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

func (*DiskAccessId) FromParseResult 

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

func (DiskAccessId) ID 

func (id DiskAccessId) ID() string

ID returns the formatted Disk Access ID

func (DiskAccessId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Disk Access ID

func (DiskAccessId) String 

func (id DiskAccessId) String() string

String returns a human-readable description of this Disk Access ID

type DiskAccessOperationPredicate 

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

func (DiskAccessOperationPredicate) Matches 

func (p DiskAccessOperationPredicate) Matches(input DiskAccess) bool

type DiskAccessProperties 

type DiskAccessProperties struct {
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *string                      `json:"provisioningState,omitempty"`
	TimeCreated                *string                      `json:"timeCreated,omitempty"`
}

func (*DiskAccessProperties) GetTimeCreatedAsTime 

func (o *DiskAccessProperties) GetTimeCreatedAsTime() (*time.Time, error)

func (*DiskAccessProperties) SetTimeCreatedAsTime 

func (o *DiskAccessProperties) SetTimeCreatedAsTime(input time.Time)

type DiskAccessUpdate 

type DiskAccessUpdate struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type DiskAccessesClient 

type DiskAccessesClient struct {
	Client *resourcemanager.Client
}

func NewDiskAccessesClientWithBaseURI 

func NewDiskAccessesClientWithBaseURI(sdkApi sdkEnv.Api) (*DiskAccessesClient, error)

func (DiskAccessesClient) CreateOrUpdate 

func (c DiskAccessesClient) CreateOrUpdate(ctx context.Context, id DiskAccessId, input DiskAccess) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DiskAccessesClient) CreateOrUpdateThenPoll 

func (c DiskAccessesClient) CreateOrUpdateThenPoll(ctx context.Context, id DiskAccessId, input DiskAccess) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DiskAccessesClient) Delete 

func (c DiskAccessesClient) Delete(ctx context.Context, id DiskAccessId) (result DeleteOperationResponse, err error)

Delete ...

func (DiskAccessesClient) DeleteAPrivateEndpointConnection 

func (c DiskAccessesClient) DeleteAPrivateEndpointConnection(ctx context.Context, id PrivateEndpointConnectionId) (result DeleteAPrivateEndpointConnectionOperationResponse, err error)

DeleteAPrivateEndpointConnection ...

func (DiskAccessesClient) DeleteAPrivateEndpointConnectionThenPoll 

func (c DiskAccessesClient) DeleteAPrivateEndpointConnectionThenPoll(ctx context.Context, id PrivateEndpointConnectionId) error

DeleteAPrivateEndpointConnectionThenPoll performs DeleteAPrivateEndpointConnection then polls until it's completed

func (DiskAccessesClient) DeleteThenPoll 

func (c DiskAccessesClient) DeleteThenPoll(ctx context.Context, id DiskAccessId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DiskAccessesClient) Get 

func (c DiskAccessesClient) Get(ctx context.Context, id DiskAccessId) (result GetOperationResponse, err error)

Get ...

func (DiskAccessesClient) GetAPrivateEndpointConnection 

func (c DiskAccessesClient) GetAPrivateEndpointConnection(ctx context.Context, id PrivateEndpointConnectionId) (result GetAPrivateEndpointConnectionOperationResponse, err error)

GetAPrivateEndpointConnection ...

func (DiskAccessesClient) GetPrivateLinkResources 

func (c DiskAccessesClient) GetPrivateLinkResources(ctx context.Context, id DiskAccessId) (result GetPrivateLinkResourcesOperationResponse, err error)

GetPrivateLinkResources ...

func (DiskAccessesClient) List 

func (c DiskAccessesClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (DiskAccessesClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (DiskAccessesClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (DiskAccessesClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DiskAccessesClient) ListComplete 

func (c DiskAccessesClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DiskAccessesClient) ListCompleteMatchingPredicate 

func (c DiskAccessesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DiskAccessOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DiskAccessesClient) ListPrivateEndpointConnections 

func (c DiskAccessesClient) ListPrivateEndpointConnections(ctx context.Context, id DiskAccessId) (result ListPrivateEndpointConnectionsOperationResponse, err error)

ListPrivateEndpointConnections ...

func (DiskAccessesClient) ListPrivateEndpointConnectionsComplete 

func (c DiskAccessesClient) ListPrivateEndpointConnectionsComplete(ctx context.Context, id DiskAccessId) (ListPrivateEndpointConnectionsCompleteResult, error)

ListPrivateEndpointConnectionsComplete retrieves all the results into a single object

func (DiskAccessesClient) ListPrivateEndpointConnectionsCompleteMatchingPredicate 

func (c DiskAccessesClient) ListPrivateEndpointConnectionsCompleteMatchingPredicate(ctx context.Context, id DiskAccessId, predicate PrivateEndpointConnectionOperationPredicate) (result ListPrivateEndpointConnectionsCompleteResult, err error)

ListPrivateEndpointConnectionsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DiskAccessesClient) Update 

func (c DiskAccessesClient) Update(ctx context.Context, id DiskAccessId, input DiskAccessUpdate) (result UpdateOperationResponse, err error)

Update ...

func (DiskAccessesClient) UpdateAPrivateEndpointConnection 

func (c DiskAccessesClient) UpdateAPrivateEndpointConnection(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) (result UpdateAPrivateEndpointConnectionOperationResponse, err error)

UpdateAPrivateEndpointConnection ...

func (DiskAccessesClient) UpdateAPrivateEndpointConnectionThenPoll 

func (c DiskAccessesClient) UpdateAPrivateEndpointConnectionThenPoll(ctx context.Context, id PrivateEndpointConnectionId, input PrivateEndpointConnection) error

UpdateAPrivateEndpointConnectionThenPoll performs UpdateAPrivateEndpointConnection then polls until it's completed

func (DiskAccessesClient) UpdateThenPoll 

func (c DiskAccessesClient) UpdateThenPoll(ctx context.Context, id DiskAccessId, input DiskAccessUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type GetAPrivateEndpointConnectionOperationResponse 

type GetAPrivateEndpointConnectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DiskAccess
}

type GetPrivateLinkResourcesOperationResponse 

type GetPrivateLinkResourcesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkResourceListResult
}

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DiskAccess
}

type ListByResourceGroupCustomPager added in v0.20240628.1153531 

type ListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ListByResourceGroupOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DiskAccess
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DiskAccess
}

type ListPrivateEndpointConnectionsCompleteResult 

type ListPrivateEndpointConnectionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateEndpointConnection
}

type ListPrivateEndpointConnectionsCustomPager added in v0.20240628.1153531 

type ListPrivateEndpointConnectionsCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListPrivateEndpointConnectionsCustomPager) NextPageLink() *odata.Link

type ListPrivateEndpointConnectionsOperationResponse 

type ListPrivateEndpointConnectionsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateEndpointConnection
}

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,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionId 

type PrivateEndpointConnectionId struct {
	SubscriptionId                string
	ResourceGroupName             string
	DiskAccessName                string
	PrivateEndpointConnectionName string
}

PrivateEndpointConnectionId is a struct representing the Resource ID for a Private Endpoint Connection

func NewPrivateEndpointConnectionID 

func NewPrivateEndpointConnectionID(subscriptionId string, resourceGroupName string, diskAccessName string, privateEndpointConnectionName string) PrivateEndpointConnectionId

NewPrivateEndpointConnectionID returns a new PrivateEndpointConnectionId struct

func ParsePrivateEndpointConnectionID 

func ParsePrivateEndpointConnectionID(input string) (*PrivateEndpointConnectionId, error)

ParsePrivateEndpointConnectionID parses 'input' into a PrivateEndpointConnectionId

func ParsePrivateEndpointConnectionIDInsensitively 

func ParsePrivateEndpointConnectionIDInsensitively(input string) (*PrivateEndpointConnectionId, error)

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

func (*PrivateEndpointConnectionId) FromParseResult 

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

func (PrivateEndpointConnectionId) ID 

func (id PrivateEndpointConnectionId) ID() string

ID returns the formatted Private Endpoint Connection ID

func (PrivateEndpointConnectionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Private Endpoint Connection ID

func (PrivateEndpointConnectionId) String 

func (id PrivateEndpointConnectionId) String() string

String returns a human-readable description of this Private Endpoint Connection ID

type PrivateEndpointConnectionOperationPredicate 

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

func (PrivateEndpointConnectionOperationPredicate) Matches 

func (p PrivateEndpointConnectionOperationPredicate) Matches(input PrivateEndpointConnection) bool

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState           `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON 

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

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string
const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON 

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

type PrivateLinkResource 

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

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	Value *[]PrivateLinkResource `json:"value,omitempty"`
}

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type PrivateLinkServiceConnectionState 

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

type UpdateAPrivateEndpointConnectionOperationResponse 

type UpdateAPrivateEndpointConnectionOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateEndpointConnection
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DiskAccess
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.