deletedservice

package
v0.20241004.1180715 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/deletedservice Documentation

The deletedservice SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2022-08-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/deletedservice"

Client Initialization

client := deletedservice.NewDeletedServiceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeletedServiceClient.GetByName

ctx := context.TODO()
id := deletedservice.NewDeletedServiceID("12345678-1234-9876-4563-123456789012", "location", "serviceName")

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

Example Usage: DeletedServiceClient.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
}

Example Usage: DeletedServiceClient.Purge

ctx := context.TODO()
id := deletedservice.NewDeletedServiceID("12345678-1234-9876-4563-123456789012", "location", "serviceName")

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

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 DeletedServiceClient 

type DeletedServiceClient struct {
	Client *resourcemanager.Client
}

func NewDeletedServiceClientWithBaseURI 

func NewDeletedServiceClientWithBaseURI(sdkApi sdkEnv.Api) (*DeletedServiceClient, error)

func (DeletedServiceClient) GetByName 

func (c DeletedServiceClient) GetByName(ctx context.Context, id DeletedServiceId) (result GetByNameOperationResponse, err error)

GetByName ...

func (DeletedServiceClient) ListBySubscription 

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

ListBySubscription ...

func (DeletedServiceClient) ListBySubscriptionComplete 

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

ListBySubscriptionComplete retrieves all the results into a single object

func (DeletedServiceClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DeletedServiceClient) Purge 

func (c DeletedServiceClient) Purge(ctx context.Context, id DeletedServiceId) (result PurgeOperationResponse, err error)

Purge ...

func (DeletedServiceClient) PurgeThenPoll 

func (c DeletedServiceClient) PurgeThenPoll(ctx context.Context, id DeletedServiceId) error

PurgeThenPoll performs Purge then polls until it's completed

type DeletedServiceContract 

type DeletedServiceContract struct {
	Id         *string                           `json:"id,omitempty"`
	Location   *string                           `json:"location,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties *DeletedServiceContractProperties `json:"properties,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type DeletedServiceContractOperationPredicate 

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

func (DeletedServiceContractOperationPredicate) Matches 

func (p DeletedServiceContractOperationPredicate) Matches(input DeletedServiceContract) bool

type DeletedServiceContractProperties 

type DeletedServiceContractProperties struct {
	DeletionDate       *string `json:"deletionDate,omitempty"`
	ScheduledPurgeDate *string `json:"scheduledPurgeDate,omitempty"`
	ServiceId          *string `json:"serviceId,omitempty"`
}

func (*DeletedServiceContractProperties) GetDeletionDateAsTime 

func (o *DeletedServiceContractProperties) GetDeletionDateAsTime() (*time.Time, error)

func (*DeletedServiceContractProperties) GetScheduledPurgeDateAsTime 

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

func (*DeletedServiceContractProperties) SetDeletionDateAsTime 

func (o *DeletedServiceContractProperties) SetDeletionDateAsTime(input time.Time)

func (*DeletedServiceContractProperties) SetScheduledPurgeDateAsTime 

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

type DeletedServiceId 

type DeletedServiceId struct {
	SubscriptionId     string
	LocationName       string
	DeletedServiceName string
}

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

func NewDeletedServiceID 

func NewDeletedServiceID(subscriptionId string, locationName 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 GetByNameOperationResponse 

type GetByNameOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DeletedServiceContract
}

type ListBySubscriptionCompleteResult 

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

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        *[]DeletedServiceContract
}

type PurgeOperationResponse 

type PurgeOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DeletedServiceContract
}

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.