applicationdefinitions

package
v0.20240110.1102249 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/managedapplications/2021-07-01/applicationdefinitions Documentation

The applicationdefinitions SDK allows for interaction with the Azure Resource Manager Service managedapplications (API Version 2021-07-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/managedapplications/2021-07-01/applicationdefinitions"

Client Initialization

client := applicationdefinitions.NewApplicationDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApplicationDefinitionsClient.CreateOrUpdate

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

payload := applicationdefinitions.ApplicationDefinition{
	// ...
}


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

Example Usage: ApplicationDefinitionsClient.Delete

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

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

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

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: ApplicationDefinitionsClient.ListByResourceGroup

ctx := context.TODO()
id := applicationdefinitions.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: ApplicationDefinitionsClient.ListBySubscription

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

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

Example Usage: ApplicationDefinitionsClient.Update

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

payload := applicationdefinitions.ApplicationDefinitionPatchable{
	// ...
}


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 PossibleValuesForApplicationArtifactType

func PossibleValuesForApplicationArtifactType() []string

func PossibleValuesForApplicationDefinitionArtifactName

func PossibleValuesForApplicationDefinitionArtifactName() []string

func PossibleValuesForApplicationLockLevel

func PossibleValuesForApplicationLockLevel() []string

func PossibleValuesForApplicationManagementMode

func PossibleValuesForApplicationManagementMode() []string

func PossibleValuesForDeploymentMode

func PossibleValuesForDeploymentMode() []string

func ValidateApplicationDefinitionID

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

ValidateApplicationDefinitionID checks that 'input' can be parsed as a Application Definition ID

Types

type ApplicationArtifactType

type ApplicationArtifactType string
const (
	ApplicationArtifactTypeCustom       ApplicationArtifactType = "Custom"
	ApplicationArtifactTypeNotSpecified ApplicationArtifactType = "NotSpecified"
	ApplicationArtifactTypeTemplate     ApplicationArtifactType = "Template"
)

func (*ApplicationArtifactType) UnmarshalJSON

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

type ApplicationAuthorization

type ApplicationAuthorization struct {
	PrincipalId      string `json:"principalId"`
	RoleDefinitionId string `json:"roleDefinitionId"`
}

type ApplicationDefinition

type ApplicationDefinition struct {
	Id         *string                         `json:"id,omitempty"`
	Location   *string                         `json:"location,omitempty"`
	ManagedBy  *string                         `json:"managedBy,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties ApplicationDefinitionProperties `json:"properties"`
	Sku        *Sku                            `json:"sku,omitempty"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type ApplicationDefinitionArtifact

type ApplicationDefinitionArtifact struct {
	Name ApplicationDefinitionArtifactName `json:"name"`
	Type ApplicationArtifactType           `json:"type"`
	Uri  string                            `json:"uri"`
}

type ApplicationDefinitionArtifactName

type ApplicationDefinitionArtifactName string
const (
	ApplicationDefinitionArtifactNameApplicationResourceTemplate ApplicationDefinitionArtifactName = "ApplicationResourceTemplate"
	ApplicationDefinitionArtifactNameCreateUiDefinition          ApplicationDefinitionArtifactName = "CreateUiDefinition"
	ApplicationDefinitionArtifactNameMainTemplateParameters      ApplicationDefinitionArtifactName = "MainTemplateParameters"
	ApplicationDefinitionArtifactNameNotSpecified                ApplicationDefinitionArtifactName = "NotSpecified"
)

func (*ApplicationDefinitionArtifactName) UnmarshalJSON

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

type ApplicationDefinitionId

type ApplicationDefinitionId struct {
	SubscriptionId            string
	ResourceGroupName         string
	ApplicationDefinitionName string
}

ApplicationDefinitionId is a struct representing the Resource ID for a Application Definition

func NewApplicationDefinitionID

func NewApplicationDefinitionID(subscriptionId string, resourceGroupName string, applicationDefinitionName string) ApplicationDefinitionId

NewApplicationDefinitionID returns a new ApplicationDefinitionId struct

func ParseApplicationDefinitionID

func ParseApplicationDefinitionID(input string) (*ApplicationDefinitionId, error)

ParseApplicationDefinitionID parses 'input' into a ApplicationDefinitionId

func ParseApplicationDefinitionIDInsensitively

func ParseApplicationDefinitionIDInsensitively(input string) (*ApplicationDefinitionId, error)

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

func (*ApplicationDefinitionId) FromParseResult added in v0.20231127.1171502

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

func (ApplicationDefinitionId) ID

ID returns the formatted Application Definition ID

func (ApplicationDefinitionId) Segments

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

func (ApplicationDefinitionId) String

func (id ApplicationDefinitionId) String() string

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

type ApplicationDefinitionOperationPredicate

type ApplicationDefinitionOperationPredicate struct {
	Id        *string
	Location  *string
	ManagedBy *string
	Name      *string
	Type      *string
}

func (ApplicationDefinitionOperationPredicate) Matches

type ApplicationDefinitionPatchable

type ApplicationDefinitionPatchable struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type ApplicationDefinitionProperties

type ApplicationDefinitionProperties struct {
	Artifacts          *[]ApplicationDefinitionArtifact           `json:"artifacts,omitempty"`
	Authorizations     *[]ApplicationAuthorization                `json:"authorizations,omitempty"`
	CreateUiDefinition *interface{}                               `json:"createUiDefinition,omitempty"`
	DeploymentPolicy   *ApplicationDeploymentPolicy               `json:"deploymentPolicy,omitempty"`
	Description        *string                                    `json:"description,omitempty"`
	DisplayName        *string                                    `json:"displayName,omitempty"`
	IsEnabled          *bool                                      `json:"isEnabled,omitempty"`
	LockLevel          ApplicationLockLevel                       `json:"lockLevel"`
	LockingPolicy      *ApplicationPackageLockingPolicyDefinition `json:"lockingPolicy,omitempty"`
	MainTemplate       *interface{}                               `json:"mainTemplate,omitempty"`
	ManagementPolicy   *ApplicationManagementPolicy               `json:"managementPolicy,omitempty"`
	NotificationPolicy *ApplicationNotificationPolicy             `json:"notificationPolicy,omitempty"`
	PackageFileUri     *string                                    `json:"packageFileUri,omitempty"`
	Policies           *[]ApplicationPolicy                       `json:"policies,omitempty"`
	StorageAccountId   *string                                    `json:"storageAccountId,omitempty"`
}

type ApplicationDefinitionsClient

type ApplicationDefinitionsClient struct {
	Client *resourcemanager.Client
}

func NewApplicationDefinitionsClientWithBaseURI

func NewApplicationDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ApplicationDefinitionsClient, error)

func (ApplicationDefinitionsClient) CreateOrUpdate

CreateOrUpdate ...

func (ApplicationDefinitionsClient) Delete

Delete ...

func (ApplicationDefinitionsClient) Get

Get ...

func (ApplicationDefinitionsClient) ListByResourceGroup

ListByResourceGroup ...

func (ApplicationDefinitionsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (ApplicationDefinitionsClient) ListByResourceGroupCompleteMatchingPredicate

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApplicationDefinitionsClient) ListBySubscription

ListBySubscription ...

func (ApplicationDefinitionsClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (ApplicationDefinitionsClient) ListBySubscriptionCompleteMatchingPredicate

func (c ApplicationDefinitionsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ApplicationDefinitionOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApplicationDefinitionsClient) Update

Update ...

type ApplicationDeploymentPolicy

type ApplicationDeploymentPolicy struct {
	DeploymentMode DeploymentMode `json:"deploymentMode"`
}

type ApplicationLockLevel

type ApplicationLockLevel string
const (
	ApplicationLockLevelCanNotDelete ApplicationLockLevel = "CanNotDelete"
	ApplicationLockLevelNone         ApplicationLockLevel = "None"
	ApplicationLockLevelReadOnly     ApplicationLockLevel = "ReadOnly"
)

func (*ApplicationLockLevel) UnmarshalJSON

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

type ApplicationManagementMode

type ApplicationManagementMode string
const (
	ApplicationManagementModeManaged      ApplicationManagementMode = "Managed"
	ApplicationManagementModeNotSpecified ApplicationManagementMode = "NotSpecified"
	ApplicationManagementModeUnmanaged    ApplicationManagementMode = "Unmanaged"
)

func (*ApplicationManagementMode) UnmarshalJSON

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

type ApplicationManagementPolicy

type ApplicationManagementPolicy struct {
	Mode *ApplicationManagementMode `json:"mode,omitempty"`
}

type ApplicationNotificationEndpoint

type ApplicationNotificationEndpoint struct {
	Uri string `json:"uri"`
}

type ApplicationNotificationPolicy

type ApplicationNotificationPolicy struct {
	NotificationEndpoints []ApplicationNotificationEndpoint `json:"notificationEndpoints"`
}

type ApplicationPackageLockingPolicyDefinition

type ApplicationPackageLockingPolicyDefinition struct {
	AllowedActions     *[]string `json:"allowedActions,omitempty"`
	AllowedDataActions *[]string `json:"allowedDataActions,omitempty"`
}

type ApplicationPolicy

type ApplicationPolicy struct {
	Name               *string `json:"name,omitempty"`
	Parameters         *string `json:"parameters,omitempty"`
	PolicyDefinitionId *string `json:"policyDefinitionId,omitempty"`
}

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type DeploymentMode

type DeploymentMode string
const (
	DeploymentModeComplete     DeploymentMode = "Complete"
	DeploymentModeIncremental  DeploymentMode = "Incremental"
	DeploymentModeNotSpecified DeploymentMode = "NotSpecified"
)

func (*DeploymentMode) UnmarshalJSON

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

type GetOperationResponse

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

type ListByResourceGroupCompleteResult

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

type ListByResourceGroupOperationResponse

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

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApplicationDefinition
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApplicationDefinition
}

type Sku

type Sku struct {
	Capacity *int64  `json:"capacity,omitempty"`
	Family   *string `json:"family,omitempty"`
	Model    *string `json:"model,omitempty"`
	Name     string  `json:"name"`
	Size     *string `json:"size,omitempty"`
	Tier     *string `json:"tier,omitempty"`
}

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

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