armresourcehealth

package module
v0.3.1 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2022 License: MIT Imports: 14 Imported by: 6

README

Azure Resource Health Module for Go

PkgGoDev

The armresourcehealth module provides operations for working with Azure Resource Health.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Resource Health module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourcehealth/armresourcehealth

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Resource Health. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Resource Health modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armresourcehealth.NewAvailabilityStatusesClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armresourcehealth.NewAvailabilityStatusesClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Resource Health label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AvailabilityStateValues 

type AvailabilityStateValues string

AvailabilityStateValues - Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event 

const (
	AvailabilityStateValuesAvailable   AvailabilityStateValues = "Available"
	AvailabilityStateValuesUnavailable AvailabilityStateValues = "Unavailable"
	AvailabilityStateValuesUnknown     AvailabilityStateValues = "Unknown"
)

func PossibleAvailabilityStateValuesValues 

func PossibleAvailabilityStateValuesValues() []AvailabilityStateValues

PossibleAvailabilityStateValuesValues returns the possible values for the AvailabilityStateValues const type.

func (AvailabilityStateValues) ToPtr 

func (c AvailabilityStateValues) ToPtr() *AvailabilityStateValues

ToPtr returns a *AvailabilityStateValues pointing to the current value.

type AvailabilityStatus 

type AvailabilityStatus struct {
	// Azure Resource Manager Identity for the availabilityStatuses resource.
	ID *string `json:"id,omitempty"`

	// Azure Resource Manager geo location of the resource.
	Location *string `json:"location,omitempty"`

	// current.
	Name *string `json:"name,omitempty"`

	// Properties of availability state.
	Properties *AvailabilityStatusProperties `json:"properties,omitempty"`

	// Microsoft.ResourceHealth/AvailabilityStatuses.
	Type *string `json:"type,omitempty"`
}

AvailabilityStatus - availabilityStatus of a resource.

type AvailabilityStatusListResult 

type AvailabilityStatusListResult struct {
	// REQUIRED; The list of availabilityStatuses.
	Value []*AvailabilityStatus `json:"value,omitempty"`

	// The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses.
	NextLink *string `json:"nextLink,omitempty"`
}

AvailabilityStatusListResult - The List availabilityStatus operation response.

func (AvailabilityStatusListResult) MarshalJSON 

