README
¶
github.com/hashicorp/go-azure-sdk/resource-manager/datafactory/2018-06-01/linkedservices
Documentation
The linkedservices
SDK allows for interaction with the Azure Resource Manager Service 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/linkedservices"
Client Initialization
client := linkedservices.NewLinkedServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: LinkedServicesClient.CreateOrUpdate
ctx := context.TODO()
id := linkedservices.NewLinkedServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue", "linkedServiceValue")
payload := linkedservices.LinkedServiceResource{
// ...
}
read, err := client.CreateOrUpdate(ctx, id, payload, linkedservices.DefaultCreateOrUpdateOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: LinkedServicesClient.Delete
ctx := context.TODO()
id := linkedservices.NewLinkedServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue", "linkedServiceValue")
read, err := client.Delete(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: LinkedServicesClient.Get
ctx := context.TODO()
id := linkedservices.NewLinkedServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue", "linkedServiceValue")
read, err := client.Get(ctx, id, linkedservices.DefaultGetOperationOptions())
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: LinkedServicesClient.ListByFactory
ctx := context.TODO()
id := linkedservices.NewFactoryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue")
// alternatively `client.ListByFactory(ctx, id)` can be used to do batched pagination
items, err := client.ListByFactoryComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation
¶
Index ¶
- func PossibleValuesForParameterType() []string
- func PossibleValuesForType() []string
- func ValidateFactoryID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateLinkedServiceID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOrUpdateOperationOptions
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type FactoryId
- type GetOperationOptions
- type GetOperationResponse
- type IntegrationRuntimeReference
- type LinkedService
- type LinkedServiceId
- type LinkedServiceResource
- type LinkedServiceResourceOperationPredicate
- type LinkedServicesClient
- func (c LinkedServicesClient) CreateOrUpdate(ctx context.Context, id LinkedServiceId, input LinkedServiceResource, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c LinkedServicesClient) Delete(ctx context.Context, id LinkedServiceId) (result DeleteOperationResponse, err error)
- func (c LinkedServicesClient) Get(ctx context.Context, id LinkedServiceId, options GetOperationOptions) (result GetOperationResponse, err error)
- func (c LinkedServicesClient) ListByFactory(ctx context.Context, id FactoryId) (result ListByFactoryOperationResponse, err error)
- func (c LinkedServicesClient) ListByFactoryComplete(ctx context.Context, id FactoryId) (ListByFactoryCompleteResult, error)
- func (c LinkedServicesClient) ListByFactoryCompleteMatchingPredicate(ctx context.Context, id FactoryId, ...) (result ListByFactoryCompleteResult, err error)
- type ListByFactoryCompleteResult
- type ListByFactoryOperationResponse
- type ParameterSpecification
- type ParameterType
- type Type
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForParameterType ¶
func PossibleValuesForParameterType() []string
func PossibleValuesForType ¶
func PossibleValuesForType() []string
func ValidateFactoryID ¶
ValidateFactoryID checks that 'input' can be parsed as a Factory ID
func ValidateLinkedServiceID ¶
ValidateLinkedServiceID checks that 'input' can be parsed as a Linked Service ID
Types ¶
type CreateOrUpdateOperationOptions ¶
type CreateOrUpdateOperationOptions struct {
IfMatch *string
}
func DefaultCreateOrUpdateOperationOptions ¶
func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions
func (CreateOrUpdateOperationOptions) ToHeaders ¶ added in v0.20230516.1215417
func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers
func (CreateOrUpdateOperationOptions) ToOData ¶ added in v0.20230516.1215417
func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query
func (CreateOrUpdateOperationOptions) ToQuery ¶ added in v0.20230516.1215417
func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *LinkedServiceResource }
type DeleteOperationResponse ¶
type FactoryId ¶
FactoryId is a struct representing the Resource ID for a Factory
func NewFactoryID ¶
NewFactoryID returns a new FactoryId struct
func ParseFactoryID ¶
ParseFactoryID parses 'input' into a FactoryId
func ParseFactoryIDInsensitively ¶
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) Segments ¶
func (id FactoryId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Factory ID
type GetOperationOptions ¶
type GetOperationOptions struct {
IfNoneMatch *string
}
func DefaultGetOperationOptions ¶
func DefaultGetOperationOptions() GetOperationOptions
func (GetOperationOptions) ToHeaders ¶ added in v0.20230516.1215417
func (o GetOperationOptions) ToHeaders() *client.Headers
func (GetOperationOptions) ToOData ¶ added in v0.20230516.1215417
func (o GetOperationOptions) ToOData() *odata.Query
func (GetOperationOptions) ToQuery ¶ added in v0.20230516.1215417
func (o GetOperationOptions) ToQuery() *client.QueryParams
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *LinkedServiceResource }
type LinkedService ¶
type LinkedService struct { Annotations *[]interface{} `json:"annotations,omitempty"` ConnectVia *IntegrationRuntimeReference `json:"connectVia,omitempty"` Description *string `json:"description,omitempty"` Parameters *map[string]ParameterSpecification `json:"parameters,omitempty"` Type string `json:"type"` }
type LinkedServiceId ¶
type LinkedServiceId struct { SubscriptionId string ResourceGroupName string FactoryName string LinkedServiceName string }
LinkedServiceId is a struct representing the Resource ID for a Linked Service
func NewLinkedServiceID ¶
func NewLinkedServiceID(subscriptionId string, resourceGroupName string, factoryName string, linkedServiceName string) LinkedServiceId
NewLinkedServiceID returns a new LinkedServiceId struct
func ParseLinkedServiceID ¶
func ParseLinkedServiceID(input string) (*LinkedServiceId, error)
ParseLinkedServiceID parses 'input' into a LinkedServiceId
func ParseLinkedServiceIDInsensitively ¶
func ParseLinkedServiceIDInsensitively(input string) (*LinkedServiceId, error)
ParseLinkedServiceIDInsensitively parses 'input' case-insensitively into a LinkedServiceId note: this method should only be used for API response data and not user input
func (LinkedServiceId) ID ¶
func (id LinkedServiceId) ID() string
ID returns the formatted Linked Service ID
func (LinkedServiceId) Segments ¶
func (id LinkedServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Linked Service ID
func (LinkedServiceId) String ¶
func (id LinkedServiceId) String() string
String returns a human-readable description of this Linked Service ID
type LinkedServiceResource ¶
type LinkedServiceResource struct { Etag *string `json:"etag,omitempty"` Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties LinkedService `json:"properties"` Type *string `json:"type,omitempty"` }
type LinkedServiceResourceOperationPredicate ¶
type LinkedServiceResourceOperationPredicate struct { Etag *string Id *string Name *string Type *string }
func (LinkedServiceResourceOperationPredicate) Matches ¶
func (p LinkedServiceResourceOperationPredicate) Matches(input LinkedServiceResource) bool
type LinkedServicesClient ¶
type LinkedServicesClient struct {
Client *resourcemanager.Client
}
func NewLinkedServicesClientWithBaseURI ¶
func NewLinkedServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*LinkedServicesClient, error)
func (LinkedServicesClient) CreateOrUpdate ¶
func (c LinkedServicesClient) CreateOrUpdate(ctx context.Context, id LinkedServiceId, input LinkedServiceResource, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (LinkedServicesClient) Delete ¶
func (c LinkedServicesClient) Delete(ctx context.Context, id LinkedServiceId) (result DeleteOperationResponse, err error)
Delete ...
func (LinkedServicesClient) Get ¶
func (c LinkedServicesClient) Get(ctx context.Context, id LinkedServiceId, options GetOperationOptions) (result GetOperationResponse, err error)
Get ...
func (LinkedServicesClient) ListByFactory ¶
func (c LinkedServicesClient) ListByFactory(ctx context.Context, id FactoryId) (result ListByFactoryOperationResponse, err error)
ListByFactory ...
func (LinkedServicesClient) ListByFactoryComplete ¶
func (c LinkedServicesClient) ListByFactoryComplete(ctx context.Context, id FactoryId) (ListByFactoryCompleteResult, error)
ListByFactoryComplete retrieves all the results into a single object
func (LinkedServicesClient) ListByFactoryCompleteMatchingPredicate ¶
func (c LinkedServicesClient) ListByFactoryCompleteMatchingPredicate(ctx context.Context, id FactoryId, predicate LinkedServiceResourceOperationPredicate) (result ListByFactoryCompleteResult, err error)
ListByFactoryCompleteMatchingPredicate retrieves all the results and then applies the predicate
type ListByFactoryCompleteResult ¶
type ListByFactoryCompleteResult struct {
Items []LinkedServiceResource
}
type ListByFactoryOperationResponse ¶
type ListByFactoryOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]LinkedServiceResource }
type ParameterSpecification ¶
type ParameterSpecification struct { DefaultValue *interface{} `json:"defaultValue,omitempty"` Type ParameterType `json:"type"` }
type ParameterType ¶
type ParameterType string
const ( ParameterTypeArray ParameterType = "Array" ParameterTypeBool ParameterType = "Bool" ParameterTypeFloat ParameterType = "Float" ParameterTypeInt ParameterType = "Int" ParameterTypeObject ParameterType = "Object" ParameterTypeSecureString ParameterType = "SecureString" ParameterTypeString ParameterType = "String" )
func (*ParameterType) UnmarshalJSON ¶ added in v0.20230516.1215417
func (s *ParameterType) UnmarshalJSON(bytes []byte) error