resourcehealthmetadata

package
v0.20241205.1102105 Latest Latest
Warning

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

 Go to latest Published: Dec 5, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

The resourcehealthmetadata 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/resourcehealthmetadata"

Client Initialization

client := resourcehealthmetadata.NewResourceHealthMetadataClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ResourceHealthMetadataClient.GetBySite

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

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

Example Usage: ResourceHealthMetadataClient.GetBySiteSlot

ctx := context.TODO()
id := resourcehealthmetadata.NewSlotID("12345678-1234-9876-4563-123456789012", "example-resource-group", "siteName", "slotName")

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

Example Usage: ResourceHealthMetadataClient.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: ResourceHealthMetadataClient.ListByResourceGroup

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

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

Example Usage: ResourceHealthMetadataClient.ListBySite

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

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

Example Usage: ResourceHealthMetadataClient.ListBySiteSlot

ctx := context.TODO()
id := resourcehealthmetadata.NewSlotID("12345678-1234-9876-4563-123456789012", "example-resource-group", "siteName", "slotName")

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

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

ValidateSlotID checks that 'input' can be parsed as a Slot ID

Types

type GetBySiteOperationResponse 

type GetBySiteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceHealthMetadata
}

type GetBySiteSlotOperationResponse 

type GetBySiteSlotOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceHealthMetadata
}

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ResourceHealthMetadata
}

type ListByResourceGroupCustomPager added in v0.20240628.1153531 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ResourceHealthMetadata
}

type ListBySiteCompleteResult 

type ListBySiteCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ResourceHealthMetadata
}

type ListBySiteCustomPager added in v0.20240628.1153531 

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

type ListBySiteOperationResponse 

type ListBySiteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ResourceHealthMetadata
}

type ListBySiteSlotCompleteResult 

type ListBySiteSlotCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ResourceHealthMetadata
}

type ListBySiteSlotCustomPager added in v0.20240628.1153531 

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

type ListBySiteSlotOperationResponse 

type ListBySiteSlotOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ResourceHealthMetadata
}

type ListCompleteResult 

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

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

type ResourceHealthMetadata 

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

type ResourceHealthMetadataClient 

type ResourceHealthMetadataClient struct {
	Client *resourcemanager.Client
}

func NewResourceHealthMetadataClientWithBaseURI 

func NewResourceHealthMetadataClientWithBaseURI(sdkApi sdkEnv.Api) (*ResourceHealthMetadataClient, error)

func (ResourceHealthMetadataClient) GetBySite 

func (c ResourceHealthMetadataClient) GetBySite(ctx context.Context, id commonids.AppServiceId) (result GetBySiteOperationResponse, err error)

GetBySite ...

func (ResourceHealthMetadataClient) GetBySiteSlot 

func (c ResourceHealthMetadataClient) GetBySiteSlot(ctx context.Context, id SlotId) (result GetBySiteSlotOperationResponse, err error)

GetBySiteSlot ...

func (ResourceHealthMetadataClient) List 

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

List ...

func (ResourceHealthMetadataClient) ListByResourceGroup 

func (c ResourceHealthMetadataClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ResourceHealthMetadataClient) ListByResourceGroupComplete 

func (c ResourceHealthMetadataClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (ResourceHealthMetadataClient) ListByResourceGroupCompleteMatchingPredicate 

func (c ResourceHealthMetadataClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ResourceHealthMetadataOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceHealthMetadataClient) ListBySite 

func (c ResourceHealthMetadataClient) ListBySite(ctx context.Context, id commonids.AppServiceId) (result ListBySiteOperationResponse, err error)

ListBySite ...

func (ResourceHealthMetadataClient) ListBySiteComplete 

func (c ResourceHealthMetadataClient) ListBySiteComplete(ctx context.Context, id commonids.AppServiceId) (ListBySiteCompleteResult, error)

ListBySiteComplete retrieves all the results into a single object

func (ResourceHealthMetadataClient) ListBySiteCompleteMatchingPredicate 

func (c ResourceHealthMetadataClient) ListBySiteCompleteMatchingPredicate(ctx context.Context, id commonids.AppServiceId, predicate ResourceHealthMetadataOperationPredicate) (result ListBySiteCompleteResult, err error)

ListBySiteCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceHealthMetadataClient) ListBySiteSlot 

func (c ResourceHealthMetadataClient) ListBySiteSlot(ctx context.Context, id SlotId) (result ListBySiteSlotOperationResponse, err error)

ListBySiteSlot ...

func (ResourceHealthMetadataClient) ListBySiteSlotComplete 

func (c ResourceHealthMetadataClient) ListBySiteSlotComplete(ctx context.Context, id SlotId) (ListBySiteSlotCompleteResult, error)

ListBySiteSlotComplete retrieves all the results into a single object

func (ResourceHealthMetadataClient) ListBySiteSlotCompleteMatchingPredicate 

func (c ResourceHealthMetadataClient) ListBySiteSlotCompleteMatchingPredicate(ctx context.Context, id SlotId, predicate ResourceHealthMetadataOperationPredicate) (result ListBySiteSlotCompleteResult, err error)

ListBySiteSlotCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceHealthMetadataClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ResourceHealthMetadataClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ResourceHealthMetadataOperationPredicate 

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

func (ResourceHealthMetadataOperationPredicate) Matches 

func (p ResourceHealthMetadataOperationPredicate) Matches(input ResourceHealthMetadata) bool

type ResourceHealthMetadataProperties 

type ResourceHealthMetadataProperties struct {
	Category           *string `json:"category,omitempty"`
	SignalAvailability *bool   `json:"signalAvailability,omitempty"`
}

type SlotId 

type SlotId struct {
	SubscriptionId    string
	ResourceGroupName string
	SiteName          string
	SlotName          string
}

SlotId is a struct representing the Resource ID for a Slot

func NewSlotID 

func NewSlotID(subscriptionId string, resourceGroupName string, siteName string, slotName string) SlotId

NewSlotID returns a new SlotId struct

func ParseSlotID 

func ParseSlotID(input string) (*SlotId, error)

ParseSlotID parses 'input' into a SlotId

func ParseSlotIDInsensitively 

func ParseSlotIDInsensitively(input string) (*SlotId, error)

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

func (*SlotId) FromParseResult 

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

func (SlotId) ID 

func (id SlotId) ID() string

ID returns the formatted Slot ID

func (SlotId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Slot ID

func (SlotId) String 

func (id SlotId) String() string

String returns a human-readable description of this Slot 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.