deletedservice

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2024-05-01/deletedservice Documentation

The deletedservice SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2024-05-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/2024-05-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", "locationName", "deletedServiceName")

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", "locationName", "deletedServiceName")

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

Documentation

Index

• func ValidateDeletedServiceID(input interface{}, key string) (warnings []string, errors []error)
• type DeletedServiceClient
  • func NewDeletedServiceClientWithBaseURI(sdkApi sdkEnv.Api) (*DeletedServiceClient, error)
  • func (c DeletedServiceClient) GetByName(ctx context.Context, id DeletedServiceId) (result GetByNameOperationResponse, err error)
  • func (c DeletedServiceClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
  • func (c DeletedServiceClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
  • func (c DeletedServiceClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)
  • func (c DeletedServiceClient) Purge(ctx context.Context, id DeletedServiceId) (result PurgeOperationResponse, err error)
  • func (c DeletedServiceClient) PurgeThenPoll(ctx context.Context, id DeletedServiceId) error
• type DeletedServiceContract
• type DeletedServiceContractOperationPredicate
  • func (p DeletedServiceContractOperationPredicate) Matches(input DeletedServiceContract) bool
• type DeletedServiceContractProperties
  • func (o *DeletedServiceContractProperties) GetDeletionDateAsTime() (*time.Time, error)
  • func (o *DeletedServiceContractProperties) GetScheduledPurgeDateAsTime() (*time.Time, error)
  • func (o *DeletedServiceContractProperties) SetDeletionDateAsTime(input time.Time)
  • func (o *DeletedServiceContractProperties) SetScheduledPurgeDateAsTime(input time.Time)
• type DeletedServiceId
  • func NewDeletedServiceID(subscriptionId string, locationName string, deletedServiceName string) DeletedServiceId
  • func ParseDeletedServiceID(input string) (*DeletedServiceId, error)
  • func ParseDeletedServiceIDInsensitively(input string) (*DeletedServiceId, error)
  • func (id *DeletedServiceId) FromParseResult(input resourceids.ParseResult) error
  • func (id DeletedServiceId) ID() string
  • func (id DeletedServiceId) Segments() []resourceids.Segment
  • func (id DeletedServiceId) String() string
• type GetByNameOperationResponse
• type ListBySubscriptionCompleteResult
• type ListBySubscriptionCustomPager
  • func (p *ListBySubscriptionCustomPager) NextPageLink() *odata.Link
• type ListBySubscriptionOperationResponse
• type PurgeOperationResponse

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

type ListBySubscriptionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListBySubscriptionCustomPager) NextPageLink

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
}