servicelinker

package
v0.20240715.1100358 Latest Latest
Warning

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

 Go to latest Published: Jul 15, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicelinker/2022-05-01/servicelinker Documentation

The servicelinker SDK allows for interaction with the Azure Resource Manager Service servicelinker (API Version 2022-05-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/servicelinker/2022-05-01/servicelinker"

Client Initialization

client := servicelinker.NewServiceLinkerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServiceLinkerClient.LinkerCreateOrUpdate

ctx := context.TODO()
id := servicelinker.NewScopedLinkerID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "linkerValue")

payload := servicelinker.LinkerResource{
	// ...
}


if err := client.LinkerCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ServiceLinkerClient.LinkerGet

ctx := context.TODO()
id := servicelinker.NewScopedLinkerID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "linkerValue")

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

Example Usage: ServiceLinkerClient.LinkerList

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

func PossibleValuesForAuthType() []string

func PossibleValuesForAzureResourceType 

func PossibleValuesForAzureResourceType() []string

func PossibleValuesForClientType 

func PossibleValuesForClientType() []string

func PossibleValuesForSecretType 

func PossibleValuesForSecretType() []string

func PossibleValuesForTargetServiceType 

func PossibleValuesForTargetServiceType() []string

func PossibleValuesForVNetSolutionType 

func PossibleValuesForVNetSolutionType() []string

func ValidateScopedLinkerID 

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

ValidateScopedLinkerID checks that 'input' can be parsed as a Scoped Linker ID

Types

type AuthInfoBase 

type AuthInfoBase interface {
}

type AuthType 

type AuthType string
const (
	AuthTypeSecret                      AuthType = "secret"
	AuthTypeServicePrincipalCertificate AuthType = "servicePrincipalCertificate"
	AuthTypeServicePrincipalSecret      AuthType = "servicePrincipalSecret"
	AuthTypeSystemAssignedIdentity      AuthType = "systemAssignedIdentity"
	AuthTypeUserAssignedIdentity        AuthType = "userAssignedIdentity"
)

func (*AuthType) UnmarshalJSON 

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

type AzureKeyVaultProperties 

type AzureKeyVaultProperties struct {
	ConnectAsKubernetesCsiDriver *bool `json:"connectAsKubernetesCsiDriver,omitempty"`
}

func (AzureKeyVaultProperties) MarshalJSON 

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

type AzureResource 

type AzureResource struct {
	Id                 *string                     `json:"id,omitempty"`
	ResourceProperties AzureResourcePropertiesBase `json:"resourceProperties"`
}

func (AzureResource) MarshalJSON 

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

func (*AzureResource) UnmarshalJSON 

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

type AzureResourcePropertiesBase 

type AzureResourcePropertiesBase interface {
}

type AzureResourceType 

type AzureResourceType string
const (
	AzureResourceTypeKeyVault AzureResourceType = "KeyVault"
)

func (*AzureResourceType) UnmarshalJSON 

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

type ClientType 

type ClientType string
const (
	ClientTypeDjango                  ClientType = "django"
	ClientTypeDotnet                  ClientType = "dotnet"
	ClientTypeGo                      ClientType = "go"
	ClientTypeJava                    ClientType = "java"
	ClientTypeKafkaNegativespringBoot ClientType = "kafka-springBoot"
	ClientTypeNodejs                  ClientType = "nodejs"
	ClientTypeNone                    ClientType = "none"
	ClientTypePhp                     ClientType = "php"
	ClientTypePython                  ClientType = "python"
	ClientTypeRuby                    ClientType = "ruby"
	ClientTypeSpringBoot              ClientType = "springBoot"
)

func (*ClientType) UnmarshalJSON 

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

type ConfluentBootstrapServer 

type ConfluentBootstrapServer struct {
	Endpoint *string `json:"endpoint,omitempty"`
}

func (ConfluentBootstrapServer) MarshalJSON 

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

type ConfluentSchemaRegistry 

type ConfluentSchemaRegistry struct {
	Endpoint *string `json:"endpoint,omitempty"`
}

func (ConfluentSchemaRegistry) MarshalJSON 

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

type KeyVaultSecretReferenceSecretInfo 

type KeyVaultSecretReferenceSecretInfo struct {
	Name    *string `json:"name,omitempty"`
	Version *string `json:"version,omitempty"`
}

