mhsmprivatelinkresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/keyvault/2023-02-01/mhsmprivatelinkresources Documentation

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

Client Initialization

client := mhsmprivatelinkresources.NewMHSMPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MHSMPrivateLinkResourcesClient.ListByMHSMResource

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

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

Documentation

Index

• func PossibleValuesForManagedHsmSkuFamily() []string
• func PossibleValuesForManagedHsmSkuName() []string
• func ValidateManagedHSMID(input interface{}, key string) (warnings []string, errors []error)
• type ListByMHSMResourceOperationResponse
• type MHSMPrivateLinkResource
• type MHSMPrivateLinkResourceListResult
• type MHSMPrivateLinkResourceProperties
• type MHSMPrivateLinkResourcesClient
  • func NewMHSMPrivateLinkResourcesClientWithBaseURI(endpoint string) MHSMPrivateLinkResourcesClient
  • func (c MHSMPrivateLinkResourcesClient) ListByMHSMResource(ctx context.Context, id ManagedHSMId) (result ListByMHSMResourceOperationResponse, err error)
• 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) ID() string
  • func (id ManagedHSMId) Segments() []resourceids.Segment
  • func (id ManagedHSMId) String() string
• type ManagedHsmSku
• type ManagedHsmSkuFamily
• type ManagedHsmSkuName

Functions

func PossibleValuesForManagedHsmSkuFamily

func PossibleValuesForManagedHsmSkuFamily() []string

func PossibleValuesForManagedHsmSkuName

func PossibleValuesForManagedHsmSkuName() []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 ListByMHSMResourceOperationResponse

type ListByMHSMResourceOperationResponse struct {
	HttpResponse *http.Response
	Model        *MHSMPrivateLinkResourceListResult
}

type MHSMPrivateLinkResource

type MHSMPrivateLinkResource struct {
	Id         *string                            `json:"id,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *MHSMPrivateLinkResourceProperties `json:"properties,omitempty"`
	Sku        *ManagedHsmSku                     `json:"sku,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type MHSMPrivateLinkResourceListResult

type MHSMPrivateLinkResourceListResult struct {
	Value *[]MHSMPrivateLinkResource `json:"value,omitempty"`
}

type MHSMPrivateLinkResourceProperties

type MHSMPrivateLinkResourceProperties struct {
	GroupId           *string   `json:"groupId,omitempty"`
	RequiredMembers   *[]string `json:"requiredMembers,omitempty"`
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

type MHSMPrivateLinkResourcesClient

type MHSMPrivateLinkResourcesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewMHSMPrivateLinkResourcesClientWithBaseURI

func NewMHSMPrivateLinkResourcesClientWithBaseURI(endpoint string) MHSMPrivateLinkResourcesClient

func (MHSMPrivateLinkResourcesClient) ListByMHSMResource

func (c MHSMPrivateLinkResourcesClient) ListByMHSMResource(ctx context.Context, id ManagedHSMId) (result ListByMHSMResourceOperationResponse, err error)

ListByMHSMResource ...

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) 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

type ManagedHsmSku

type ManagedHsmSku struct {
	Family ManagedHsmSkuFamily `json:"family"`
	Name   ManagedHsmSkuName   `json:"name"`
}

type ManagedHsmSkuFamily

type ManagedHsmSkuFamily string

const (
	ManagedHsmSkuFamilyB ManagedHsmSkuFamily = "B"
)

type ManagedHsmSkuName

type ManagedHsmSkuName string

const (
	ManagedHsmSkuNameCustomBSix      ManagedHsmSkuName = "Custom_B6"
	ManagedHsmSkuNameCustomBThreeTwo ManagedHsmSkuName = "Custom_B32"
	ManagedHsmSkuNameStandardBOne    ManagedHsmSkuName = "Standard_B1"
)