func (a AvailabilityStatusListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailabilityStatusListResult.

type AvailabilityStatusProperties 

type AvailabilityStatusProperties struct {
	// Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting
	// event
	AvailabilityState *AvailabilityStateValues `json:"availabilityState,omitempty"`

	// Details of the availability status.
	DetailedStatus *string `json:"detailedStatus,omitempty"`

	// In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples
	// are Planned, Unplanned etc.
	HealthEventCategory *string `json:"healthEventCategory,omitempty"`

	// In case of an availability impacting event, it describes where the health impacting event was originated. Examples are
	// PlatformInitiated, UserInitiated etc.
	HealthEventCause *string `json:"healthEventCause,omitempty"`

	// It is a unique Id that identifies the event
	HealthEventID *string `json:"healthEventId,omitempty"`

	// In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle,
	// Downtime, Fault Analysis etc.
	HealthEventType *string `json:"healthEventType,omitempty"`

	// Timestamp for when last change in health status occurred.
	OccuredTime *time.Time `json:"occuredTime,omitempty"`

	// Chronicity of the availability transition.
	ReasonChronicity *ReasonChronicityTypes `json:"reasonChronicity,omitempty"`

	// When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples
	// are planned, unplanned, user initiated or an outage etc.
	ReasonType *string `json:"reasonType,omitempty"`

	// An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned
	RecentlyResolvedState *AvailabilityStatusPropertiesRecentlyResolvedState `json:"recentlyResolvedState,omitempty"`

	// Lists actions the user can take based on the current availabilityState of the resource.
	RecommendedActions []*RecommendedAction `json:"recommendedActions,omitempty"`

	// Timestamp for when the health was last checked.
	ReportedTime *time.Time `json:"reportedTime,omitempty"`

	// When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and
	// time for when the issue is expected to be resolved.
	ResolutionETA *time.Time `json:"resolutionETA,omitempty"`

	// When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was
	// received.
	RootCauseAttributionTime *time.Time `json:"rootCauseAttributionTime,omitempty"`

	// Lists the service impacting events that may be affecting the health of the resource.
	ServiceImpactingEvents []*ServiceImpactingEvent `json:"serviceImpactingEvents,omitempty"`

	// Summary description of the availability status.
	Summary *string `json:"summary,omitempty"`
}

AvailabilityStatusProperties - Properties of availability state.

func (AvailabilityStatusProperties) MarshalJSON 

func (a AvailabilityStatusProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailabilityStatusProperties.

func (*AvailabilityStatusProperties) UnmarshalJSON 

func (a *AvailabilityStatusProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailabilityStatusProperties.

type AvailabilityStatusPropertiesRecentlyResolvedState 

type AvailabilityStatusPropertiesRecentlyResolvedState struct {
	// Timestamp when the availabilityState changes to Available.
	ResolvedTime *time.Time `json:"resolvedTime,omitempty"`

	// Brief description of cause of the resource becoming unavailable.
	UnavailabilitySummary *string `json:"unavailabilitySummary,omitempty"`

	// Timestamp for when the availabilityState changed to Unavailable
	UnavailableOccurredTime *time.Time `json:"unavailableOccurredTime,omitempty"`
}

AvailabilityStatusPropertiesRecentlyResolvedState - An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned

func (AvailabilityStatusPropertiesRecentlyResolvedState) MarshalJSON 

func (a AvailabilityStatusPropertiesRecentlyResolvedState) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailabilityStatusPropertiesRecentlyResolvedState.

func (*AvailabilityStatusPropertiesRecentlyResolvedState) UnmarshalJSON 

func (a *AvailabilityStatusPropertiesRecentlyResolvedState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailabilityStatusPropertiesRecentlyResolvedState.

type AvailabilityStatusesClient 

type AvailabilityStatusesClient struct {
	// contains filtered or unexported fields
}

AvailabilityStatusesClient contains the methods for the AvailabilityStatuses group. Don't use this type directly, use NewAvailabilityStatusesClient() instead.

func NewAvailabilityStatusesClient 

func NewAvailabilityStatusesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AvailabilityStatusesClient

NewAvailabilityStatusesClient creates a new instance of AvailabilityStatusesClient with the specified values. subscriptionID - Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AvailabilityStatusesClient) GetByResource 

func (client *AvailabilityStatusesClient) GetByResource(ctx context.Context, resourceURI string, options *AvailabilityStatusesClientGetByResourceOptions) (AvailabilityStatusesClientGetByResourceResponse, error)

GetByResource - Gets current availability status for a single resource If the operation fails it returns an *azcore.ResponseError type. resourceURI - The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} options - AvailabilityStatusesClientGetByResourceOptions contains the optional parameters for the AvailabilityStatusesClient.GetByResource method.

Example

x-ms-original-file: specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatus_GetByResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourcehealth/armresourcehealth"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresourcehealth.NewAvailabilityStatusesClient("<subscription-id>", cred, nil)
	res, err := client.GetByResource(ctx,
		"<resource-uri>",
		&armresourcehealth.AvailabilityStatusesClientGetByResourceOptions{Filter: nil,
			Expand: to.StringPtr("<expand>"),
		})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.AvailabilityStatusesClientGetByResourceResult)
}

Output:

func (*AvailabilityStatusesClient) List 

func (client *AvailabilityStatusesClient) List(resourceURI string, options *AvailabilityStatusesClientListOptions) *AvailabilityStatusesClientListPager

List - Lists all historical availability transitions and impacting events for a single resource. Use the nextLink property in the response to get the next page of availability status If the operation fails it returns an *azcore.ResponseError type. resourceURI - The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} options - AvailabilityStatusesClientListOptions contains the optional parameters for the AvailabilityStatusesClient.List method.

Example

x-ms-original-file: specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourcehealth/armresourcehealth"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresourcehealth.NewAvailabilityStatusesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-uri>",
		&armresourcehealth.AvailabilityStatusesClientListOptions{Filter: nil,
			Expand: nil,
		})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*AvailabilityStatusesClient) ListByResourceGroup 

func (client *AvailabilityStatusesClient) ListByResourceGroup(resourceGroupName string, options *AvailabilityStatusesClientListByResourceGroupOptions) *AvailabilityStatusesClientListByResourceGroupPager

ListByResourceGroup - Lists the current availability status for all the resources in the resource group. Use the nextLink property in the response to get the next page of availability statuses. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. options - AvailabilityStatusesClientListByResourceGroupOptions contains the optional parameters for the AvailabilityStatusesClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_ListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourcehealth/armresourcehealth"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresourcehealth.NewAvailabilityStatusesClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		&armresourcehealth.AvailabilityStatusesClientListByResourceGroupOptions{Filter: nil,
			Expand: to.StringPtr("<expand>"),
		})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*AvailabilityStatusesClient) ListBySubscriptionID 

func (client *AvailabilityStatusesClient) ListBySubscriptionID(options *AvailabilityStatusesClientListBySubscriptionIDOptions) *AvailabilityStatusesClientListBySubscriptionIDPager

ListBySubscriptionID - Lists the current availability status for all the resources in the subscription. Use the nextLink property in the response to get the next page of availability statuses. If the operation fails it returns an *azcore.ResponseError type. options - AvailabilityStatusesClientListBySubscriptionIDOptions contains the optional parameters for the AvailabilityStatusesClient.ListBySubscriptionID method.

type AvailabilityStatusesClientGetByResourceOptions added in v0.3.0 

type AvailabilityStatusesClientGetByResourceOptions struct {
	// Setting $expand=recommendedactions in url query expands the recommendedactions in the response.
	Expand *string
	// The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
	Filter *string
}

AvailabilityStatusesClientGetByResourceOptions contains the optional parameters for the AvailabilityStatusesClient.GetByResource method.

type AvailabilityStatusesClientGetByResourceResponse added in v0.3.0 

type AvailabilityStatusesClientGetByResourceResponse struct {
	AvailabilityStatusesClientGetByResourceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailabilityStatusesClientGetByResourceResponse contains the response from method AvailabilityStatusesClient.GetByResource.

type AvailabilityStatusesClientGetByResourceResult added in v0.3.0 

type AvailabilityStatusesClientGetByResourceResult struct {
	AvailabilityStatus
}

AvailabilityStatusesClientGetByResourceResult contains the result from method AvailabilityStatusesClient.GetByResource.

type AvailabilityStatusesClientListByResourceGroupOptions added in v0.3.0 

type AvailabilityStatusesClientListByResourceGroupOptions struct {
	// Setting $expand=recommendedactions in url query expands the recommendedactions in the response.
	Expand *string
	// The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
	Filter *string
}

AvailabilityStatusesClientListByResourceGroupOptions contains the optional parameters for the AvailabilityStatusesClient.ListByResourceGroup method.

type AvailabilityStatusesClientListByResourceGroupPager added in v0.3.0 

type AvailabilityStatusesClientListByResourceGroupPager struct {
	// contains filtered or unexported fields
}

AvailabilityStatusesClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*AvailabilityStatusesClientListByResourceGroupPager) Err added in v0.3.0 

func (p *AvailabilityStatusesClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*AvailabilityStatusesClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *AvailabilityStatusesClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AvailabilityStatusesClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *AvailabilityStatusesClientListByResourceGroupPager) PageResponse() AvailabilityStatusesClientListByResourceGroupResponse

PageResponse returns the current AvailabilityStatusesClientListByResourceGroupResponse page.

type AvailabilityStatusesClientListByResourceGroupResponse added in v0.3.0 