func (KeyVaultSecretReferenceSecretInfo) MarshalJSON 

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

type KeyVaultSecretUriSecretInfo 

type KeyVaultSecretUriSecretInfo struct {
	Value *string `json:"value,omitempty"`
}

func (KeyVaultSecretUriSecretInfo) MarshalJSON 

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

type LinkerCreateOrUpdateOperationResponse 

type LinkerCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LinkerResource
}

type LinkerGetOperationResponse 

type LinkerGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LinkerResource
}

type LinkerListCompleteResult 

type LinkerListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []LinkerResource
}

type LinkerListCustomPager added in v0.20240628.1153531 

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

type LinkerListOperationResponse 

type LinkerListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]LinkerResource
}

type LinkerProperties 

type LinkerProperties struct {
	AuthInfo          AuthInfoBase      `json:"authInfo"`
	ClientType        *ClientType       `json:"clientType,omitempty"`
	ProvisioningState *string           `json:"provisioningState,omitempty"`
	Scope             *string           `json:"scope,omitempty"`
	SecretStore       *SecretStore      `json:"secretStore,omitempty"`
	TargetService     TargetServiceBase `json:"targetService"`
	VNetSolution      *VNetSolution     `json:"vNetSolution,omitempty"`
}

func (*LinkerProperties) UnmarshalJSON 

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

type LinkerResource 

