assetendpointprofiles

package
v0.20241023.1122425 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/deviceregistry/2024-11-01/assetendpointprofiles Documentation

The assetendpointprofiles SDK allows for interaction with Azure Resource Manager deviceregistry (API Version 2024-11-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/deviceregistry/2024-11-01/assetendpointprofiles"

Client Initialization

client := assetendpointprofiles.NewAssetEndpointProfilesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AssetEndpointProfilesClient.CreateOrReplace

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

payload := assetendpointprofiles.AssetEndpointProfile{
	// ...
}


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

Example Usage: AssetEndpointProfilesClient.Delete

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

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

Example Usage: AssetEndpointProfilesClient.Get

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

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: AssetEndpointProfilesClient.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: AssetEndpointProfilesClient.ListBySubscription

ctx := context.TODO()
id := commonids.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: AssetEndpointProfilesClient.Update

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

payload := assetendpointprofiles.AssetEndpointProfileUpdate{
	// ...
}


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 PossibleValuesForAuthenticationMethod 

func PossibleValuesForAuthenticationMethod() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateAssetEndpointProfileID 

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

ValidateAssetEndpointProfileID checks that 'input' can be parsed as a Asset Endpoint Profile ID

Types

type AssetEndpointProfile 

type AssetEndpointProfile struct {
	ExtendedLocation ExtendedLocation                `json:"extendedLocation"`
	Id               *string                         `json:"id,omitempty"`
	Location         string                          `json:"location"`
	Name             *string                         `json:"name,omitempty"`
	Properties       *AssetEndpointProfileProperties `json:"properties,omitempty"`
	SystemData       *systemdata.SystemData          `json:"systemData,omitempty"`
	Tags             *map[string]string              `json:"tags,omitempty"`
	Type             *string                         `json:"type,omitempty"`
}

type AssetEndpointProfileId 

type AssetEndpointProfileId struct {
	SubscriptionId           string
	ResourceGroupName        string
	AssetEndpointProfileName string
}

AssetEndpointProfileId is a struct representing the Resource ID for a Asset Endpoint Profile

func NewAssetEndpointProfileID 

func NewAssetEndpointProfileID(subscriptionId string, resourceGroupName string, assetEndpointProfileName string) AssetEndpointProfileId

NewAssetEndpointProfileID returns a new AssetEndpointProfileId struct

func ParseAssetEndpointProfileID 

func ParseAssetEndpointProfileID(input string) (*AssetEndpointProfileId, error)

ParseAssetEndpointProfileID parses 'input' into a AssetEndpointProfileId

func ParseAssetEndpointProfileIDInsensitively 

func ParseAssetEndpointProfileIDInsensitively(input string) (*AssetEndpointProfileId, error)

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

func (*AssetEndpointProfileId) FromParseResult 

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

func (AssetEndpointProfileId) ID 

func (id AssetEndpointProfileId) ID() string

ID returns the formatted Asset Endpoint Profile ID

func (AssetEndpointProfileId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Asset Endpoint Profile ID

func (AssetEndpointProfileId) String 

func (id AssetEndpointProfileId) String() string

String returns a human-readable description of this Asset Endpoint Profile ID

type AssetEndpointProfileOperationPredicate 

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

func (AssetEndpointProfileOperationPredicate) Matches 

func (p AssetEndpointProfileOperationPredicate) Matches(input AssetEndpointProfile) bool

type AssetEndpointProfileProperties 

type AssetEndpointProfileProperties struct {
	AdditionalConfiguration           *string                     `json:"additionalConfiguration,omitempty"`
	Authentication                    *Authentication             `json:"authentication,omitempty"`
	DiscoveredAssetEndpointProfileRef *string                     `json:"discoveredAssetEndpointProfileRef,omitempty"`
	EndpointProfileType               string                      `json:"endpointProfileType"`
	ProvisioningState                 *ProvisioningState          `json:"provisioningState,omitempty"`
	Status                            *AssetEndpointProfileStatus `json:"status,omitempty"`
	TargetAddress                     string                      `json:"targetAddress"`
	Uuid                              *string                     `json:"uuid,omitempty"`
}

type AssetEndpointProfileStatus 

type AssetEndpointProfileStatus struct {
	Errors *[]AssetEndpointProfileStatusError `json:"errors,omitempty"`
}

type AssetEndpointProfileStatusError 

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

type AssetEndpointProfileUpdate 

type AssetEndpointProfileUpdate struct {
	Properties *AssetEndpointProfileUpdateProperties `json:"properties,omitempty"`
	Tags       *map[string]string                    `json:"tags,omitempty"`
}

type AssetEndpointProfileUpdateProperties 

type AssetEndpointProfileUpdateProperties struct {
	AdditionalConfiguration *string               `json:"additionalConfiguration,omitempty"`
	Authentication          *AuthenticationUpdate `json:"authentication,omitempty"`
	EndpointProfileType     *string               `json:"endpointProfileType,omitempty"`
	TargetAddress           *string               `json:"targetAddress,omitempty"`
}

type AssetEndpointProfilesClient 

type AssetEndpointProfilesClient struct {
	Client *resourcemanager.Client
}

func NewAssetEndpointProfilesClientWithBaseURI 

func NewAssetEndpointProfilesClientWithBaseURI(sdkApi sdkEnv.Api) (*AssetEndpointProfilesClient, error)

func (AssetEndpointProfilesClient) CreateOrReplace 

func (c AssetEndpointProfilesClient) CreateOrReplace(ctx context.Context, id AssetEndpointProfileId, input AssetEndpointProfile) (result CreateOrReplaceOperationResponse, err error)

CreateOrReplace ...

func (AssetEndpointProfilesClient) CreateOrReplaceThenPoll 

func (c AssetEndpointProfilesClient) CreateOrReplaceThenPoll(ctx context.Context, id AssetEndpointProfileId, input AssetEndpointProfile) error

CreateOrReplaceThenPoll performs CreateOrReplace then polls until it's completed

func (AssetEndpointProfilesClient) Delete 

func (c AssetEndpointProfilesClient) Delete(ctx context.Context, id AssetEndpointProfileId) (result DeleteOperationResponse, err error)

Delete ...

func (AssetEndpointProfilesClient) DeleteThenPoll 

func (c AssetEndpointProfilesClient) DeleteThenPoll(ctx context.Context, id AssetEndpointProfileId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AssetEndpointProfilesClient) Get 

func (c AssetEndpointProfilesClient) Get(ctx context.Context, id AssetEndpointProfileId) (result GetOperationResponse, err error)

Get ...

func (AssetEndpointProfilesClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (AssetEndpointProfilesClient) ListByResourceGroupComplete 

func (c AssetEndpointProfilesClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (AssetEndpointProfilesClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AssetEndpointProfilesClient) ListBySubscription 

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

ListBySubscription ...

func (AssetEndpointProfilesClient) ListBySubscriptionComplete 

func (c AssetEndpointProfilesClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (AssetEndpointProfilesClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AssetEndpointProfilesClient) Update 

func (c AssetEndpointProfilesClient) Update(ctx context.Context, id AssetEndpointProfileId, input AssetEndpointProfileUpdate) (result UpdateOperationResponse, err error)

Update ...

func (AssetEndpointProfilesClient) UpdateThenPoll 

func (c AssetEndpointProfilesClient) UpdateThenPoll(ctx context.Context, id AssetEndpointProfileId, input AssetEndpointProfileUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type Authentication 

type Authentication struct {
	Method                      AuthenticationMethod         `json:"method"`
	UsernamePasswordCredentials *UsernamePasswordCredentials `json:"usernamePasswordCredentials,omitempty"`
	X509Credentials             *X509Credentials             `json:"x509Credentials,omitempty"`
}

type AuthenticationMethod 

type AuthenticationMethod string
const (
	AuthenticationMethodAnonymous        AuthenticationMethod = "Anonymous"
	AuthenticationMethodCertificate      AuthenticationMethod = "Certificate"
	AuthenticationMethodUsernamePassword AuthenticationMethod = "UsernamePassword"
)

func (*AuthenticationMethod) UnmarshalJSON 

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

type AuthenticationUpdate 

type AuthenticationUpdate struct {
	Method                      *AuthenticationMethod              `json:"method,omitempty"`
	UsernamePasswordCredentials *UsernamePasswordCredentialsUpdate `json:"usernamePasswordCredentials,omitempty"`
	X509Credentials             *X509CredentialsUpdate             `json:"x509Credentials,omitempty"`
}

type CreateOrReplaceOperationResponse 

type CreateOrReplaceOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AssetEndpointProfile
}

type DeleteOperationResponse 

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

type ExtendedLocation 

type ExtendedLocation struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupCustomPager 

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

type ListByResourceGroupOperationResponse 

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

type ListBySubscriptionCompleteResult 

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

type ListBySubscriptionCustomPager 

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

type ListBySubscriptionOperationResponse 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted  ProvisioningState = "Accepted"
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

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        *AssetEndpointProfile
}

type UsernamePasswordCredentials 

type UsernamePasswordCredentials struct {
	PasswordSecretName string `json:"passwordSecretName"`
	UsernameSecretName string `json:"usernameSecretName"`
}

type UsernamePasswordCredentialsUpdate 

type UsernamePasswordCredentialsUpdate struct {
	PasswordSecretName *string `json:"passwordSecretName,omitempty"`
	UsernameSecretName *string `json:"usernameSecretName,omitempty"`
}

type X509Credentials 

type X509Credentials struct {
	CertificateSecretName string `json:"certificateSecretName"`
}

type X509CredentialsUpdate 

type X509CredentialsUpdate struct {
	CertificateSecretName *string `json:"certificateSecretName,omitempty"`
}

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.