privatelinkresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/redisenterprise/2023-11-01/privatelinkresources Documentation

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

Client Initialization

client := privatelinkresources.NewPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateLinkResourcesClient.ListByCluster

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

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

Documentation

Index

• func ValidateRedisEnterpriseID(input interface{}, key string) (warnings []string, errors []error)
• type ListByClusterOperationResponse
• type PrivateLinkResource
• type PrivateLinkResourceListResult
• type PrivateLinkResourceProperties
• type PrivateLinkResourcesClient
  • func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)
  • func (c PrivateLinkResourcesClient) ListByCluster(ctx context.Context, id RedisEnterpriseId) (result ListByClusterOperationResponse, err error)
• type RedisEnterpriseId
  • func NewRedisEnterpriseID(subscriptionId string, resourceGroupName string, redisEnterpriseName string) RedisEnterpriseId
  • func ParseRedisEnterpriseID(input string) (*RedisEnterpriseId, error)
  • func ParseRedisEnterpriseIDInsensitively(input string) (*RedisEnterpriseId, error)
  • func (id *RedisEnterpriseId) FromParseResult(input resourceids.ParseResult) error
  • func (id RedisEnterpriseId) ID() string
  • func (id RedisEnterpriseId) Segments() []resourceids.Segment
  • func (id RedisEnterpriseId) String() string

Functions

func ValidateRedisEnterpriseID

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

ValidateRedisEnterpriseID checks that 'input' can be parsed as a Redis Enterprise ID

Types

type ListByClusterOperationResponse

type ListByClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateLinkResourceListResult
}

type PrivateLinkResource

type PrivateLinkResource struct {
	Id         *string                        `json:"id,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type PrivateLinkResourceListResult

type PrivateLinkResourceListResult struct {
	Value *[]PrivateLinkResource `json:"value,omitempty"`
}

type PrivateLinkResourceProperties

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

type PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	Client *resourcemanager.Client
}

func NewPrivateLinkResourcesClientWithBaseURI

func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)

func (PrivateLinkResourcesClient) ListByCluster

func (c PrivateLinkResourcesClient) ListByCluster(ctx context.Context, id RedisEnterpriseId) (result ListByClusterOperationResponse, err error)

ListByCluster ...

type RedisEnterpriseId

type RedisEnterpriseId struct {
	SubscriptionId      string
	ResourceGroupName   string
	RedisEnterpriseName string
}

RedisEnterpriseId is a struct representing the Resource ID for a Redis Enterprise

func NewRedisEnterpriseID

func NewRedisEnterpriseID(subscriptionId string, resourceGroupName string, redisEnterpriseName string) RedisEnterpriseId

NewRedisEnterpriseID returns a new RedisEnterpriseId struct

func ParseRedisEnterpriseID

func ParseRedisEnterpriseID(input string) (*RedisEnterpriseId, error)

ParseRedisEnterpriseID parses 'input' into a RedisEnterpriseId

func ParseRedisEnterpriseIDInsensitively

func ParseRedisEnterpriseIDInsensitively(input string) (*RedisEnterpriseId, error)

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

func (*RedisEnterpriseId) FromParseResult

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

func (RedisEnterpriseId) ID

func (id RedisEnterpriseId) ID() string

ID returns the formatted Redis Enterprise ID

func (RedisEnterpriseId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Redis Enterprise ID

func (RedisEnterpriseId) String

func (id RedisEnterpriseId) String() string

String returns a human-readable description of this Redis Enterprise ID