type LinkerResource struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties LinkerProperties       `json:"properties"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type LinkerResourceOperationPredicate 

type LinkerResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (LinkerResourceOperationPredicate) Matches 

func (p LinkerResourceOperationPredicate) Matches(input LinkerResource) bool

type RawAuthInfoBaseImpl 

type RawAuthInfoBaseImpl struct {
	Type   string
	Values map[string]interface{}
}

RawAuthInfoBaseImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawAzureResourcePropertiesBaseImpl 

type RawAzureResourcePropertiesBaseImpl struct {
	Type   string
	Values map[string]interface{}
}

RawAzureResourcePropertiesBaseImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawSecretInfoBaseImpl 

type RawSecretInfoBaseImpl struct {
	Type   string
	Values map[string]interface{}
}

RawSecretInfoBaseImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RawTargetServiceBaseImpl 

type RawTargetServiceBaseImpl struct {
	Type   string
	Values map[string]interface{}
}

RawTargetServiceBaseImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type ScopedLinkerId 

type ScopedLinkerId struct {
	ResourceUri string
	LinkerName  string
}

ScopedLinkerId is a struct representing the Resource ID for a Scoped Linker

func NewScopedLinkerID 

func NewScopedLinkerID(resourceUri string, linkerName string) ScopedLinkerId

NewScopedLinkerID returns a new ScopedLinkerId struct

func ParseScopedLinkerID 

func ParseScopedLinkerID(input string) (*ScopedLinkerId, error)

ParseScopedLinkerID parses 'input' into a ScopedLinkerId

func ParseScopedLinkerIDInsensitively 

func ParseScopedLinkerIDInsensitively(input string) (*ScopedLinkerId, error)

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

func (*ScopedLinkerId) FromParseResult 

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

func (ScopedLinkerId) ID 

func (id ScopedLinkerId) ID() string

ID returns the formatted Scoped Linker ID

func (ScopedLinkerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Scoped Linker ID

func (ScopedLinkerId) String 

func (id ScopedLinkerId) String() string

String returns a human-readable description of this Scoped Linker ID

type SecretAuthInfo 

type SecretAuthInfo struct {
	Name       *string        `json:"name,omitempty"`
	SecretInfo SecretInfoBase `json:"secretInfo"`
}

func (SecretAuthInfo) MarshalJSON 

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

func (*SecretAuthInfo) UnmarshalJSON 

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

type SecretInfoBase 

type SecretInfoBase interface {
}

type SecretStore 

type SecretStore struct {
	KeyVaultId *string `json:"keyVaultId,omitempty"`
}

type SecretType 

type SecretType string
const (
	SecretTypeKeyVaultSecretReference SecretType = "keyVaultSecretReference"
	SecretTypeKeyVaultSecretUri       SecretType = "keyVaultSecretUri"
	SecretTypeRawValue                SecretType = "rawValue"
)

func (*SecretType) UnmarshalJSON 

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

type ServiceLinkerClient 

type ServiceLinkerClient struct {
	Client *resourcemanager.Client
}

func NewServiceLinkerClientWithBaseURI 

func NewServiceLinkerClientWithBaseURI(sdkApi sdkEnv.Api) (*ServiceLinkerClient, error)

func (ServiceLinkerClient) LinkerCreateOrUpdate 

func (c ServiceLinkerClient) LinkerCreateOrUpdate(ctx context.Context, id ScopedLinkerId, input LinkerResource) (result LinkerCreateOrUpdateOperationResponse, err error)

LinkerCreateOrUpdate ...

func (ServiceLinkerClient) LinkerCreateOrUpdateThenPoll 

func (c ServiceLinkerClient) LinkerCreateOrUpdateThenPoll(ctx context.Context, id ScopedLinkerId, input LinkerResource) error

LinkerCreateOrUpdateThenPoll performs LinkerCreateOrUpdate then polls until it's completed

func (ServiceLinkerClient) LinkerGet 

func (c ServiceLinkerClient) LinkerGet(ctx context.Context, id ScopedLinkerId) (result LinkerGetOperationResponse, err error)

LinkerGet ...

func (ServiceLinkerClient) LinkerList 

func (c ServiceLinkerClient) LinkerList(ctx context.Context, id commonids.ScopeId) (result LinkerListOperationResponse, err error)

LinkerList ...

func (ServiceLinkerClient) LinkerListComplete 

func (c ServiceLinkerClient) LinkerListComplete(ctx context.Context, id commonids.ScopeId) (LinkerListCompleteResult, error)

LinkerListComplete retrieves all the results into a single object

func (ServiceLinkerClient) LinkerListCompleteMatchingPredicate 

func (c ServiceLinkerClient) LinkerListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, predicate LinkerResourceOperationPredicate) (result LinkerListCompleteResult, err error)

LinkerListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ServicePrincipalCertificateAuthInfo 

type ServicePrincipalCertificateAuthInfo struct {
	Certificate string `json:"certificate"`
	ClientId    string `json:"clientId"`
	PrincipalId string `json:"principalId"`
}

func (ServicePrincipalCertificateAuthInfo) MarshalJSON 

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

type ServicePrincipalSecretAuthInfo 

type ServicePrincipalSecretAuthInfo struct {
	ClientId    string `json:"clientId"`
	PrincipalId string `json:"principalId"`
	Secret      string `json:"secret"`
}

func (ServicePrincipalSecretAuthInfo) MarshalJSON 

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

type SystemAssignedIdentityAuthInfo 

type SystemAssignedIdentityAuthInfo struct {
}

func (SystemAssignedIdentityAuthInfo) MarshalJSON 

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

type TargetServiceBase 

type TargetServiceBase interface {
}

type TargetServiceType 

type TargetServiceType string
const (
	TargetServiceTypeAzureResource            TargetServiceType = "AzureResource"
	TargetServiceTypeConfluentBootstrapServer TargetServiceType = "ConfluentBootstrapServer"
	TargetServiceTypeConfluentSchemaRegistry  TargetServiceType = "ConfluentSchemaRegistry"
)

func (*TargetServiceType) UnmarshalJSON 

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

type UserAssignedIdentityAuthInfo 

type UserAssignedIdentityAuthInfo struct {
	ClientId       *string `json:"clientId,omitempty"`
	SubscriptionId *string `json:"subscriptionId,omitempty"`
}

func (UserAssignedIdentityAuthInfo) MarshalJSON 

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

type VNetSolution 

type VNetSolution struct {
	Type *VNetSolutionType `json:"type,omitempty"`
}

type VNetSolutionType 

type VNetSolutionType string
const (
	VNetSolutionTypePrivateLink     VNetSolutionType = "privateLink"
	VNetSolutionTypeServiceEndpoint VNetSolutionType = "serviceEndpoint"
)

func (*VNetSolutionType) UnmarshalJSON 

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

type ValueSecretInfo 

type ValueSecretInfo struct {
	Value *string `json:"value,omitempty"`
}

func (ValueSecretInfo) MarshalJSON 

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

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.