global

README

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

The global SDK allows for interaction with the Azure Resource Manager Service 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-sdk/resource-manager/web/2023-12-01/global"

Client Initialization

client := global.NewGlobalClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GlobalClient.GetDeletedWebApp

ctx := context.TODO()
id := global.NewDeletedSiteID("12345678-1234-9876-4563-123456789012", "deletedSiteIdValue")

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

Example Usage: GlobalClient.GetDeletedWebAppSnapshots

ctx := context.TODO()
id := global.NewDeletedSiteID("12345678-1234-9876-4563-123456789012", "deletedSiteIdValue")

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

Documentation

Index

• func ValidateDeletedSiteID(input interface{}, key string) (warnings []string, errors []error)
• type DeletedSite
• type DeletedSiteId
  • func NewDeletedSiteID(subscriptionId string, deletedSiteId string) DeletedSiteId
  • func ParseDeletedSiteID(input string) (*DeletedSiteId, error)
  • func ParseDeletedSiteIDInsensitively(input string) (*DeletedSiteId, error)
  • func (id *DeletedSiteId) FromParseResult(input resourceids.ParseResult) error
  • func (id DeletedSiteId) ID() string
  • func (id DeletedSiteId) Segments() []resourceids.Segment
  • func (id DeletedSiteId) String() string
• type DeletedSiteProperties
• type GetDeletedWebAppOperationResponse
• type GetDeletedWebAppSnapshotsOperationResponse
• type GlobalClient
  • func NewGlobalClientWithBaseURI(sdkApi sdkEnv.Api) (*GlobalClient, error)
  • func (c GlobalClient) GetDeletedWebApp(ctx context.Context, id DeletedSiteId) (result GetDeletedWebAppOperationResponse, err error)
  • func (c GlobalClient) GetDeletedWebAppSnapshots(ctx context.Context, id DeletedSiteId) (result GetDeletedWebAppSnapshotsOperationResponse, err error)
• type Snapshot
• type SnapshotProperties

Functions

func ValidateDeletedSiteID

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

ValidateDeletedSiteID checks that 'input' can be parsed as a Deleted Site 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 DeletedSiteId

type DeletedSiteId struct {
	SubscriptionId string
	DeletedSiteId  string
}

DeletedSiteId is a struct representing the Resource ID for a Deleted Site

func NewDeletedSiteID

func NewDeletedSiteID(subscriptionId string, deletedSiteId string) DeletedSiteId

NewDeletedSiteID returns a new DeletedSiteId struct

func ParseDeletedSiteID

func ParseDeletedSiteID(input string) (*DeletedSiteId, error)

ParseDeletedSiteID parses 'input' into a DeletedSiteId

func ParseDeletedSiteIDInsensitively

func ParseDeletedSiteIDInsensitively(input string) (*DeletedSiteId, error)

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

func (*DeletedSiteId) FromParseResult

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

func (DeletedSiteId) ID

func (id DeletedSiteId) ID() string

ID returns the formatted Deleted Site ID

func (DeletedSiteId) Segments

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

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

func (DeletedSiteId) String

func (id DeletedSiteId) String() string

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

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 GetDeletedWebAppOperationResponse

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

type GetDeletedWebAppSnapshotsOperationResponse

type GetDeletedWebAppSnapshotsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Snapshot
}

type GlobalClient

type GlobalClient struct {
	Client *resourcemanager.Client
}

func NewGlobalClientWithBaseURI

func NewGlobalClientWithBaseURI(sdkApi sdkEnv.Api) (*GlobalClient, error)

func (GlobalClient) GetDeletedWebApp

func (c GlobalClient) GetDeletedWebApp(ctx context.Context, id DeletedSiteId) (result GetDeletedWebAppOperationResponse, err error)

GetDeletedWebApp ...

func (GlobalClient) GetDeletedWebAppSnapshots

func (c GlobalClient) GetDeletedWebAppSnapshots(ctx context.Context, id DeletedSiteId) (result GetDeletedWebAppSnapshotsOperationResponse, err error)

GetDeletedWebAppSnapshots ...

type Snapshot

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

type SnapshotProperties

type SnapshotProperties struct {
	Time *string `json:"time,omitempty"`
}