type AvailabilityStatusesClientListByResourceGroupResponse struct {
	AvailabilityStatusesClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailabilityStatusesClientListByResourceGroupResponse contains the response from method AvailabilityStatusesClient.ListByResourceGroup.

type AvailabilityStatusesClientListByResourceGroupResult added in v0.3.0 

type AvailabilityStatusesClientListByResourceGroupResult struct {
	AvailabilityStatusListResult
}

AvailabilityStatusesClientListByResourceGroupResult contains the result from method AvailabilityStatusesClient.ListByResourceGroup.

type AvailabilityStatusesClientListBySubscriptionIDOptions added in v0.3.0 

type AvailabilityStatusesClientListBySubscriptionIDOptions struct {
	// Setting $expand=recommendedactions in url query expands the recommendedactions in the response.
	Expand *string
	// The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
	Filter *string
}

AvailabilityStatusesClientListBySubscriptionIDOptions contains the optional parameters for the AvailabilityStatusesClient.ListBySubscriptionID method.

type AvailabilityStatusesClientListBySubscriptionIDPager added in v0.3.0 

type AvailabilityStatusesClientListBySubscriptionIDPager struct {
	// contains filtered or unexported fields
}

AvailabilityStatusesClientListBySubscriptionIDPager provides operations for iterating over paged responses.

func (*AvailabilityStatusesClientListBySubscriptionIDPager) Err added in v0.3.0 

func (p *AvailabilityStatusesClientListBySubscriptionIDPager) Err() error

Err returns the last error encountered while paging.

func (*AvailabilityStatusesClientListBySubscriptionIDPager) NextPage added in v0.3.0 

func (p *AvailabilityStatusesClientListBySubscriptionIDPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AvailabilityStatusesClientListBySubscriptionIDPager) PageResponse added in v0.3.0 

func (p *AvailabilityStatusesClientListBySubscriptionIDPager) PageResponse() AvailabilityStatusesClientListBySubscriptionIDResponse

PageResponse returns the current AvailabilityStatusesClientListBySubscriptionIDResponse page.

type AvailabilityStatusesClientListBySubscriptionIDResponse added in v0.3.0 

type AvailabilityStatusesClientListBySubscriptionIDResponse struct {
	AvailabilityStatusesClientListBySubscriptionIDResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailabilityStatusesClientListBySubscriptionIDResponse contains the response from method AvailabilityStatusesClient.ListBySubscriptionID.

type AvailabilityStatusesClientListBySubscriptionIDResult added in v0.3.0 

type AvailabilityStatusesClientListBySubscriptionIDResult struct {
	AvailabilityStatusListResult
}

AvailabilityStatusesClientListBySubscriptionIDResult contains the result from method AvailabilityStatusesClient.ListBySubscriptionID.

type AvailabilityStatusesClientListOptions added in v0.3.0 

type AvailabilityStatusesClientListOptions struct {
	// Setting $expand=recommendedactions in url query expands the recommendedactions in the response.
	Expand *string
	// The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
	Filter *string
}

AvailabilityStatusesClientListOptions contains the optional parameters for the AvailabilityStatusesClient.List method.

type AvailabilityStatusesClientListPager added in v0.3.0 

type AvailabilityStatusesClientListPager struct {
	// contains filtered or unexported fields
}

AvailabilityStatusesClientListPager provides operations for iterating over paged responses.

func (*AvailabilityStatusesClientListPager) Err added in v0.3.0 

func (p *AvailabilityStatusesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*AvailabilityStatusesClientListPager) NextPage added in v0.3.0 

func (p *AvailabilityStatusesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AvailabilityStatusesClientListPager) PageResponse added in v0.3.0 

func (p *AvailabilityStatusesClientListPager) PageResponse() AvailabilityStatusesClientListResponse

PageResponse returns the current AvailabilityStatusesClientListResponse page.

type AvailabilityStatusesClientListResponse added in v0.3.0 

type AvailabilityStatusesClientListResponse struct {
	AvailabilityStatusesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AvailabilityStatusesClientListResponse contains the response from method AvailabilityStatusesClient.List.

type AvailabilityStatusesClientListResult added in v0.3.0 

type AvailabilityStatusesClientListResult struct {
	AvailabilityStatusListResult
}

AvailabilityStatusesClientListResult contains the result from method AvailabilityStatusesClient.List.

type ChildAvailabilityStatusesClient 

type ChildAvailabilityStatusesClient struct {
	// contains filtered or unexported fields
}

ChildAvailabilityStatusesClient contains the methods for the ChildAvailabilityStatuses group. Don't use this type directly, use NewChildAvailabilityStatusesClient() instead.

func NewChildAvailabilityStatusesClient 

func NewChildAvailabilityStatusesClient(credential azcore.TokenCredential, options *arm.ClientOptions) *ChildAvailabilityStatusesClient

NewChildAvailabilityStatusesClient creates a new instance of ChildAvailabilityStatusesClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ChildAvailabilityStatusesClient) GetByResource 

func (client *ChildAvailabilityStatusesClient) GetByResource(ctx context.Context, resourceURI string, options *ChildAvailabilityStatusesClientGetByResourceOptions) (ChildAvailabilityStatusesClientGetByResourceResponse, error)

GetByResource - Gets current availability status for a single resource If the operation fails it returns an *azcore.ResponseError type. resourceURI - The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} options - ChildAvailabilityStatusesClientGetByResourceOptions contains the optional parameters for the ChildAvailabilityStatusesClient.GetByResource method.

Example

x-ms-original-file: specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilityStatus_GetByResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourcehealth/armresourcehealth"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresourcehealth.NewChildAvailabilityStatusesClient(cred, nil)
	res, err := client.GetByResource(ctx,
		"<resource-uri>",
		&armresourcehealth.ChildAvailabilityStatusesClientGetByResourceOptions{Filter: nil,
			Expand: to.StringPtr("<expand>"),
		})
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ChildAvailabilityStatusesClientGetByResourceResult)
}

Output:

func (*ChildAvailabilityStatusesClient) List 

func (client *ChildAvailabilityStatusesClient) List(resourceURI string, options *ChildAvailabilityStatusesClientListOptions) *ChildAvailabilityStatusesClientListPager

List - Lists the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status If the operation fails it returns an *azcore.ResponseError type. resourceURI - The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} options - ChildAvailabilityStatusesClientListOptions contains the optional parameters for the ChildAvailabilityStatusesClient.List method.

Example

x-ms-original-file: specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilityStatuses_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourcehealth/armresourcehealth"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresourcehealth.NewChildAvailabilityStatusesClient(cred, nil)
	pager := client.List("<resource-uri>",
		&armresourcehealth.ChildAvailabilityStatusesClientListOptions{Filter: nil,
			Expand: nil,
		})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ChildAvailabilityStatusesClientGetByResourceOptions added in v0.3.0 

