devcenters

package
v0.20241126.2320 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

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

The devcenters SDK allows for interaction with Azure Resource Manager 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2024-02-01/devcenters"

Client Initialization

client := devcenters.NewDevCentersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DevCentersClient.CreateOrUpdate

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

payload := devcenters.DevCenter{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DevCentersClient.Delete

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

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DevCentersClient.Get

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

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

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

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

Example Usage: DevCentersClient.ListBySubscription

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

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

Example Usage: DevCentersClient.Update

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

payload := devcenters.DevCenterUpdate{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCatalogItemSyncEnableStatus 

func PossibleValuesForCatalogItemSyncEnableStatus() []string

func PossibleValuesForIdentityType 

func PossibleValuesForIdentityType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateDevCenterID 

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

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

Types

type CatalogItemSyncEnableStatus 

type CatalogItemSyncEnableStatus string
const (
	CatalogItemSyncEnableStatusDisabled CatalogItemSyncEnableStatus = "Disabled"
	CatalogItemSyncEnableStatusEnabled  CatalogItemSyncEnableStatus = "Enabled"
)

func (*CatalogItemSyncEnableStatus) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DevCenter
}

type CustomerManagedKeyEncryption 

type CustomerManagedKeyEncryption struct {
	KeyEncryptionKeyIdentity *CustomerManagedKeyEncryptionKeyEncryptionKeyIdentity `json:"keyEncryptionKeyIdentity,omitempty"`
	KeyEncryptionKeyURL      *string                                               `json:"keyEncryptionKeyUrl,omitempty"`
}

type CustomerManagedKeyEncryptionKeyEncryptionKeyIdentity 

type CustomerManagedKeyEncryptionKeyEncryptionKeyIdentity struct {
	DelegatedIdentityClientId      *string       `json:"delegatedIdentityClientId,omitempty"`
	IdentityType                   *IdentityType `json:"identityType,omitempty"`
	UserAssignedIdentityResourceId *string       `json:"userAssignedIdentityResourceId,omitempty"`
}

type DeleteOperationResponse 

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

type DevCenter 

type DevCenter struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *DevCenterProperties               `json:"properties,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type DevCenterId 

type DevCenterId struct {
	SubscriptionId    string
	ResourceGroupName string
	DevCenterName     string
}

DevCenterId is a struct representing the Resource ID for a Dev Center

func NewDevCenterID 

func NewDevCenterID(subscriptionId string, resourceGroupName string, devCenterName string) DevCenterId

NewDevCenterID returns a new DevCenterId struct

func ParseDevCenterID 

func ParseDevCenterID(input string) (*DevCenterId, error)

ParseDevCenterID parses 'input' into a DevCenterId

func ParseDevCenterIDInsensitively 

func ParseDevCenterIDInsensitively(input string) (*DevCenterId, error)

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

func (*DevCenterId) FromParseResult 

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

func (DevCenterId) ID 

func (id DevCenterId) ID() string

ID returns the formatted Dev Center ID

func (DevCenterId) Segments 

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

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

func (DevCenterId) String 

func (id DevCenterId) String() string

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

type DevCenterOperationPredicate 

type DevCenterOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (DevCenterOperationPredicate) Matches 

func (p DevCenterOperationPredicate) Matches(input DevCenter) bool

type DevCenterProjectCatalogSettings 

type DevCenterProjectCatalogSettings struct {
	CatalogItemSyncEnableStatus *CatalogItemSyncEnableStatus `json:"catalogItemSyncEnableStatus,omitempty"`
}

type DevCenterProperties 

type DevCenterProperties struct {
	DevCenterUri           *string                          `json:"devCenterUri,omitempty"`
	DisplayName            *string                          `json:"displayName,omitempty"`
	Encryption             *Encryption                      `json:"encryption,omitempty"`
	ProjectCatalogSettings *DevCenterProjectCatalogSettings `json:"projectCatalogSettings,omitempty"`
	ProvisioningState      *ProvisioningState               `json:"provisioningState,omitempty"`
}

type DevCenterUpdate 

type DevCenterUpdate struct {
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Properties *DevCenterUpdateProperties         `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type DevCenterUpdateProperties 

type DevCenterUpdateProperties struct {
	DisplayName            *string                          `json:"displayName,omitempty"`
	Encryption             *Encryption                      `json:"encryption,omitempty"`
	ProjectCatalogSettings *DevCenterProjectCatalogSettings `json:"projectCatalogSettings,omitempty"`
}

type DevCentersClient 

type DevCentersClient struct {
	Client *resourcemanager.Client
}

func NewDevCentersClientWithBaseURI 

func NewDevCentersClientWithBaseURI(sdkApi sdkEnv.Api) (*DevCentersClient, error)

func (DevCentersClient) CreateOrUpdate 

func (c DevCentersClient) CreateOrUpdate(ctx context.Context, id DevCenterId, input DevCenter) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DevCentersClient) CreateOrUpdateThenPoll 

