credentials

package
v0.20241009.1142232 Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/datafactory/2018-06-01/credentials Documentation

The credentials SDK allows for interaction with Azure Resource Manager datafactory (API Version 2018-06-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/datafactory/2018-06-01/credentials"

Client Initialization

client := credentials.NewCredentialsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CredentialsClient.CredentialOperationsCreateOrUpdate

ctx := context.TODO()
id := credentials.NewCredentialID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryName", "credentialName")

payload := credentials.CredentialResource{
	// ...
}


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

Example Usage: CredentialsClient.CredentialOperationsDelete

ctx := context.TODO()
id := credentials.NewCredentialID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryName", "credentialName")

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

Example Usage: CredentialsClient.CredentialOperationsGet

ctx := context.TODO()
id := credentials.NewCredentialID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryName", "credentialName")

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

Example Usage: CredentialsClient.CredentialOperationsListByFactory

ctx := context.TODO()
id := credentials.NewFactoryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryName")

// alternatively `client.CredentialOperationsListByFactory(ctx, id)` can be used to do batched pagination
items, err := client.CredentialOperationsListByFactoryComplete(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 PossibleValuesForType added in v0.20240319.1093754 

func PossibleValuesForType() []string

func ValidateCredentialID 

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

ValidateCredentialID checks that 'input' can be parsed as a Credential ID

func ValidateFactoryID 

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

ValidateFactoryID checks that 'input' can be parsed as a Factory ID

Types

type AzureKeyVaultSecretReference added in v0.20240319.1093754 

type AzureKeyVaultSecretReference struct {
	SecretName    string                 `json:"secretName"`
	SecretVersion *string                `json:"secretVersion,omitempty"`
	Store         LinkedServiceReference `json:"store"`

	Type string `json:"type"`
}

func (AzureKeyVaultSecretReference) MarshalJSON added in v0.20240319.1093754 

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

func (AzureKeyVaultSecretReference) SecretBase added in v0.20240920.1135249 

func (s AzureKeyVaultSecretReference) SecretBase() BaseSecretBaseImpl

type BaseCredentialImpl added in v0.20240920.1135249 

type BaseCredentialImpl struct {
	Annotations *[]interface{} `json:"annotations,omitempty"`
	Description *string        `json:"description,omitempty"`
	Type        string         `json:"type"`
}

func (BaseCredentialImpl) Credential added in v0.20240920.1135249 

func (s BaseCredentialImpl) Credential() BaseCredentialImpl

type BaseSecretBaseImpl added in v0.20240920.1135249 

type BaseSecretBaseImpl struct {
	Type string `json:"type"`
}

func (BaseSecretBaseImpl) SecretBase added in v0.20240920.1135249 

func (s BaseSecretBaseImpl) SecretBase() BaseSecretBaseImpl

type Credential 

type Credential interface {
	Credential() BaseCredentialImpl
}

func UnmarshalCredentialImplementation added in v0.20240920.1135249 

func UnmarshalCredentialImplementation(input []byte) (Credential, error)

type CredentialId 

type CredentialId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
	CredentialName    string
}

CredentialId is a struct representing the Resource ID for a Credential

func NewCredentialID 

func NewCredentialID(subscriptionId string, resourceGroupName string, factoryName string, credentialName string) CredentialId

NewCredentialID returns a new CredentialId struct

func ParseCredentialID 

func ParseCredentialID(input string) (*CredentialId, error)

ParseCredentialID parses 'input' into a CredentialId

func ParseCredentialIDInsensitively 

func ParseCredentialIDInsensitively(input string) (*CredentialId, error)

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

func (*CredentialId) FromParseResult 

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

func (CredentialId) ID 

func (id CredentialId) ID() string

ID returns the formatted Credential ID

func (CredentialId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Credential ID

func (CredentialId) String 

func (id CredentialId) String() string

String returns a human-readable description of this Credential ID

type CredentialOperationsCreateOrUpdateOperationOptions 

type CredentialOperationsCreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCredentialOperationsCreateOrUpdateOperationOptions 

func DefaultCredentialOperationsCreateOrUpdateOperationOptions() CredentialOperationsCreateOrUpdateOperationOptions

func (CredentialOperationsCreateOrUpdateOperationOptions) ToHeaders 

func (o CredentialOperationsCreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (CredentialOperationsCreateOrUpdateOperationOptions) ToOData 

func (o CredentialOperationsCreateOrUpdateOperationOptions) ToOData() *odata.Query

func (CredentialOperationsCreateOrUpdateOperationOptions) ToQuery 

func (o CredentialOperationsCreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type CredentialOperationsCreateOrUpdateOperationResponse 

type CredentialOperationsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CredentialResource
}

type CredentialOperationsDeleteOperationResponse 

type CredentialOperationsDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CredentialOperationsGetOperationOptions 

type CredentialOperationsGetOperationOptions struct {
	IfNoneMatch *string
}

func DefaultCredentialOperationsGetOperationOptions 

func DefaultCredentialOperationsGetOperationOptions() CredentialOperationsGetOperationOptions

func (CredentialOperationsGetOperationOptions) ToHeaders 

func (o CredentialOperationsGetOperationOptions) ToHeaders() *client.Headers

func (CredentialOperationsGetOperationOptions) ToOData 

func (o CredentialOperationsGetOperationOptions) ToOData() *odata.Query

func (CredentialOperationsGetOperationOptions) ToQuery 

func (o CredentialOperationsGetOperationOptions) ToQuery() *client.QueryParams

type CredentialOperationsGetOperationResponse 

type CredentialOperationsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CredentialResource
}

type CredentialOperationsListByFactoryCompleteResult 

type CredentialOperationsListByFactoryCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CredentialResource
}

type CredentialOperationsListByFactoryCustomPager added in v0.20240628.1153531 

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

type CredentialOperationsListByFactoryOperationResponse 

type CredentialOperationsListByFactoryOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]CredentialResource
}