type ChildAvailabilityStatusesClientGetByResourceOptions struct {
	// Setting $expand=recommendedactions in url query expands the recommendedactions in the response.
	Expand *string
	// The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
	Filter *string
}

ChildAvailabilityStatusesClientGetByResourceOptions contains the optional parameters for the ChildAvailabilityStatusesClient.GetByResource method.

type ChildAvailabilityStatusesClientGetByResourceResponse added in v0.3.0 

type ChildAvailabilityStatusesClientGetByResourceResponse struct {
	ChildAvailabilityStatusesClientGetByResourceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ChildAvailabilityStatusesClientGetByResourceResponse contains the response from method ChildAvailabilityStatusesClient.GetByResource.

type ChildAvailabilityStatusesClientGetByResourceResult added in v0.3.0 

type ChildAvailabilityStatusesClientGetByResourceResult struct {
	AvailabilityStatus
}

ChildAvailabilityStatusesClientGetByResourceResult contains the result from method ChildAvailabilityStatusesClient.GetByResource.

type ChildAvailabilityStatusesClientListOptions added in v0.3.0 

type ChildAvailabilityStatusesClientListOptions struct {
	// Setting $expand=recommendedactions in url query expands the recommendedactions in the response.
	Expand *string
	// The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
	Filter *string
}

ChildAvailabilityStatusesClientListOptions contains the optional parameters for the ChildAvailabilityStatusesClient.List method.

type ChildAvailabilityStatusesClientListPager added in v0.3.0 

type ChildAvailabilityStatusesClientListPager struct {
	// contains filtered or unexported fields
}

ChildAvailabilityStatusesClientListPager provides operations for iterating over paged responses.

func (*ChildAvailabilityStatusesClientListPager) Err added in v0.3.0 

func (p *ChildAvailabilityStatusesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ChildAvailabilityStatusesClientListPager) NextPage added in v0.3.0 

func (p *ChildAvailabilityStatusesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ChildAvailabilityStatusesClientListPager) PageResponse added in v0.3.0 

func (p *ChildAvailabilityStatusesClientListPager) PageResponse() ChildAvailabilityStatusesClientListResponse

PageResponse returns the current ChildAvailabilityStatusesClientListResponse page.

type ChildAvailabilityStatusesClientListResponse added in v0.3.0 

type ChildAvailabilityStatusesClientListResponse struct {
	ChildAvailabilityStatusesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ChildAvailabilityStatusesClientListResponse contains the response from method ChildAvailabilityStatusesClient.List.

type ChildAvailabilityStatusesClientListResult added in v0.3.0 

type ChildAvailabilityStatusesClientListResult struct {
	AvailabilityStatusListResult
}

ChildAvailabilityStatusesClientListResult contains the result from method ChildAvailabilityStatusesClient.List.

type ChildResourcesClient 

type ChildResourcesClient struct {
	// contains filtered or unexported fields
}

ChildResourcesClient contains the methods for the ChildResources group. Don't use this type directly, use NewChildResourcesClient() instead.

func NewChildResourcesClient 

func NewChildResourcesClient(credential azcore.TokenCredential, options *arm.ClientOptions) *ChildResourcesClient

NewChildResourcesClient creates a new instance of ChildResourcesClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ChildResourcesClient) List 

func (client *ChildResourcesClient) List(resourceURI string, options *ChildResourcesClientListOptions) *ChildResourcesClientListPager

List - Lists the all the children and its current health status for a parent resource. Use the nextLink property in the response to get the next page of children current health If the operation fails it returns an *azcore.ResponseError type. resourceURI - The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support not nested parent resource type: /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} options - ChildResourcesClientListOptions contains the optional parameters for the ChildResourcesClient.List method.

Example

x-ms-original-file: specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildResources_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourcehealth/armresourcehealth"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresourcehealth.NewChildResourcesClient(cred, nil)
	pager := client.List("<resource-uri>",
		&armresourcehealth.ChildResourcesClientListOptions{Filter: nil,
			Expand: nil,
		})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ChildResourcesClientListOptions added in v0.3.0 

type ChildResourcesClientListOptions struct {
	// Setting $expand=recommendedactions in url query expands the recommendedactions in the response.
	Expand *string
	// The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN
	Filter *string
}

ChildResourcesClientListOptions contains the optional parameters for the ChildResourcesClient.List method.

type ChildResourcesClientListPager added in v0.3.0 

type ChildResourcesClientListPager struct {
	// contains filtered or unexported fields
}

ChildResourcesClientListPager provides operations for iterating over paged responses.

func (*ChildResourcesClientListPager) Err added in v0.3.0 

func (p *ChildResourcesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ChildResourcesClientListPager) NextPage added in v0.3.0 

func (p *ChildResourcesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ChildResourcesClientListPager) PageResponse added in v0.3.0 

