mhsmlistregions

README

github.com/hashicorp/go-azure-sdk/resource-manager/keyvault/2023-07-01/mhsmlistregions Documentation

The mhsmlistregions SDK allows for interaction with the Azure Resource Manager Service keyvault (API Version 2023-07-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/keyvault/2023-07-01/mhsmlistregions"

Client Initialization

client := mhsmlistregions.NewMHSMListRegionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MHSMListRegionsClient.MHSMRegionsListByResource

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

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

Documentation

Index

• func PossibleValuesForGeoReplicationRegionProvisioningState() []string
• func ValidateManagedHSMID(input interface{}, key string) (warnings []string, errors []error)
• type GeoReplicationRegionProvisioningState
  • func (s *GeoReplicationRegionProvisioningState) UnmarshalJSON(bytes []byte) error
• type MHSMGeoReplicatedRegion
• type MHSMGeoReplicatedRegionOperationPredicate
  • func (p MHSMGeoReplicatedRegionOperationPredicate) Matches(input MHSMGeoReplicatedRegion) bool
• type MHSMListRegionsClient
  • func NewMHSMListRegionsClientWithBaseURI(sdkApi sdkEnv.Api) (*MHSMListRegionsClient, error)
  • func (c MHSMListRegionsClient) MHSMRegionsListByResource(ctx context.Context, id ManagedHSMId) (result MHSMRegionsListByResourceOperationResponse, err error)
  • func (c MHSMListRegionsClient) MHSMRegionsListByResourceComplete(ctx context.Context, id ManagedHSMId) (MHSMRegionsListByResourceCompleteResult, error)
  • func (c MHSMListRegionsClient) MHSMRegionsListByResourceCompleteMatchingPredicate(ctx context.Context, id ManagedHSMId, ...) (result MHSMRegionsListByResourceCompleteResult, err error)
• type MHSMRegionsListByResourceCompleteResult
• type MHSMRegionsListByResourceCustomPager
  • func (p *MHSMRegionsListByResourceCustomPager) NextPageLink() *odata.Link
• type MHSMRegionsListByResourceOperationResponse
• type ManagedHSMId
  • func NewManagedHSMID(subscriptionId string, resourceGroupName string, managedHSMName string) ManagedHSMId
  • func ParseManagedHSMID(input string) (*ManagedHSMId, error)
  • func ParseManagedHSMIDInsensitively(input string) (*ManagedHSMId, error)
  • func (id *ManagedHSMId) FromParseResult(input resourceids.ParseResult) error
  • func (id ManagedHSMId) ID() string
  • func (id ManagedHSMId) Segments() []resourceids.Segment
  • func (id ManagedHSMId) String() string

Functions

func PossibleValuesForGeoReplicationRegionProvisioningState

func PossibleValuesForGeoReplicationRegionProvisioningState() []string

func ValidateManagedHSMID

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

ValidateManagedHSMID checks that 'input' can be parsed as a Managed H S M ID

Types

type GeoReplicationRegionProvisioningState

type GeoReplicationRegionProvisioningState string

const (
	GeoReplicationRegionProvisioningStateCleanup         GeoReplicationRegionProvisioningState = "Cleanup"
	GeoReplicationRegionProvisioningStateDeleting        GeoReplicationRegionProvisioningState = "Deleting"
	GeoReplicationRegionProvisioningStateFailed          GeoReplicationRegionProvisioningState = "Failed"
	GeoReplicationRegionProvisioningStatePreprovisioning GeoReplicationRegionProvisioningState = "Preprovisioning"
	GeoReplicationRegionProvisioningStateProvisioning    GeoReplicationRegionProvisioningState = "Provisioning"
	GeoReplicationRegionProvisioningStateSucceeded       GeoReplicationRegionProvisioningState = "Succeeded"
)

func (*GeoReplicationRegionProvisioningState) UnmarshalJSON

func (s *GeoReplicationRegionProvisioningState) UnmarshalJSON(bytes []byte) error

type MHSMGeoReplicatedRegion

type MHSMGeoReplicatedRegion struct {
	IsPrimary         *bool                                  `json:"isPrimary,omitempty"`
	Name              *string                                `json:"name,omitempty"`
	ProvisioningState *GeoReplicationRegionProvisioningState `json:"provisioningState,omitempty"`
}

type MHSMGeoReplicatedRegionOperationPredicate

type MHSMGeoReplicatedRegionOperationPredicate struct {
	IsPrimary *bool
	Name      *string
}

func (MHSMGeoReplicatedRegionOperationPredicate) Matches

func (p MHSMGeoReplicatedRegionOperationPredicate) Matches(input MHSMGeoReplicatedRegion) bool

type MHSMListRegionsClient

type MHSMListRegionsClient struct {
	Client *resourcemanager.Client
}

func NewMHSMListRegionsClientWithBaseURI

func NewMHSMListRegionsClientWithBaseURI(sdkApi sdkEnv.Api) (*MHSMListRegionsClient, error)

func (MHSMListRegionsClient) MHSMRegionsListByResource

func (c MHSMListRegionsClient) MHSMRegionsListByResource(ctx context.Context, id ManagedHSMId) (result MHSMRegionsListByResourceOperationResponse, err error)

MHSMRegionsListByResource ...

func (MHSMListRegionsClient) MHSMRegionsListByResourceComplete

func (c MHSMListRegionsClient) MHSMRegionsListByResourceComplete(ctx context.Context, id ManagedHSMId) (MHSMRegionsListByResourceCompleteResult, error)

MHSMRegionsListByResourceComplete retrieves all the results into a single object

func (MHSMListRegionsClient) MHSMRegionsListByResourceCompleteMatchingPredicate

func (c MHSMListRegionsClient) MHSMRegionsListByResourceCompleteMatchingPredicate(ctx context.Context, id ManagedHSMId, predicate MHSMGeoReplicatedRegionOperationPredicate) (result MHSMRegionsListByResourceCompleteResult, err error)

MHSMRegionsListByResourceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type MHSMRegionsListByResourceCompleteResult

type MHSMRegionsListByResourceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []MHSMGeoReplicatedRegion
}

type MHSMRegionsListByResourceCustomPager

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

func (*MHSMRegionsListByResourceCustomPager) NextPageLink

func (p *MHSMRegionsListByResourceCustomPager) NextPageLink() *odata.Link

type MHSMRegionsListByResourceOperationResponse

type MHSMRegionsListByResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]MHSMGeoReplicatedRegion
}

type ManagedHSMId

type ManagedHSMId struct {
	SubscriptionId    string
	ResourceGroupName string
	ManagedHSMName    string
}

ManagedHSMId is a struct representing the Resource ID for a Managed H S M

func NewManagedHSMID

func NewManagedHSMID(subscriptionId string, resourceGroupName string, managedHSMName string) ManagedHSMId

NewManagedHSMID returns a new ManagedHSMId struct

func ParseManagedHSMID

func ParseManagedHSMID(input string) (*ManagedHSMId, error)

ParseManagedHSMID parses 'input' into a ManagedHSMId

func ParseManagedHSMIDInsensitively

func ParseManagedHSMIDInsensitively(input string) (*ManagedHSMId, error)

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

func (*ManagedHSMId) FromParseResult

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

func (ManagedHSMId) ID

func (id ManagedHSMId) ID() string

ID returns the formatted Managed H S M ID

func (ManagedHSMId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Managed H S M ID

func (ManagedHSMId) String

func (id ManagedHSMId) String() string

String returns a human-readable description of this Managed H S M ID