type CredentialResource added in v0.20240319.1093754 

type CredentialResource struct {
	Etag       *string    `json:"etag,omitempty"`
	Id         *string    `json:"id,omitempty"`
	Name       *string    `json:"name,omitempty"`
	Properties Credential `json:"properties"`
	Type       *string    `json:"type,omitempty"`
}

func (*CredentialResource) UnmarshalJSON added in v0.20240319.1093754 

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

type CredentialResourceOperationPredicate added in v0.20240319.1093754 

type CredentialResourceOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (CredentialResourceOperationPredicate) Matches added in v0.20240319.1093754 

func (p CredentialResourceOperationPredicate) Matches(input CredentialResource) bool

type CredentialsClient 

type CredentialsClient struct {
	Client *resourcemanager.Client
}

func NewCredentialsClientWithBaseURI 

func NewCredentialsClientWithBaseURI(sdkApi sdkEnv.Api) (*CredentialsClient, error)

func (CredentialsClient) CredentialOperationsCreateOrUpdate 

func (c CredentialsClient) CredentialOperationsCreateOrUpdate(ctx context.Context, id CredentialId, input CredentialResource, options CredentialOperationsCreateOrUpdateOperationOptions) (result CredentialOperationsCreateOrUpdateOperationResponse, err error)

CredentialOperationsCreateOrUpdate ...

func (CredentialsClient) CredentialOperationsDelete 

func (c CredentialsClient) CredentialOperationsDelete(ctx context.Context, id CredentialId) (result CredentialOperationsDeleteOperationResponse, err error)

CredentialOperationsDelete ...

func (CredentialsClient) CredentialOperationsGet 

func (c CredentialsClient) CredentialOperationsGet(ctx context.Context, id CredentialId, options CredentialOperationsGetOperationOptions) (result CredentialOperationsGetOperationResponse, err error)

CredentialOperationsGet ...

func (CredentialsClient) CredentialOperationsListByFactory 

func (c CredentialsClient) CredentialOperationsListByFactory(ctx context.Context, id FactoryId) (result CredentialOperationsListByFactoryOperationResponse, err error)

CredentialOperationsListByFactory ...

func (CredentialsClient) CredentialOperationsListByFactoryComplete 

func (c CredentialsClient) CredentialOperationsListByFactoryComplete(ctx context.Context, id FactoryId) (CredentialOperationsListByFactoryCompleteResult, error)

CredentialOperationsListByFactoryComplete retrieves all the results into a single object

func (CredentialsClient) CredentialOperationsListByFactoryCompleteMatchingPredicate 

func (c CredentialsClient) CredentialOperationsListByFactoryCompleteMatchingPredicate(ctx context.Context, id FactoryId, predicate CredentialResourceOperationPredicate) (result CredentialOperationsListByFactoryCompleteResult, err error)