func (p *ChildResourcesClientListPager) PageResponse() ChildResourcesClientListResponse

PageResponse returns the current ChildResourcesClientListResponse page.

type ChildResourcesClientListResponse added in v0.3.0 

type ChildResourcesClientListResponse struct {
	ChildResourcesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ChildResourcesClientListResponse contains the response from method ChildResourcesClient.List.

type ChildResourcesClientListResult added in v0.3.0 

type ChildResourcesClientListResult struct {
	AvailabilityStatusListResult
}

ChildResourcesClientListResult contains the result from method ChildResourcesClient.List.

type EmergingIssue 

type EmergingIssue struct {
	// Timestamp for when last time refreshed for ongoing emerging issue.
	RefreshTimestamp *time.Time `json:"refreshTimestamp,omitempty"`

	// The list of emerging issues of active event type.
	StatusActiveEvents []*StatusActiveEvent `json:"statusActiveEvents,omitempty"`

	// The list of emerging issues of banner type.
	StatusBanners []*StatusBanner `json:"statusBanners,omitempty"`
}

EmergingIssue - On-going emerging issue from azure status.

func (EmergingIssue) MarshalJSON 

func (e EmergingIssue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EmergingIssue.

func (*EmergingIssue) UnmarshalJSON 

func (e *EmergingIssue) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EmergingIssue.

type EmergingIssueImpact 

type EmergingIssueImpact struct {
	// The impacted service id.
	ID *string `json:"id,omitempty"`

	// The impacted service name.
	Name *string `json:"name,omitempty"`

	// The list of impacted regions for corresponding emerging issues.
	Regions []*ImpactedRegion `json:"regions,omitempty"`
}

EmergingIssueImpact - Object of the emerging issue impact on services and regions.

func (EmergingIssueImpact) MarshalJSON 

func (e EmergingIssueImpact) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EmergingIssueImpact.

type EmergingIssueListResult 

type EmergingIssueListResult struct {
	// The link used to get the next page of emerging issues.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of emerging issues.
	Value []*EmergingIssuesGetResult `json:"value,omitempty"`
}

EmergingIssueListResult - The list of emerging issues.

func (EmergingIssueListResult) MarshalJSON 

func (e EmergingIssueListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EmergingIssueListResult.

type EmergingIssuesClient 

type EmergingIssuesClient struct {
	// contains filtered or unexported fields
}

EmergingIssuesClient contains the methods for the EmergingIssues group. Don't use this type directly, use NewEmergingIssuesClient() instead.

func NewEmergingIssuesClient 

func NewEmergingIssuesClient(credential azcore.TokenCredential, options *arm.ClientOptions) *EmergingIssuesClient

NewEmergingIssuesClient creates a new instance of EmergingIssuesClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*EmergingIssuesClient) Get 

func (client *EmergingIssuesClient) Get(ctx context.Context, issueName Enum0, options *EmergingIssuesClientGetOptions) (EmergingIssuesClientGetResponse, error)

Get - Gets Azure services' emerging issues. If the operation fails it returns an *azcore.ResponseError type. issueName - The name of the emerging issue. options - EmergingIssuesClientGetOptions contains the optional parameters for the EmergingIssuesClient.Get method.

Example

x-ms-original-file: specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/EmergingIssues_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourcehealth/armresourcehealth"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresourcehealth.NewEmergingIssuesClient(cred, nil)
	res, err := client.Get(ctx,
		armresourcehealth.Enum0("default"),
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.EmergingIssuesClientGetResult)
}

Output:

func (*EmergingIssuesClient) List 

func (client *EmergingIssuesClient) List(options *EmergingIssuesClientListOptions) *EmergingIssuesClientListPager

List - Lists Azure services' emerging issues. If the operation fails it returns an *azcore.ResponseError type. options - EmergingIssuesClientListOptions contains the optional parameters for the EmergingIssuesClient.List method.

Example

x-ms-original-file: specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/EmergingIssues_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resourcehealth/armresourcehealth"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armresourcehealth.NewEmergingIssuesClient(cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type EmergingIssuesClientGetOptions added in v0.3.0 

type EmergingIssuesClientGetOptions struct {
}

EmergingIssuesClientGetOptions contains the optional parameters for the EmergingIssuesClient.Get method.

type EmergingIssuesClientGetResponse added in v0.3.0 

type EmergingIssuesClientGetResponse struct {
	EmergingIssuesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

EmergingIssuesClientGetResponse contains the response from method EmergingIssuesClient.Get.

type EmergingIssuesClientGetResult added in v0.3.0 

type EmergingIssuesClientGetResult struct {
	EmergingIssuesGetResult
}

EmergingIssuesClientGetResult contains the result from method EmergingIssuesClient.Get.

type EmergingIssuesClientListOptions added in v0.3.0 

type EmergingIssuesClientListOptions struct {
}

EmergingIssuesClientListOptions contains the optional parameters for the EmergingIssuesClient.List method.

type EmergingIssuesClientListPager added in v0.3.0 

type EmergingIssuesClientListPager struct {
	// contains filtered or unexported fields
}

EmergingIssuesClientListPager provides operations for iterating over paged responses.

func (*EmergingIssuesClientListPager) Err added in v0.3.0 

func (p *EmergingIssuesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*EmergingIssuesClientListPager) NextPage added in v0.3.0 

func (p *EmergingIssuesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*EmergingIssuesClientListPager) PageResponse added in v0.3.0 

func (p *EmergingIssuesClientListPager) PageResponse() EmergingIssuesClientListResponse

PageResponse returns the current EmergingIssuesClientListResponse page.

type EmergingIssuesClientListResponse added in v0.3.0 

type EmergingIssuesClientListResponse struct {
	EmergingIssuesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

EmergingIssuesClientListResponse contains the response from method EmergingIssuesClient.List.

type EmergingIssuesClientListResult added in v0.3.0 

type EmergingIssuesClientListResult struct {
	EmergingIssueListResult
}

EmergingIssuesClientListResult contains the result from method EmergingIssuesClient.List.

type EmergingIssuesGetResult 

type EmergingIssuesGetResult struct {
	// The emerging issue entity properties.
	Properties *EmergingIssue `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

EmergingIssuesGetResult - The Get EmergingIssues operation response.

type Enum0 

type Enum0 string
const (
	Enum0Default Enum0 = "default"
)

func PossibleEnum0Values 

func PossibleEnum0Values() []Enum0

PossibleEnum0Values returns the possible values for the Enum0 const type.

func (Enum0) ToPtr 

func (c Enum0) ToPtr() *Enum0

ToPtr returns a *Enum0 pointing to the current value.

type ErrorResponse 

type ErrorResponse struct {
	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details *string `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`
}

ErrorResponse - Error details.

type ImpactedRegion 

type ImpactedRegion struct {
	// The impacted region id.
	ID *string `json:"id,omitempty"`

	// The impacted region name.
	Name *string `json:"name,omitempty"`
}

ImpactedRegion - Object of impacted region.

type Operation 

type Operation struct {
	// Properties of the operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// Name of the operation.
	Name *string `json:"name,omitempty"`
}

Operation available in the resourcehealth resource provider.

type OperationDisplay 

type OperationDisplay struct {
	// Description of the operation.
	Description *string `json:"description,omitempty"`

	// Operation name.
	Operation *string `json:"operation,omitempty"`

	// Provider name.
	Provider *string `json:"provider,omitempty"`

	// Resource name.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - Properties of the operation.

type OperationListResult 

type OperationListResult struct {
	// REQUIRED; List of operations available in the resourcehealth resource provider.
	Value []*Operation `json:"value,omitempty"`
}

OperationListResult - Lists the operations response.

func (OperationListResult) MarshalJSON 

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) List 

func (client *OperationsClient) List(ctx context.Context, options *OperationsClientListOptions) (OperationsClientListResponse, error)

List - Lists available operations for the resourcehealth resource provider If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListOptions added in v0.3.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.3.0 

type OperationsClientListResponse struct {
	OperationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsClientListResult added in v0.3.0 

type OperationsClientListResult struct {
	OperationListResult
}

OperationsClientListResult contains the result from method OperationsClient.List.

type ReasonChronicityTypes 

type ReasonChronicityTypes string

ReasonChronicityTypes - Chronicity of the availability transition. 

const (
	ReasonChronicityTypesTransient  ReasonChronicityTypes = "Transient"
	ReasonChronicityTypesPersistent ReasonChronicityTypes = "Persistent"
)

func PossibleReasonChronicityTypesValues 

func PossibleReasonChronicityTypesValues() []ReasonChronicityTypes

PossibleReasonChronicityTypesValues returns the possible values for the ReasonChronicityTypes const type.

func (ReasonChronicityTypes) ToPtr 

func (c ReasonChronicityTypes) ToPtr() *ReasonChronicityTypes

ToPtr returns a *ReasonChronicityTypes pointing to the current value.

type RecommendedAction 

type RecommendedAction struct {
	// Recommended action.
	Action *string `json:"action,omitempty"`

	// Link to the action
	ActionURL *string `json:"actionUrl,omitempty"`

	// Substring of action, it describes which text should host the action url.
	ActionURLText *string `json:"actionUrlText,omitempty"`
}

RecommendedAction - Lists actions the user can take based on the current availabilityState of the resource.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

type ServiceImpactingEvent 

type ServiceImpactingEvent struct {
	// Correlation id for the event
	CorrelationID *string `json:"correlationId,omitempty"`

	// Timestamp for when the event started.
	EventStartTime *time.Time `json:"eventStartTime,omitempty"`

	// Timestamp for when event was submitted/detected.
	EventStatusLastModifiedTime *time.Time `json:"eventStatusLastModifiedTime,omitempty"`

	// Properties of the service impacting event.
	IncidentProperties *ServiceImpactingEventIncidentProperties `json:"incidentProperties,omitempty"`

	// Status of the service impacting event.
	Status *ServiceImpactingEventStatus `json:"status,omitempty"`
}

ServiceImpactingEvent - Lists the service impacting events that may be affecting the health of the resource.

func (ServiceImpactingEvent) MarshalJSON 

func (s ServiceImpactingEvent) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceImpactingEvent.

func (*ServiceImpactingEvent) UnmarshalJSON 

func (s *ServiceImpactingEvent) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceImpactingEvent.

type ServiceImpactingEventIncidentProperties 

type ServiceImpactingEventIncidentProperties struct {
	// Type of Event.
	IncidentType *string `json:"incidentType,omitempty"`

	// Region impacted by the event.
	Region *string `json:"region,omitempty"`

	// Service impacted by the event.
	Service *string `json:"service,omitempty"`

	// Title of the incident.
	Title *string `json:"title,omitempty"`
}

ServiceImpactingEventIncidentProperties - Properties of the service impacting event.

type ServiceImpactingEventStatus 

type ServiceImpactingEventStatus struct {
	// Current status of the event
	Value *string `json:"value,omitempty"`
}

ServiceImpactingEventStatus - Status of the service impacting event.

type SeverityValues 

type SeverityValues string

SeverityValues - The severity level of this active event. 

const (
	SeverityValuesError       SeverityValues = "Error"
	SeverityValuesInformation SeverityValues = "Information"
	SeverityValuesWarning     SeverityValues = "Warning"
)

func PossibleSeverityValuesValues 

func PossibleSeverityValuesValues() []SeverityValues

PossibleSeverityValuesValues returns the possible values for the SeverityValues const type.

func (SeverityValues) ToPtr 

func (c SeverityValues) ToPtr() *SeverityValues

ToPtr returns a *SeverityValues pointing to the current value.

type StageValues 

type StageValues string

StageValues - The stage of this active event. 

const (
	StageValuesActive   StageValues = "Active"
	StageValuesArchived StageValues = "Archived"
	StageValuesResolve  StageValues = "Resolve"
)

func PossibleStageValuesValues 

func PossibleStageValuesValues() []StageValues

PossibleStageValuesValues returns the possible values for the StageValues const type.

func (StageValues) ToPtr 

func (c StageValues) ToPtr() *StageValues

ToPtr returns a *StageValues pointing to the current value.

type StatusActiveEvent 

type StatusActiveEvent struct {
	// The cloud type of this active event.
	Cloud *string `json:"cloud,omitempty"`

	// The details of active event.
	Description *string `json:"description,omitempty"`

	// The list of emerging issues impacts.
	Impacts []*EmergingIssueImpact `json:"impacts,omitempty"`

	// The last time modified on this banner.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// The boolean value of this active event if published or not.
	Published *bool `json:"published,omitempty"`

	// The severity level of this active event.
	Severity *SeverityValues `json:"severity,omitempty"`

	// The stage of this active event.
	Stage *StageValues `json:"stage,omitempty"`

	// The impact start time on this active event.
	StartTime *time.Time `json:"startTime,omitempty"`

	// The active event title.
	Title *string `json:"title,omitempty"`

	// The tracking id of this active event.
	TrackingID *string `json:"trackingId,omitempty"`
}

StatusActiveEvent - Active event type of emerging issue.

func (StatusActiveEvent) MarshalJSON 

func (s StatusActiveEvent) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StatusActiveEvent.

func (*StatusActiveEvent) UnmarshalJSON 

func (s *StatusActiveEvent) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StatusActiveEvent.

type StatusBanner 

type StatusBanner struct {
	// The cloud type of this banner.
	Cloud *string `json:"cloud,omitempty"`

	// The last time modified on this banner.
	LastModifiedTime *time.Time `json:"lastModifiedTime,omitempty"`

	// The details of banner.
	Message *string `json:"message,omitempty"`

	// The banner title.
	Title *string `json:"title,omitempty"`
}

StatusBanner - Banner type of emerging issue.

func (StatusBanner) MarshalJSON 

func (s StatusBanner) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StatusBanner.

func (*StatusBanner) UnmarshalJSON 

func (s *StatusBanner) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StatusBanner.

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.