datareference

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2024-04-01/datareference Documentation

The datareference SDK allows for interaction with Azure Resource Manager machinelearningservices (API Version 2024-04-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/machinelearningservices/2024-04-01/datareference"

Client Initialization

client := datareference.NewDataReferenceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataReferenceClient.RegistryDataReferencesGetBlobReferenceSAS

ctx := context.TODO()
id := datareference.NewDataReferenceVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryName", "dataReferenceName", "versionName")

payload := datareference.GetBlobReferenceSASRequestDto{
	// ...
}


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

Documentation

Index

• func PossibleValuesForDataReferenceCredentialType() []string
• func ValidateDataReferenceVersionID(input interface{}, key string) (warnings []string, errors []error)
• type AnonymousAccessCredential
  • func (s AnonymousAccessCredential) DataReferenceCredential() BaseDataReferenceCredentialImpl
  • func (s AnonymousAccessCredential) MarshalJSON() ([]byte, error)
• type BaseDataReferenceCredentialImpl
  • func (s BaseDataReferenceCredentialImpl) DataReferenceCredential() BaseDataReferenceCredentialImpl
• type DataReferenceClient
  • func NewDataReferenceClientWithBaseURI(sdkApi sdkEnv.Api) (*DataReferenceClient, error)
  • func (c DataReferenceClient) RegistryDataReferencesGetBlobReferenceSAS(ctx context.Context, id DataReferenceVersionId, ...) (result RegistryDataReferencesGetBlobReferenceSASOperationResponse, err error)
• type DataReferenceCredential
  • func UnmarshalDataReferenceCredentialImplementation(input []byte) (DataReferenceCredential, error)
• type DataReferenceCredentialType
  • func (s *DataReferenceCredentialType) UnmarshalJSON(bytes []byte) error
• type DataReferenceVersionId
  • func NewDataReferenceVersionID(subscriptionId string, resourceGroupName string, registryName string, ...) DataReferenceVersionId
  • func ParseDataReferenceVersionID(input string) (*DataReferenceVersionId, error)
  • func ParseDataReferenceVersionIDInsensitively(input string) (*DataReferenceVersionId, error)
  • func (id *DataReferenceVersionId) FromParseResult(input resourceids.ParseResult) error
  • func (id DataReferenceVersionId) ID() string
  • func (id DataReferenceVersionId) Segments() []resourceids.Segment
  • func (id DataReferenceVersionId) String() string
• type DockerCredential
  • func (s DockerCredential) DataReferenceCredential() BaseDataReferenceCredentialImpl
  • func (s DockerCredential) MarshalJSON() ([]byte, error)
• type GetBlobReferenceForConsumptionDto
  • func (s *GetBlobReferenceForConsumptionDto) UnmarshalJSON(bytes []byte) error
• type GetBlobReferenceSASRequestDto
• type GetBlobReferenceSASResponseDto
• type ManagedIdentityCredential
  • func (s ManagedIdentityCredential) DataReferenceCredential() BaseDataReferenceCredentialImpl
  • func (s ManagedIdentityCredential) MarshalJSON() ([]byte, error)
• type RawDataReferenceCredentialImpl
  • func (s RawDataReferenceCredentialImpl) DataReferenceCredential() BaseDataReferenceCredentialImpl
• type RegistryDataReferencesGetBlobReferenceSASOperationResponse
• type SASCredential
  • func (s SASCredential) DataReferenceCredential() BaseDataReferenceCredentialImpl
  • func (s SASCredential) MarshalJSON() ([]byte, error)

Functions

func PossibleValuesForDataReferenceCredentialType

func PossibleValuesForDataReferenceCredentialType() []string

func ValidateDataReferenceVersionID

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

ValidateDataReferenceVersionID checks that 'input' can be parsed as a Data Reference Version ID

Types

type AnonymousAccessCredential

type AnonymousAccessCredential struct {
	CredentialType DataReferenceCredentialType `json:"credentialType"`
}

func (AnonymousAccessCredential) DataReferenceCredential

func (s AnonymousAccessCredential) DataReferenceCredential() BaseDataReferenceCredentialImpl

func (AnonymousAccessCredential) MarshalJSON

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

type BaseDataReferenceCredentialImpl

type BaseDataReferenceCredentialImpl struct {
	CredentialType DataReferenceCredentialType `json:"credentialType"`
}

func (BaseDataReferenceCredentialImpl) DataReferenceCredential

func (s BaseDataReferenceCredentialImpl) DataReferenceCredential() BaseDataReferenceCredentialImpl

type DataReferenceClient

type DataReferenceClient struct {
	Client *resourcemanager.Client
}

func NewDataReferenceClientWithBaseURI

func NewDataReferenceClientWithBaseURI(sdkApi sdkEnv.Api) (*DataReferenceClient, error)

func (DataReferenceClient) RegistryDataReferencesGetBlobReferenceSAS

func (c DataReferenceClient) RegistryDataReferencesGetBlobReferenceSAS(ctx context.Context, id DataReferenceVersionId, input GetBlobReferenceSASRequestDto) (result RegistryDataReferencesGetBlobReferenceSASOperationResponse, err error)

RegistryDataReferencesGetBlobReferenceSAS ...

type DataReferenceCredential

type DataReferenceCredential interface {
	DataReferenceCredential() BaseDataReferenceCredentialImpl
}

func UnmarshalDataReferenceCredentialImplementation

func UnmarshalDataReferenceCredentialImplementation(input []byte) (DataReferenceCredential, error)

type DataReferenceCredentialType

type DataReferenceCredentialType string

const (
	DataReferenceCredentialTypeDockerCredentials DataReferenceCredentialType = "DockerCredentials"
	DataReferenceCredentialTypeManagedIdentity   DataReferenceCredentialType = "ManagedIdentity"
	DataReferenceCredentialTypeNoCredentials     DataReferenceCredentialType = "NoCredentials"
	DataReferenceCredentialTypeSAS               DataReferenceCredentialType = "SAS"
)

func (*DataReferenceCredentialType) UnmarshalJSON

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

type DataReferenceVersionId

type DataReferenceVersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
	DataReferenceName string
	VersionName       string
}