CredentialOperationsListByFactoryCompleteMatchingPredicate retrieves all the results and then applies the predicate

type FactoryId 

type FactoryId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
}

FactoryId is a struct representing the Resource ID for a Factory

func NewFactoryID 

func NewFactoryID(subscriptionId string, resourceGroupName string, factoryName string) FactoryId

NewFactoryID returns a new FactoryId struct

func ParseFactoryID 

func ParseFactoryID(input string) (*FactoryId, error)

ParseFactoryID parses 'input' into a FactoryId

func ParseFactoryIDInsensitively 

func ParseFactoryIDInsensitively(input string) (*FactoryId, error)

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

func (*FactoryId) FromParseResult 

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

func (FactoryId) ID 

func (id FactoryId) ID() string

ID returns the formatted Factory ID

func (FactoryId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Factory ID

func (FactoryId) String 

func (id FactoryId) String() string

String returns a human-readable description of this Factory ID

type LinkedServiceReference added in v0.20240319.1093754 

type LinkedServiceReference struct {
	Parameters    *map[string]interface{} `json:"parameters,omitempty"`
	ReferenceName string                  `json:"referenceName"`
	Type          Type                    `json:"type"`
}

type ManagedIdentityCredential 

type ManagedIdentityCredential struct {
	TypeProperties *ManagedIdentityTypeProperties `json:"typeProperties,omitempty"`

	Annotations *[]interface{} `json:"annotations,omitempty"`
	Description *string        `json:"description,omitempty"`
	Type        string         `json:"type"`
}

func (ManagedIdentityCredential) Credential added in v0.20240920.1135249 

func (s ManagedIdentityCredential) Credential() BaseCredentialImpl

func (ManagedIdentityCredential) MarshalJSON 

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

type ManagedIdentityTypeProperties 

type ManagedIdentityTypeProperties struct {
	ResourceId *string `json:"resourceId,omitempty"`
}

type RawCredentialImpl 

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

RawCredentialImpl 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 (RawCredentialImpl) Credential added in v0.20240920.1135249 

func (s RawCredentialImpl) Credential() BaseCredentialImpl

type RawSecretBaseImpl added in v0.20240319.1093754 

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

RawSecretBaseImpl 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 (RawSecretBaseImpl) SecretBase added in v0.20240920.1135249 

func (s RawSecretBaseImpl) SecretBase() BaseSecretBaseImpl

type SecretBase added in v0.20240319.1093754 

type SecretBase interface {
	SecretBase() BaseSecretBaseImpl
}

func UnmarshalSecretBaseImplementation added in v0.20240920.1135249 

func UnmarshalSecretBaseImplementation(input []byte) (SecretBase, error)

type SecureString added in v0.20240319.1093754 

type SecureString struct {
	Value string `json:"value"`

	Type string `json:"type"`
}

func (SecureString) MarshalJSON added in v0.20240319.1093754 

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

func (SecureString) SecretBase added in v0.20241009.1142232 

func (s SecureString) SecretBase() BaseSecretBaseImpl

type ServicePrincipalCredential added in v0.20240319.1093754 

type ServicePrincipalCredential struct {
	TypeProperties ServicePrincipalCredentialTypeProperties `json:"typeProperties"`

	Annotations *[]interface{} `json:"annotations,omitempty"`
	Description *string        `json:"description,omitempty"`
	Type        string         `json:"type"`
}

func (ServicePrincipalCredential) Credential added in v0.20240920.1135249 

func (s ServicePrincipalCredential) Credential() BaseCredentialImpl

func (ServicePrincipalCredential) MarshalJSON added in v0.20240319.1093754 

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

type ServicePrincipalCredentialTypeProperties added in v0.20240319.1093754 

type ServicePrincipalCredentialTypeProperties struct {
	ServicePrincipalId  *string                       `json:"servicePrincipalId,omitempty"`
	ServicePrincipalKey *AzureKeyVaultSecretReference `json:"servicePrincipalKey,omitempty"`
	Tenant              *string                       `json:"tenant,omitempty"`
}

type Type added in v0.20240319.1093754 

type Type string
const (
	TypeLinkedServiceReference Type = "LinkedServiceReference"
)

func (*Type) UnmarshalJSON added in v0.20240319.1093754 

func (s *Type) UnmarshalJSON(bytes []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.