deletedwebapps

package
v0.20241025.1143247 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/web/2023-12-01/deletedwebapps Documentation

The deletedwebapps SDK allows for interaction with Azure Resource Manager web (API Version 2023-12-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/web/2023-12-01/deletedwebapps"

Client Initialization

client := deletedwebapps.NewDeletedWebAppsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeletedWebAppsClient.GetDeletedWebAppByLocation

ctx := context.TODO()
id := deletedwebapps.NewLocationDeletedSiteID("12345678-1234-9876-4563-123456789012", "locationName", "deletedSiteId")

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

Example Usage: DeletedWebAppsClient.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: DeletedWebAppsClient.ListByLocation

ctx := context.TODO()
id := deletedwebapps.NewProviderLocationID("12345678-1234-9876-4563-123456789012", "locationName")

// alternatively `client.ListByLocation(ctx, id)` can be used to do batched pagination
items, err := client.ListByLocationComplete(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 ValidateLocationDeletedSiteID 

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

ValidateLocationDeletedSiteID checks that 'input' can be parsed as a Location Deleted Site ID

func ValidateProviderLocationID 

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

ValidateProviderLocationID checks that 'input' can be parsed as a Provider Location ID

Types

type DeletedSite 

type DeletedSite struct {
	Id         *string                `json:"id,omitempty"`
	Kind       *string                `json:"kind,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *DeletedSiteProperties `json:"properties,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type DeletedSiteOperationPredicate 

type DeletedSiteOperationPredicate struct {
	Id   *string
	Kind *string
	Name *string
	Type *string
}

func (DeletedSiteOperationPredicate) Matches 

func (p DeletedSiteOperationPredicate) Matches(input DeletedSite) bool

type DeletedSiteProperties 

type DeletedSiteProperties struct {
	DeletedSiteId    *int64  `json:"deletedSiteId,omitempty"`
	DeletedSiteName  *string `json:"deletedSiteName,omitempty"`
	DeletedTimestamp *string `json:"deletedTimestamp,omitempty"`
	GeoRegionName    *string `json:"geoRegionName,omitempty"`
	Kind             *string `json:"kind,omitempty"`
	ResourceGroup    *string `json:"resourceGroup,omitempty"`
	Slot             *string `json:"slot,omitempty"`
	Subscription     *string `json:"subscription,omitempty"`
}

type DeletedWebAppsClient 

type DeletedWebAppsClient struct {
	Client *resourcemanager.Client
}

func NewDeletedWebAppsClientWithBaseURI 

func NewDeletedWebAppsClientWithBaseURI(sdkApi sdkEnv.Api) (*DeletedWebAppsClient, error)

func (DeletedWebAppsClient) GetDeletedWebAppByLocation 

func (c DeletedWebAppsClient) GetDeletedWebAppByLocation(ctx context.Context, id LocationDeletedSiteId) (result GetDeletedWebAppByLocationOperationResponse, err error)

GetDeletedWebAppByLocation ...

func (DeletedWebAppsClient) List 

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

List ...

func (DeletedWebAppsClient) ListByLocation 

func (c DeletedWebAppsClient) ListByLocation(ctx context.Context, id ProviderLocationId) (result ListByLocationOperationResponse, err error)

ListByLocation ...

func (DeletedWebAppsClient) ListByLocationComplete 

func (c DeletedWebAppsClient) ListByLocationComplete(ctx context.Context, id ProviderLocationId) (ListByLocationCompleteResult, error)

ListByLocationComplete retrieves all the results into a single object

func (DeletedWebAppsClient) ListByLocationCompleteMatchingPredicate 

func (c DeletedWebAppsClient) ListByLocationCompleteMatchingPredicate(ctx context.Context, id ProviderLocationId, predicate DeletedSiteOperationPredicate) (result ListByLocationCompleteResult, err error)

ListByLocationCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DeletedWebAppsClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (DeletedWebAppsClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetDeletedWebAppByLocationOperationResponse 

type GetDeletedWebAppByLocationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DeletedSite
}

type ListByLocationCompleteResult 

type ListByLocationCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DeletedSite
}

type ListByLocationCustomPager added in v0.20240628.1153531 

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

type ListByLocationOperationResponse 

type ListByLocationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DeletedSite
}

type ListCompleteResult 

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

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

type LocationDeletedSiteId 

type LocationDeletedSiteId struct {
	SubscriptionId string
	LocationName   string
	DeletedSiteId  string
}

LocationDeletedSiteId is a struct representing the Resource ID for a Location Deleted Site

func NewLocationDeletedSiteID 

func NewLocationDeletedSiteID(subscriptionId string, locationName string, deletedSiteId string) LocationDeletedSiteId

NewLocationDeletedSiteID returns a new LocationDeletedSiteId struct

func ParseLocationDeletedSiteID 

func ParseLocationDeletedSiteID(input string) (*LocationDeletedSiteId, error)

ParseLocationDeletedSiteID parses 'input' into a LocationDeletedSiteId

func ParseLocationDeletedSiteIDInsensitively 

func ParseLocationDeletedSiteIDInsensitively(input string) (*LocationDeletedSiteId, error)

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

func (*LocationDeletedSiteId) FromParseResult 

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

func (LocationDeletedSiteId) ID 

func (id LocationDeletedSiteId) ID() string

ID returns the formatted Location Deleted Site ID

func (LocationDeletedSiteId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Location Deleted Site ID

func (LocationDeletedSiteId) String 

func (id LocationDeletedSiteId) String() string

String returns a human-readable description of this Location Deleted Site ID

type ProviderLocationId 

type ProviderLocationId struct {
	SubscriptionId string
	LocationName   string
}

ProviderLocationId is a struct representing the Resource ID for a Provider Location

func NewProviderLocationID 

func NewProviderLocationID(subscriptionId string, locationName string) ProviderLocationId

NewProviderLocationID returns a new ProviderLocationId struct

func ParseProviderLocationID 

func ParseProviderLocationID(input string) (*ProviderLocationId, error)

ParseProviderLocationID parses 'input' into a ProviderLocationId

func ParseProviderLocationIDInsensitively 

func ParseProviderLocationIDInsensitively(input string) (*ProviderLocationId, error)

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

func (*ProviderLocationId) FromParseResult 

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

func (ProviderLocationId) ID 

func (id ProviderLocationId) ID() string

ID returns the formatted Provider Location ID

func (ProviderLocationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Provider Location ID

func (ProviderLocationId) String 

func (id ProviderLocationId) String() string

String returns a human-readable description of this Provider Location ID

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.