DataReferenceVersionId is a struct representing the Resource ID for a Data Reference Version

func NewDataReferenceVersionID

func NewDataReferenceVersionID(subscriptionId string, resourceGroupName string, registryName string, dataReferenceName string, versionName string) DataReferenceVersionId

NewDataReferenceVersionID returns a new DataReferenceVersionId struct

func ParseDataReferenceVersionID

func ParseDataReferenceVersionID(input string) (*DataReferenceVersionId, error)

ParseDataReferenceVersionID parses 'input' into a DataReferenceVersionId

func ParseDataReferenceVersionIDInsensitively

func ParseDataReferenceVersionIDInsensitively(input string) (*DataReferenceVersionId, error)

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

func (*DataReferenceVersionId) FromParseResult

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

func (DataReferenceVersionId) ID

func (id DataReferenceVersionId) ID() string

ID returns the formatted Data Reference Version ID

func (DataReferenceVersionId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Data Reference Version ID

func (DataReferenceVersionId) String

func (id DataReferenceVersionId) String() string

String returns a human-readable description of this Data Reference Version ID

type DockerCredential

type DockerCredential struct {
	Password *string `json:"password,omitempty"`
	UserName *string `json:"userName,omitempty"`

	CredentialType DataReferenceCredentialType `json:"credentialType"`
}

func (DockerCredential) DataReferenceCredential

func (s DockerCredential) DataReferenceCredential() BaseDataReferenceCredentialImpl

func (DockerCredential) MarshalJSON

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

type GetBlobReferenceForConsumptionDto

type GetBlobReferenceForConsumptionDto struct {
	BlobUri             *string                 `json:"blobUri,omitempty"`
	Credential          DataReferenceCredential `json:"credential"`
	StorageAccountArmId *string                 `json:"storageAccountArmId,omitempty"`
}

func (*GetBlobReferenceForConsumptionDto) UnmarshalJSON

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

type GetBlobReferenceSASRequestDto

type GetBlobReferenceSASRequestDto struct {
	AssetId *string `json:"assetId,omitempty"`
	BlobUri *string `json:"blobUri,omitempty"`
}

type GetBlobReferenceSASResponseDto

type GetBlobReferenceSASResponseDto struct {
	BlobReferenceForConsumption *GetBlobReferenceForConsumptionDto `json:"blobReferenceForConsumption,omitempty"`
}

type ManagedIdentityCredential

type ManagedIdentityCredential struct {
	ManagedIdentityType            *string `json:"managedIdentityType,omitempty"`
	UserManagedIdentityClientId    *string `json:"userManagedIdentityClientId,omitempty"`
	UserManagedIdentityPrincipalId *string `json:"userManagedIdentityPrincipalId,omitempty"`
	UserManagedIdentityResourceId  *string `json:"userManagedIdentityResourceId,omitempty"`
	UserManagedIdentityTenantId    *string `json:"userManagedIdentityTenantId,omitempty"`

	CredentialType DataReferenceCredentialType `json:"credentialType"`
}

func (ManagedIdentityCredential) DataReferenceCredential

func (s ManagedIdentityCredential) DataReferenceCredential() BaseDataReferenceCredentialImpl

func (ManagedIdentityCredential) MarshalJSON

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

type RawDataReferenceCredentialImpl

type RawDataReferenceCredentialImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

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

func (RawDataReferenceCredentialImpl) DataReferenceCredential

func (s RawDataReferenceCredentialImpl) DataReferenceCredential() BaseDataReferenceCredentialImpl

type RegistryDataReferencesGetBlobReferenceSASOperationResponse

type RegistryDataReferencesGetBlobReferenceSASOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GetBlobReferenceSASResponseDto
}

type SASCredential

type SASCredential struct {
	SasUri *string `json:"sasUri,omitempty"`

	CredentialType DataReferenceCredentialType `json:"credentialType"`
}

func (SASCredential) DataReferenceCredential

func (s SASCredential) DataReferenceCredential() BaseDataReferenceCredentialImpl

func (SASCredential) MarshalJSON

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