environmentdefinitions

package
v0.20240417.1084633 Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2024-02-01/environmentdefinitions Documentation

The environmentdefinitions SDK allows for interaction with the Azure Resource Manager Service devcenter (API Version 2024-02-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/devcenter/2024-02-01/environmentdefinitions"

Client Initialization

client := environmentdefinitions.NewEnvironmentDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EnvironmentDefinitionsClient.EnvironmentDefinitionsGet

ctx := context.TODO()
id := environmentdefinitions.NewCatalogEnvironmentDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterValue", "catalogValue", "environmentDefinitionValue")

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

Example Usage: EnvironmentDefinitionsClient.EnvironmentDefinitionsGetByProjectCatalog

ctx := context.TODO()
id := environmentdefinitions.NewEnvironmentDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "projectValue", "catalogValue", "environmentDefinitionValue")

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

Example Usage: EnvironmentDefinitionsClient.EnvironmentDefinitionsGetErrorDetails

ctx := context.TODO()
id := environmentdefinitions.NewCatalogEnvironmentDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterValue", "catalogValue", "environmentDefinitionValue")

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

Example Usage: EnvironmentDefinitionsClient.EnvironmentDefinitionsListByCatalog

ctx := context.TODO()
id := environmentdefinitions.NewDevCenterCatalogID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterValue", "catalogValue")

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

Example Usage: EnvironmentDefinitionsClient.EnvironmentDefinitionsListByProjectCatalog

ctx := context.TODO()
id := environmentdefinitions.NewCatalogID("12345678-1234-9876-4563-123456789012", "example-resource-group", "projectValue", "catalogValue")

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

Example Usage: EnvironmentDefinitionsClient.ProjectCatalogEnvironmentDefinitionsGetErrorDetails

ctx := context.TODO()
id := environmentdefinitions.NewEnvironmentDefinitionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "projectValue", "catalogValue", "environmentDefinitionValue")

read, err := client.ProjectCatalogEnvironmentDefinitionsGetErrorDetails(ctx, id)
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 PossibleValuesForCatalogResourceValidationStatus 

func PossibleValuesForCatalogResourceValidationStatus() []string

func PossibleValuesForParameterType 

func PossibleValuesForParameterType() []string

func ValidateCatalogEnvironmentDefinitionID 

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

ValidateCatalogEnvironmentDefinitionID checks that 'input' can be parsed as a Catalog Environment Definition ID

func ValidateCatalogID 

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

ValidateCatalogID checks that 'input' can be parsed as a Catalog ID

func ValidateDevCenterCatalogID 

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

ValidateDevCenterCatalogID checks that 'input' can be parsed as a Dev Center Catalog ID

func ValidateEnvironmentDefinitionID 

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

ValidateEnvironmentDefinitionID checks that 'input' can be parsed as a Environment Definition ID

Types

type CatalogEnvironmentDefinitionId 

type CatalogEnvironmentDefinitionId struct {
	SubscriptionId            string
	ResourceGroupName         string
	DevCenterName             string
	CatalogName               string
	EnvironmentDefinitionName string
}

CatalogEnvironmentDefinitionId is a struct representing the Resource ID for a Catalog Environment Definition

func NewCatalogEnvironmentDefinitionID 

func NewCatalogEnvironmentDefinitionID(subscriptionId string, resourceGroupName string, devCenterName string, catalogName string, environmentDefinitionName string) CatalogEnvironmentDefinitionId

NewCatalogEnvironmentDefinitionID returns a new CatalogEnvironmentDefinitionId struct

func ParseCatalogEnvironmentDefinitionID 

func ParseCatalogEnvironmentDefinitionID(input string) (*CatalogEnvironmentDefinitionId, error)

ParseCatalogEnvironmentDefinitionID parses 'input' into a CatalogEnvironmentDefinitionId

func ParseCatalogEnvironmentDefinitionIDInsensitively 

func ParseCatalogEnvironmentDefinitionIDInsensitively(input string) (*CatalogEnvironmentDefinitionId, error)

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

func (*CatalogEnvironmentDefinitionId) FromParseResult 

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

func (CatalogEnvironmentDefinitionId) ID 

func (id CatalogEnvironmentDefinitionId) ID() string

ID returns the formatted Catalog Environment Definition ID

func (CatalogEnvironmentDefinitionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Catalog Environment Definition ID

func (CatalogEnvironmentDefinitionId) String 

func (id CatalogEnvironmentDefinitionId) String() string

String returns a human-readable description of this Catalog Environment Definition ID

type CatalogErrorDetails 

type CatalogErrorDetails struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type CatalogId 

type CatalogId struct {
	SubscriptionId    string
	ResourceGroupName string
	ProjectName       string
	CatalogName       string
}

CatalogId is a struct representing the Resource ID for a Catalog

func NewCatalogID 

func NewCatalogID(subscriptionId string, resourceGroupName string, projectName string, catalogName string) CatalogId

NewCatalogID returns a new CatalogId struct

func ParseCatalogID 

func ParseCatalogID(input string) (*CatalogId, error)

ParseCatalogID parses 'input' into a CatalogId

func ParseCatalogIDInsensitively 

func ParseCatalogIDInsensitively(input string) (*CatalogId, error)

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

func (*CatalogId) FromParseResult 

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

func (CatalogId) ID 

func (id CatalogId) ID() string

ID returns the formatted Catalog ID

func (CatalogId) Segments 

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

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

func (CatalogId) String 

func (id CatalogId) String() string

String returns a human-readable description of this Catalog ID

type CatalogResourceValidationErrorDetails 

type CatalogResourceValidationErrorDetails struct {
	Errors *[]CatalogErrorDetails `json:"errors,omitempty"`
}

type CatalogResourceValidationStatus 

type CatalogResourceValidationStatus string
const (
	CatalogResourceValidationStatusFailed    CatalogResourceValidationStatus = "Failed"
	CatalogResourceValidationStatusPending   CatalogResourceValidationStatus = "Pending"
	CatalogResourceValidationStatusSucceeded CatalogResourceValidationStatus = "Succeeded"
	CatalogResourceValidationStatusUnknown   CatalogResourceValidationStatus = "Unknown"
)

func (*CatalogResourceValidationStatus) UnmarshalJSON 

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

type DevCenterCatalogId 

type DevCenterCatalogId struct {
	SubscriptionId    string
	ResourceGroupName string
	DevCenterName     string
	CatalogName       string
}

DevCenterCatalogId is a struct representing the Resource ID for a Dev Center Catalog

func NewDevCenterCatalogID 

func NewDevCenterCatalogID(subscriptionId string, resourceGroupName string, devCenterName string, catalogName string) DevCenterCatalogId

NewDevCenterCatalogID returns a new DevCenterCatalogId struct

func ParseDevCenterCatalogID 

func ParseDevCenterCatalogID(input string) (*DevCenterCatalogId, error)

ParseDevCenterCatalogID parses 'input' into a DevCenterCatalogId

func ParseDevCenterCatalogIDInsensitively 

func ParseDevCenterCatalogIDInsensitively(input string) (*DevCenterCatalogId, error)

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

func (*DevCenterCatalogId) FromParseResult 

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

func (DevCenterCatalogId) ID 

func (id DevCenterCatalogId) ID() string

ID returns the formatted Dev Center Catalog ID

func (DevCenterCatalogId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Dev Center Catalog ID

func (DevCenterCatalogId) String 

func (id DevCenterCatalogId) String() string

String returns a human-readable description of this Dev Center Catalog ID

type EnvironmentDefinition 

type EnvironmentDefinition struct {
	Id         *string                          `json:"id,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties *EnvironmentDefinitionProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData           `json:"systemData,omitempty"`
	Type       *string                          `json:"type,omitempty"`
}

type EnvironmentDefinitionId 

type EnvironmentDefinitionId struct {
	SubscriptionId            string
	ResourceGroupName         string
	ProjectName               string
	CatalogName               string
	EnvironmentDefinitionName string
}

EnvironmentDefinitionId is a struct representing the Resource ID for a Environment Definition

func NewEnvironmentDefinitionID 

func NewEnvironmentDefinitionID(subscriptionId string, resourceGroupName string, projectName string, catalogName string, environmentDefinitionName string) EnvironmentDefinitionId

NewEnvironmentDefinitionID returns a new EnvironmentDefinitionId struct

func ParseEnvironmentDefinitionID 

func ParseEnvironmentDefinitionID(input string) (*EnvironmentDefinitionId, error)

ParseEnvironmentDefinitionID parses 'input' into a EnvironmentDefinitionId

func ParseEnvironmentDefinitionIDInsensitively 

func ParseEnvironmentDefinitionIDInsensitively(input string) (*EnvironmentDefinitionId, error)

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

func (*EnvironmentDefinitionId) FromParseResult 

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

func (EnvironmentDefinitionId) ID 

func (id EnvironmentDefinitionId) ID() string

ID returns the formatted Environment Definition ID

func (EnvironmentDefinitionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Environment Definition ID

func (EnvironmentDefinitionId) String 

func (id EnvironmentDefinitionId) String() string

String returns a human-readable description of this Environment Definition ID

type EnvironmentDefinitionOperationPredicate 

type EnvironmentDefinitionOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (EnvironmentDefinitionOperationPredicate) Matches 

func (p EnvironmentDefinitionOperationPredicate) Matches(input EnvironmentDefinition) bool

type EnvironmentDefinitionParameter 

type EnvironmentDefinitionParameter struct {
	Description *string        `json:"description,omitempty"`
	Id          *string        `json:"id,omitempty"`
	Name        *string        `json:"name,omitempty"`
	ReadOnly    *bool          `json:"readOnly,omitempty"`
	Required    *bool          `json:"required,omitempty"`
	Type        *ParameterType `json:"type,omitempty"`
}

type EnvironmentDefinitionProperties 

type EnvironmentDefinitionProperties struct {
	Description      *string                           `json:"description,omitempty"`
	Parameters       *[]EnvironmentDefinitionParameter `json:"parameters,omitempty"`
	TemplatePath     *string                           `json:"templatePath,omitempty"`
	ValidationStatus *CatalogResourceValidationStatus  `json:"validationStatus,omitempty"`
}

type EnvironmentDefinitionsClient 

type EnvironmentDefinitionsClient struct {
	Client *resourcemanager.Client
}

func NewEnvironmentDefinitionsClientWithBaseURI 

func NewEnvironmentDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*EnvironmentDefinitionsClient, error)

func (EnvironmentDefinitionsClient) EnvironmentDefinitionsGet 

func (c EnvironmentDefinitionsClient) EnvironmentDefinitionsGet(ctx context.Context, id CatalogEnvironmentDefinitionId) (result EnvironmentDefinitionsGetOperationResponse, err error)

EnvironmentDefinitionsGet ...

func (EnvironmentDefinitionsClient) EnvironmentDefinitionsGetByProjectCatalog 

func (c EnvironmentDefinitionsClient) EnvironmentDefinitionsGetByProjectCatalog(ctx context.Context, id EnvironmentDefinitionId) (result EnvironmentDefinitionsGetByProjectCatalogOperationResponse, err error)

EnvironmentDefinitionsGetByProjectCatalog ...

func (EnvironmentDefinitionsClient) EnvironmentDefinitionsGetErrorDetails 

func (c EnvironmentDefinitionsClient) EnvironmentDefinitionsGetErrorDetails(ctx context.Context, id CatalogEnvironmentDefinitionId) (result EnvironmentDefinitionsGetErrorDetailsOperationResponse, err error)

EnvironmentDefinitionsGetErrorDetails ...

func (EnvironmentDefinitionsClient) EnvironmentDefinitionsListByCatalog 

func (c EnvironmentDefinitionsClient) EnvironmentDefinitionsListByCatalog(ctx context.Context, id DevCenterCatalogId, options EnvironmentDefinitionsListByCatalogOperationOptions) (result EnvironmentDefinitionsListByCatalogOperationResponse, err error)

EnvironmentDefinitionsListByCatalog ...

func (EnvironmentDefinitionsClient) EnvironmentDefinitionsListByCatalogComplete 

func (c EnvironmentDefinitionsClient) EnvironmentDefinitionsListByCatalogComplete(ctx context.Context, id DevCenterCatalogId, options EnvironmentDefinitionsListByCatalogOperationOptions) (EnvironmentDefinitionsListByCatalogCompleteResult, error)

EnvironmentDefinitionsListByCatalogComplete retrieves all the results into a single object

func (EnvironmentDefinitionsClient) EnvironmentDefinitionsListByCatalogCompleteMatchingPredicate 

func (c EnvironmentDefinitionsClient) EnvironmentDefinitionsListByCatalogCompleteMatchingPredicate(ctx context.Context, id DevCenterCatalogId, options EnvironmentDefinitionsListByCatalogOperationOptions, predicate EnvironmentDefinitionOperationPredicate) (result EnvironmentDefinitionsListByCatalogCompleteResult, err error)

EnvironmentDefinitionsListByCatalogCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EnvironmentDefinitionsClient) EnvironmentDefinitionsListByProjectCatalog 

func (c EnvironmentDefinitionsClient) EnvironmentDefinitionsListByProjectCatalog(ctx context.Context, id CatalogId) (result EnvironmentDefinitionsListByProjectCatalogOperationResponse, err error)

EnvironmentDefinitionsListByProjectCatalog ...

func (EnvironmentDefinitionsClient) EnvironmentDefinitionsListByProjectCatalogComplete 

func (c EnvironmentDefinitionsClient) EnvironmentDefinitionsListByProjectCatalogComplete(ctx context.Context, id CatalogId) (EnvironmentDefinitionsListByProjectCatalogCompleteResult, error)

EnvironmentDefinitionsListByProjectCatalogComplete retrieves all the results into a single object

func (EnvironmentDefinitionsClient) EnvironmentDefinitionsListByProjectCatalogCompleteMatchingPredicate 

func (c EnvironmentDefinitionsClient) EnvironmentDefinitionsListByProjectCatalogCompleteMatchingPredicate(ctx context.Context, id CatalogId, predicate EnvironmentDefinitionOperationPredicate) (result EnvironmentDefinitionsListByProjectCatalogCompleteResult, err error)

EnvironmentDefinitionsListByProjectCatalogCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EnvironmentDefinitionsClient) ProjectCatalogEnvironmentDefinitionsGetErrorDetails 

func (c EnvironmentDefinitionsClient) ProjectCatalogEnvironmentDefinitionsGetErrorDetails(ctx context.Context, id EnvironmentDefinitionId) (result ProjectCatalogEnvironmentDefinitionsGetErrorDetailsOperationResponse, err error)

ProjectCatalogEnvironmentDefinitionsGetErrorDetails ...

type EnvironmentDefinitionsGetByProjectCatalogOperationResponse 

type EnvironmentDefinitionsGetByProjectCatalogOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EnvironmentDefinition
}

type EnvironmentDefinitionsGetErrorDetailsOperationResponse 

type EnvironmentDefinitionsGetErrorDetailsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CatalogResourceValidationErrorDetails
}

type EnvironmentDefinitionsGetOperationResponse 

type EnvironmentDefinitionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EnvironmentDefinition
}

type EnvironmentDefinitionsListByCatalogCompleteResult 

type EnvironmentDefinitionsListByCatalogCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []EnvironmentDefinition
}

type EnvironmentDefinitionsListByCatalogOperationOptions 

type EnvironmentDefinitionsListByCatalogOperationOptions struct {
	Top *int64
}

func DefaultEnvironmentDefinitionsListByCatalogOperationOptions 

func DefaultEnvironmentDefinitionsListByCatalogOperationOptions() EnvironmentDefinitionsListByCatalogOperationOptions

func (EnvironmentDefinitionsListByCatalogOperationOptions) ToHeaders 

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

func (EnvironmentDefinitionsListByCatalogOperationOptions) ToOData 

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

func (EnvironmentDefinitionsListByCatalogOperationOptions) ToQuery 

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

type EnvironmentDefinitionsListByCatalogOperationResponse 

type EnvironmentDefinitionsListByCatalogOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EnvironmentDefinition
}

type EnvironmentDefinitionsListByProjectCatalogCompleteResult 

type EnvironmentDefinitionsListByProjectCatalogCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []EnvironmentDefinition
}

type EnvironmentDefinitionsListByProjectCatalogOperationResponse 

type EnvironmentDefinitionsListByProjectCatalogOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EnvironmentDefinition
}

type ParameterType 

type ParameterType string
const (
	ParameterTypeArray   ParameterType = "array"
	ParameterTypeBoolean ParameterType = "boolean"
	ParameterTypeInteger ParameterType = "integer"
	ParameterTypeNumber  ParameterType = "number"
	ParameterTypeObject  ParameterType = "object"
	ParameterTypeString  ParameterType = "string"
)

func (*ParameterType) UnmarshalJSON 

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

type ProjectCatalogEnvironmentDefinitionsGetErrorDetailsOperationResponse 

type ProjectCatalogEnvironmentDefinitionsGetErrorDetailsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CatalogResourceValidationErrorDetails
}

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.