publishedartifact

package
v0.20240306.1111727 Latest Latest
Warning

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

 Go to latest Published: Mar 6, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/blueprints/2018-11-01-preview/publishedartifact Documentation

The publishedartifact SDK allows for interaction with the Azure Resource Manager Service blueprints (API Version 2018-11-01-preview).

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/blueprints/2018-11-01-preview/publishedartifact"

Client Initialization

client := publishedartifact.NewPublishedArtifactClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PublishedArtifactClient.Get

ctx := context.TODO()
id := publishedartifact.NewVersionArtifactScopedID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "blueprintValue", "versionIdValue", "artifactValue")

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

Example Usage: PublishedArtifactClient.List

ctx := context.TODO()
id := publishedartifact.NewScopedVersionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "blueprintValue", "versionIdValue")

// 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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForArtifactKind 

func PossibleValuesForArtifactKind() []string

func ValidateScopedVersionID 

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

ValidateScopedVersionID checks that 'input' can be parsed as a Scoped Version ID

func ValidateVersionArtifactScopedID 

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

ValidateVersionArtifactScopedID checks that 'input' can be parsed as a Version Artifact Scoped ID

Types

type Artifact 

type Artifact interface {
}

type ArtifactKind 

type ArtifactKind string
const (
	ArtifactKindPolicyAssignment ArtifactKind = "policyAssignment"
	ArtifactKindRoleAssignment   ArtifactKind = "roleAssignment"
	ArtifactKindTemplate         ArtifactKind = "template"
)

func (*ArtifactKind) UnmarshalJSON 

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

type ArtifactOperationPredicate 

type ArtifactOperationPredicate struct {
}

func (ArtifactOperationPredicate) Matches 

func (p ArtifactOperationPredicate) Matches(input Artifact) bool

type GetOperationResponse 

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

type KeyVaultReference 

type KeyVaultReference struct {
	Id string `json:"id"`
}

type ListCompleteResult 

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

type ListOperationResponse 

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

type ParameterValue 

type ParameterValue struct {
	Reference *SecretValueReference `json:"reference,omitempty"`
	Value     *interface{}          `json:"value,omitempty"`
}

type PolicyAssignmentArtifact 