func (c DevCentersClient) CreateOrUpdateThenPoll(ctx context.Context, id DevCenterId, input DevCenter) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DevCentersClient) Delete 

func (c DevCentersClient) Delete(ctx context.Context, id DevCenterId) (result DeleteOperationResponse, err error)

Delete ...

func (DevCentersClient) DeleteThenPoll 

func (c DevCentersClient) DeleteThenPoll(ctx context.Context, id DevCenterId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DevCentersClient) Get 

func (c DevCentersClient) Get(ctx context.Context, id DevCenterId) (result GetOperationResponse, err error)

Get ...

func (DevCentersClient) ListByResourceGroup 

func (c DevCentersClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (DevCentersClient) ListByResourceGroupComplete 

func (c DevCentersClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (DevCentersClient) ListByResourceGroupCompleteMatchingPredicate 

func (c DevCentersClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions, predicate DevCenterOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DevCentersClient) ListBySubscription 

func (c DevCentersClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (DevCentersClient) ListBySubscriptionComplete 

func (c DevCentersClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (DevCentersClient) ListBySubscriptionCompleteMatchingPredicate 

func (c DevCentersClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions, predicate DevCenterOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DevCentersClient) Update 

func (c DevCentersClient) Update(ctx context.Context, id DevCenterId, input DevCenterUpdate) (result UpdateOperationResponse, err error)

Update ...

func (DevCentersClient) UpdateThenPoll 

func (c DevCentersClient) UpdateThenPoll(ctx context.Context, id DevCenterId, input DevCenterUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type Encryption 

type Encryption struct {
	CustomerManagedKeyEncryption *CustomerManagedKeyEncryption `json:"customerManagedKeyEncryption,omitempty"`
}

type GetOperationResponse 

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

type IdentityType 

type IdentityType string
const (
	IdentityTypeDelegatedResourceIdentity IdentityType = "delegatedResourceIdentity"
	IdentityTypeSystemAssignedIdentity    IdentityType = "systemAssignedIdentity"
	IdentityTypeUserAssignedIdentity      IdentityType = "userAssignedIdentity"
)

func (*IdentityType) UnmarshalJSON 

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

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupCustomPager 

type ListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ListByResourceGroupOperationOptions 

type ListByResourceGroupOperationOptions struct {
	Top *int64
}

func DefaultListByResourceGroupOperationOptions 

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

func (ListByResourceGroupOperationOptions) ToHeaders 

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

func (ListByResourceGroupOperationOptions) ToOData 

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

func (ListByResourceGroupOperationOptions) ToQuery 

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

type ListByResourceGroupOperationResponse 

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

type ListBySubscriptionCompleteResult 

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

type ListBySubscriptionCustomPager 

type ListBySubscriptionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListBySubscriptionCustomPager) NextPageLink() *odata.Link

type ListBySubscriptionOperationOptions 

type ListBySubscriptionOperationOptions struct {
	Top *int64
}

func DefaultListBySubscriptionOperationOptions 

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

func (ListBySubscriptionOperationOptions) ToHeaders 

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

func (ListBySubscriptionOperationOptions) ToOData 

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

func (ListBySubscriptionOperationOptions) ToQuery 

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

type ListBySubscriptionOperationResponse 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted                  ProvisioningState = "Accepted"
	ProvisioningStateCanceled                  ProvisioningState = "Canceled"
	ProvisioningStateCreated                   ProvisioningState = "Created"
	ProvisioningStateCreating                  ProvisioningState = "Creating"
	ProvisioningStateDeleted                   ProvisioningState = "Deleted"
	ProvisioningStateDeleting                  ProvisioningState = "Deleting"
	ProvisioningStateFailed                    ProvisioningState = "Failed"
	ProvisioningStateMovingResources           ProvisioningState = "MovingResources"
	ProvisioningStateNotSpecified              ProvisioningState = "NotSpecified"
	ProvisioningStateRolloutInProgress         ProvisioningState = "RolloutInProgress"
	ProvisioningStateRunning                   ProvisioningState = "Running"
	ProvisioningStateStorageProvisioningFailed ProvisioningState = "StorageProvisioningFailed"
	ProvisioningStateSucceeded                 ProvisioningState = "Succeeded"
	ProvisioningStateTransientFailure          ProvisioningState = "TransientFailure"
	ProvisioningStateUpdated                   ProvisioningState = "Updated"
	ProvisioningStateUpdating                  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DevCenter
}

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.