deletedservices

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: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/apicenter/2024-03-15-preview/deletedservices Documentation

The deletedservices SDK allows for interaction with Azure Resource Manager apicenter (API Version 2024-03-15-preview).

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/apicenter/2024-03-15-preview/deletedservices"

Client Initialization

client := deletedservices.NewDeletedServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeletedServicesClient.Delete

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

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

Example Usage: DeletedServicesClient.Get

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

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: DeletedServicesClient.List

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

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

Example Usage: DeletedServicesClient.ListBySubscription

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateDeletedServiceID 

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

ValidateDeletedServiceID checks that 'input' can be parsed as a Deleted Service ID

Types

type DeleteOperationResponse 

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

type DeletedService 

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

type DeletedServiceId 

type DeletedServiceId struct {
	SubscriptionId     string
	ResourceGroupName  string
	DeletedServiceName string
}

DeletedServiceId is a struct representing the Resource ID for a Deleted Service

func NewDeletedServiceID 

func NewDeletedServiceID(subscriptionId string, resourceGroupName string, deletedServiceName string) DeletedServiceId

NewDeletedServiceID returns a new DeletedServiceId struct

func ParseDeletedServiceID 

func ParseDeletedServiceID(input string) (*DeletedServiceId, error)

ParseDeletedServiceID parses 'input' into a DeletedServiceId

func ParseDeletedServiceIDInsensitively 

func ParseDeletedServiceIDInsensitively(input string) (*DeletedServiceId, error)

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

func (*DeletedServiceId) FromParseResult 

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

func (DeletedServiceId) ID 

func (id DeletedServiceId) ID() string

ID returns the formatted Deleted Service ID

func (DeletedServiceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Deleted Service ID

func (DeletedServiceId) String 

func (id DeletedServiceId) String() string

String returns a human-readable description of this Deleted Service ID

type DeletedServiceOperationPredicate 

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

func (DeletedServiceOperationPredicate) Matches 

func (p DeletedServiceOperationPredicate) Matches(input DeletedService) bool

type DeletedServiceProperties 

type DeletedServiceProperties struct {
	ScheduledPurgeDate *string `json:"scheduledPurgeDate,omitempty"`
	SoftDeletionDate   *string `json:"softDeletionDate,omitempty"`
}

func (*DeletedServiceProperties) GetScheduledPurgeDateAsTime 

func (o *DeletedServiceProperties) GetScheduledPurgeDateAsTime() (*time.Time, error)

func (*DeletedServiceProperties) GetSoftDeletionDateAsTime 

func (o *DeletedServiceProperties) GetSoftDeletionDateAsTime() (*time.Time, error)

func (*DeletedServiceProperties) SetScheduledPurgeDateAsTime 

func (o *DeletedServiceProperties) SetScheduledPurgeDateAsTime(input time.Time)

func (*DeletedServiceProperties) SetSoftDeletionDateAsTime 

func (o *DeletedServiceProperties) SetSoftDeletionDateAsTime(input time.Time)

type DeletedServicesClient 

type DeletedServicesClient struct {
	Client *resourcemanager.Client
}

func NewDeletedServicesClientWithBaseURI 

func NewDeletedServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*DeletedServicesClient, error)

func (DeletedServicesClient) Delete 

func (c DeletedServicesClient) Delete(ctx context.Context, id DeletedServiceId) (result DeleteOperationResponse, err error)

Delete ...

func (DeletedServicesClient) Get 

func (c DeletedServicesClient) Get(ctx context.Context, id DeletedServiceId) (result GetOperationResponse, err error)

Get ...

func (DeletedServicesClient) List 

func (c DeletedServicesClient) List(ctx context.Context, id commonids.ResourceGroupId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (DeletedServicesClient) ListBySubscription 

func (c DeletedServicesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (DeletedServicesClient) ListBySubscriptionComplete 

func (c DeletedServicesClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (DeletedServicesClient) ListBySubscriptionCompleteMatchingPredicate 

func (c DeletedServicesClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DeletedServiceOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DeletedServicesClient) ListComplete 

func (c DeletedServicesClient) ListComplete(ctx context.Context, id commonids.ResourceGroupId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DeletedServicesClient) ListCompleteMatchingPredicate 

func (c DeletedServicesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListOperationOptions, predicate DeletedServiceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse 

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

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DeletedService
}

type ListBySubscriptionCustomPager added in v0.20240628.1153531 

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

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DeletedService
}

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData 

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

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

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.