factories

package
v0.20240223.1145617 Latest Latest
Warning

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

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

README

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

The factories 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/datafactory/2018-06-01/factories"

Client Initialization

client := factories.NewFactoriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FactoriesClient.ConfigureFactoryRepo

ctx := context.TODO()
id := factories.NewLocationID("12345678-1234-9876-4563-123456789012", "locationIdValue")

payload := factories.FactoryRepoUpdate{
	// ...
}


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

Example Usage: FactoriesClient.CreateOrUpdate

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

payload := factories.Factory{
	// ...
}


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

Example Usage: FactoriesClient.Delete

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

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: FactoriesClient.Get

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

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

Example Usage: FactoriesClient.GetDataPlaneAccess

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

payload := factories.UserAccessPolicy{
	// ...
}


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

Example Usage: FactoriesClient.GetGitHubAccessToken

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

payload := factories.GitHubAccessTokenRequest{
	// ...
}


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

Example Usage: FactoriesClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: FactoriesClient.ListByResourceGroup

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

// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: FactoriesClient.Update

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

payload := factories.FactoryUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForGlobalParameterType

func PossibleValuesForGlobalParameterType() []string

func PossibleValuesForPublicNetworkAccess

func PossibleValuesForPublicNetworkAccess() []string

func ValidateFactoryID

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

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

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type AccessPolicyResponse

type AccessPolicyResponse struct {
	AccessToken  *string           `json:"accessToken,omitempty"`
	DataPlaneUrl *string           `json:"dataPlaneUrl,omitempty"`
	Policy       *UserAccessPolicy `json:"policy,omitempty"`
}

type CMKIdentityDefinition

type CMKIdentityDefinition struct {
	UserAssignedIdentity *string `json:"userAssignedIdentity,omitempty"`
}

type ConfigureFactoryRepoOperationResponse

type ConfigureFactoryRepoOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Factory
}

type CreateOrUpdateOperationOptions

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders

func (CreateOrUpdateOperationOptions) ToOData

func (CreateOrUpdateOperationOptions) ToQuery

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Factory
}

type DeleteOperationResponse

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

type EncryptionConfiguration

type EncryptionConfiguration struct {
	Identity     *CMKIdentityDefinition `json:"identity,omitempty"`
	KeyName      string                 `json:"keyName"`
	KeyVersion   *string                `json:"keyVersion,omitempty"`
	VaultBaseUrl string                 `json:"vaultBaseUrl"`
}

type FactoriesClient

type FactoriesClient struct {
	Client *resourcemanager.Client
}

func NewFactoriesClientWithBaseURI

func NewFactoriesClientWithBaseURI(sdkApi sdkEnv.Api) (*FactoriesClient, error)

func (FactoriesClient) ConfigureFactoryRepo

func (c FactoriesClient) ConfigureFactoryRepo(ctx context.Context, id LocationId, input FactoryRepoUpdate) (result ConfigureFactoryRepoOperationResponse, err error)

ConfigureFactoryRepo ...

func (FactoriesClient) CreateOrUpdate

CreateOrUpdate ...

func (FactoriesClient) Delete

func (c FactoriesClient) Delete(ctx context.Context, id FactoryId) (result DeleteOperationResponse, err error)

Delete ...

func (FactoriesClient) Get

Get ...

func (FactoriesClient) GetDataPlaneAccess

func (c FactoriesClient) GetDataPlaneAccess(ctx context.Context, id FactoryId, input UserAccessPolicy) (result GetDataPlaneAccessOperationResponse, err error)

GetDataPlaneAccess ...

func (FactoriesClient) GetGitHubAccessToken

GetGitHubAccessToken ...

func (FactoriesClient) List

List ...

func (FactoriesClient) ListByResourceGroup

ListByResourceGroup ...