type PolicyAssignmentArtifact struct {
	Properties PolicyAssignmentArtifactProperties `json:"properties"`

	// Fields inherited from Artifact
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

func (PolicyAssignmentArtifact) MarshalJSON 

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

type PolicyAssignmentArtifactProperties 

type PolicyAssignmentArtifactProperties struct {
	DependsOn          *[]string                 `json:"dependsOn,omitempty"`
	Description        *string                   `json:"description,omitempty"`
	DisplayName        *string                   `json:"displayName,omitempty"`
	Parameters         map[string]ParameterValue `json:"parameters"`
	PolicyDefinitionId string                    `json:"policyDefinitionId"`
	ResourceGroup      *string                   `json:"resourceGroup,omitempty"`
}

type PublishedArtifactClient 

type PublishedArtifactClient struct {
	Client *resourcemanager.Client
}

func NewPublishedArtifactClientWithBaseURI 

func NewPublishedArtifactClientWithBaseURI(sdkApi sdkEnv.Api) (*PublishedArtifactClient, error)

func (PublishedArtifactClient) Get 

func (c PublishedArtifactClient) Get(ctx context.Context, id VersionArtifactScopedId) (result GetOperationResponse, err error)

Get ...

func (PublishedArtifactClient) List 

func (c PublishedArtifactClient) List(ctx context.Context, id ScopedVersionId) (result ListOperationResponse, err error)

List ...

func (PublishedArtifactClient) ListComplete 

func (c PublishedArtifactClient) ListComplete(ctx context.Context, id ScopedVersionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PublishedArtifactClient) ListCompleteMatchingPredicate 

func (c PublishedArtifactClient) ListCompleteMatchingPredicate(ctx context.Context, id ScopedVersionId, predicate ArtifactOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type RawArtifactImpl 

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

RawArtifactImpl 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 RoleAssignmentArtifact 

type RoleAssignmentArtifact struct {
	Properties RoleAssignmentArtifactProperties `json:"properties"`

	// Fields inherited from Artifact
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

func (RoleAssignmentArtifact) MarshalJSON 

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

type RoleAssignmentArtifactProperties 

type RoleAssignmentArtifactProperties struct {
	DependsOn        *[]string   `json:"dependsOn,omitempty"`
	Description      *string     `json:"description,omitempty"`
	DisplayName      *string     `json:"displayName,omitempty"`
	PrincipalIds     interface{} `json:"principalIds"`
	ResourceGroup    *string     `json:"resourceGroup,omitempty"`
	RoleDefinitionId string      `json:"roleDefinitionId"`
}

type ScopedVersionId 

type ScopedVersionId struct {
	ResourceScope string
	BlueprintName string
	VersionId     string
}

ScopedVersionId is a struct representing the Resource ID for a Scoped Version

func NewScopedVersionID 

func NewScopedVersionID(resourceScope string, blueprintName string, versionId string) ScopedVersionId

NewScopedVersionID returns a new ScopedVersionId struct

func ParseScopedVersionID 

func ParseScopedVersionID(input string) (*ScopedVersionId, error)

ParseScopedVersionID parses 'input' into a ScopedVersionId

func ParseScopedVersionIDInsensitively 

func ParseScopedVersionIDInsensitively(input string) (*ScopedVersionId, error)

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

func (*ScopedVersionId) FromParseResult 

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

func (ScopedVersionId) ID 

func (id ScopedVersionId) ID() string

ID returns the formatted Scoped Version ID

func (ScopedVersionId) Segments 

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

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

func (ScopedVersionId) String 

func (id ScopedVersionId) String() string

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

type SecretValueReference 

type SecretValueReference struct {
	KeyVault      KeyVaultReference `json:"keyVault"`
	SecretName    string            `json:"secretName"`
	SecretVersion *string           `json:"secretVersion,omitempty"`
}

type TemplateArtifact 

type TemplateArtifact struct {
	Properties TemplateArtifactProperties `json:"properties"`

	// Fields inherited from Artifact
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

func (TemplateArtifact) MarshalJSON 

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

type TemplateArtifactProperties 

type TemplateArtifactProperties struct {
	DependsOn     *[]string                 `json:"dependsOn,omitempty"`
	Description   *string                   `json:"description,omitempty"`
	DisplayName   *string                   `json:"displayName,omitempty"`
	Parameters    map[string]ParameterValue `json:"parameters"`
	ResourceGroup *string                   `json:"resourceGroup,omitempty"`
	Template      interface{}               `json:"template"`
}

type VersionArtifactScopedId 

type VersionArtifactScopedId struct {
	ResourceScope string
	BlueprintName string
	VersionId     string
	ArtifactName  string
}

VersionArtifactScopedId is a struct representing the Resource ID for a Version Artifact Scoped

func NewVersionArtifactScopedID 

func NewVersionArtifactScopedID(resourceScope string, blueprintName string, versionId string, artifactName string) VersionArtifactScopedId

NewVersionArtifactScopedID returns a new VersionArtifactScopedId struct

func ParseVersionArtifactScopedID 

func ParseVersionArtifactScopedID(input string) (*VersionArtifactScopedId, error)

ParseVersionArtifactScopedID parses 'input' into a VersionArtifactScopedId

func ParseVersionArtifactScopedIDInsensitively 

func ParseVersionArtifactScopedIDInsensitively(input string) (*VersionArtifactScopedId, error)

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

func (*VersionArtifactScopedId) FromParseResult 

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

func (VersionArtifactScopedId) ID 

func (id VersionArtifactScopedId) ID() string

ID returns the formatted Version Artifact Scoped ID

func (VersionArtifactScopedId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Version Artifact Scoped ID

func (VersionArtifactScopedId) String 

func (id VersionArtifactScopedId) String() string

String returns a human-readable description of this Version Artifact Scoped ID

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.