func (FactoriesClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (FactoriesClient) ListByResourceGroupCompleteMatchingPredicate

func (c FactoriesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate FactoryOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FactoriesClient) ListComplete

ListComplete retrieves all the results into a single object

func (FactoriesClient) ListCompleteMatchingPredicate

func (c FactoriesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate FactoryOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FactoriesClient) Update

Update ...

type Factory

type Factory struct {
	ETag       *string                                  `json:"eTag,omitempty"`
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                                  `json:"location,omitempty"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *FactoryProperties                       `json:"properties,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type FactoryGitHubConfiguration

type FactoryGitHubConfiguration struct {
	ClientId     *string             `json:"clientId,omitempty"`
	ClientSecret *GitHubClientSecret `json:"clientSecret,omitempty"`
	HostName     *string             `json:"hostName,omitempty"`

	// Fields inherited from FactoryRepoConfiguration
	AccountName         string  `json:"accountName"`
	CollaborationBranch string  `json:"collaborationBranch"`
	DisablePublish      *bool   `json:"disablePublish,omitempty"`
	LastCommitId        *string `json:"lastCommitId,omitempty"`
	RepositoryName      string  `json:"repositoryName"`
	RootFolder          string  `json:"rootFolder"`
}

func (FactoryGitHubConfiguration) MarshalJSON

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

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 FactoryOperationPredicate

type FactoryOperationPredicate struct {
	ETag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (FactoryOperationPredicate) Matches

func (p FactoryOperationPredicate) Matches(input Factory) bool

type FactoryProperties

type FactoryProperties struct {
	CreateTime           *string                                  `json:"createTime,omitempty"`
	Encryption           *EncryptionConfiguration                 `json:"encryption,omitempty"`
	GlobalParameters     *map[string]GlobalParameterSpecification `json:"globalParameters,omitempty"`
	ProvisioningState    *string                                  `json:"provisioningState,omitempty"`
	PublicNetworkAccess  *PublicNetworkAccess                     `json:"publicNetworkAccess,omitempty"`
	PurviewConfiguration *PurviewConfiguration                    `json:"purviewConfiguration,omitempty"`
	RepoConfiguration    FactoryRepoConfiguration                 `json:"repoConfiguration"`
	Version              *string                                  `json:"version,omitempty"`
}

func (*FactoryProperties) GetCreateTimeAsTime

func (o *FactoryProperties) GetCreateTimeAsTime() (*time.Time, error)

func (*FactoryProperties) SetCreateTimeAsTime

func (o *FactoryProperties) SetCreateTimeAsTime(input time.Time)

func (*FactoryProperties) UnmarshalJSON

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

type FactoryRepoConfiguration

type FactoryRepoConfiguration interface {
}

type FactoryRepoUpdate

type FactoryRepoUpdate struct {
	FactoryResourceId *string                  `json:"factoryResourceId,omitempty"`
	RepoConfiguration FactoryRepoConfiguration `json:"repoConfiguration"`
}

func (*FactoryRepoUpdate) UnmarshalJSON

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

type FactoryUpdateParameters

type FactoryUpdateParameters struct {
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *FactoryUpdateProperties                 `json:"properties,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
}

type FactoryUpdateProperties

type FactoryUpdateProperties struct {
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
}

type FactoryVSTSConfiguration

type FactoryVSTSConfiguration struct {
	ProjectName string  `json:"projectName"`
	TenantId    *string `json:"tenantId,omitempty"`

	// Fields inherited from FactoryRepoConfiguration
	AccountName         string  `json:"accountName"`
	CollaborationBranch string  `json:"collaborationBranch"`
	DisablePublish      *bool   `json:"disablePublish,omitempty"`
	LastCommitId        *string `json:"lastCommitId,omitempty"`
	RepositoryName      string  `json:"repositoryName"`
	RootFolder          string  `json:"rootFolder"`
}

func (FactoryVSTSConfiguration) MarshalJSON

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

type GetDataPlaneAccessOperationResponse

type GetDataPlaneAccessOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccessPolicyResponse
}

type GetGitHubAccessTokenOperationResponse

type GetGitHubAccessTokenOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GitHubAccessTokenResponse
}

type GetOperationOptions

type GetOperationOptions struct {
	IfNoneMatch *string
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders

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

func (GetOperationOptions) ToOData

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

func (GetOperationOptions) ToQuery

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

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Factory
}

type GitHubAccessTokenRequest

type GitHubAccessTokenRequest struct {
	GitHubAccessCode         string              `json:"gitHubAccessCode"`
	GitHubAccessTokenBaseUrl string              `json:"gitHubAccessTokenBaseUrl"`
	GitHubClientId           *string             `json:"gitHubClientId,omitempty"`
	GitHubClientSecret       *GitHubClientSecret `json:"gitHubClientSecret,omitempty"`
}

type GitHubAccessTokenResponse

type GitHubAccessTokenResponse struct {
	GitHubAccessToken *string `json:"gitHubAccessToken,omitempty"`
}

type GitHubClientSecret

type GitHubClientSecret struct {
	ByoaSecretAkvUrl *string `json:"byoaSecretAkvUrl,omitempty"`
	ByoaSecretName   *string `json:"byoaSecretName,omitempty"`
}

type GlobalParameterSpecification

type GlobalParameterSpecification struct {
	Type  GlobalParameterType `json:"type"`
	Value interface{}         `json:"value"`
}

type GlobalParameterType

type GlobalParameterType string
const (
	GlobalParameterTypeArray  GlobalParameterType = "Array"
	GlobalParameterTypeBool   GlobalParameterType = "Bool"
	GlobalParameterTypeFloat  GlobalParameterType = "Float"
	GlobalParameterTypeInt    GlobalParameterType = "Int"
	GlobalParameterTypeObject GlobalParameterType = "Object"
	GlobalParameterTypeString GlobalParameterType = "String"
)

func (*GlobalParameterType) UnmarshalJSON

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

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Factory
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Factory
}

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Factory
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Factory
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationId     string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationId string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type PublicNetworkAccess

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON

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

type PurviewConfiguration

type PurviewConfiguration struct {
	PurviewResourceId *string `json:"purviewResourceId,omitempty"`
}

type RawFactoryRepoConfigurationImpl

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

RawFactoryRepoConfigurationImpl 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 UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Factory
}

type UserAccessPolicy

type UserAccessPolicy struct {
	AccessResourcePath *string `json:"accessResourcePath,omitempty"`
	ExpireTime         *string `json:"expireTime,omitempty"`
	Permissions        *string `json:"permissions,omitempty"`
	ProfileName        *string `json:"profileName,omitempty"`
	StartTime          *string `json:"startTime,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL