README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/confidentialledger/2022-05-13/confidentialledger
Documentation
The confidentialledger
SDK allows for interaction with the Azure Resource Manager Service confidentialledger
(API Version 2022-05-13
).
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/confidentialledger/2022-05-13/confidentialledger"
Client Initialization
client := confidentialledger.NewConfidentialLedgerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ConfidentialLedgerClient.LedgerCreate
ctx := context.TODO()
id := confidentialledger.NewLedgerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "ledgerValue")
payload := confidentialledger.ConfidentialLedger{
// ...
}
if err := client.LedgerCreateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: ConfidentialLedgerClient.LedgerDelete
ctx := context.TODO()
id := confidentialledger.NewLedgerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "ledgerValue")
if err := client.LedgerDeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: ConfidentialLedgerClient.LedgerGet
ctx := context.TODO()
id := confidentialledger.NewLedgerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "ledgerValue")
read, err := client.LedgerGet(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: ConfidentialLedgerClient.LedgerListByResourceGroup
ctx := context.TODO()
id := confidentialledger.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
// alternatively `client.LedgerListByResourceGroup(ctx, id, confidentialledger.DefaultLedgerListByResourceGroupOperationOptions())` can be used to do batched pagination
items, err := client.LedgerListByResourceGroupComplete(ctx, id, confidentialledger.DefaultLedgerListByResourceGroupOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ConfidentialLedgerClient.LedgerListBySubscription
ctx := context.TODO()
id := confidentialledger.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// alternatively `client.LedgerListBySubscription(ctx, id, confidentialledger.DefaultLedgerListBySubscriptionOperationOptions())` can be used to do batched pagination
items, err := client.LedgerListBySubscriptionComplete(ctx, id, confidentialledger.DefaultLedgerListBySubscriptionOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ConfidentialLedgerClient.LedgerUpdate
ctx := context.TODO()
id := confidentialledger.NewLedgerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "ledgerValue")
payload := confidentialledger.ConfidentialLedger{
// ...
}
if err := client.LedgerUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForLedgerRoleName() []string
- func PossibleValuesForLedgerType() []string
- func PossibleValuesForProvisioningState() []string
- func ValidateLedgerID(input interface{}, key string) (warnings []string, errors []error)
- type AADBasedSecurityPrincipal
- type CertBasedSecurityPrincipal
- type ConfidentialLedger
- type ConfidentialLedgerClient
- func (c ConfidentialLedgerClient) LedgerCreate(ctx context.Context, id LedgerId, input ConfidentialLedger) (result LedgerCreateOperationResponse, err error)
- func (c ConfidentialLedgerClient) LedgerCreateThenPoll(ctx context.Context, id LedgerId, input ConfidentialLedger) error
- func (c ConfidentialLedgerClient) LedgerDelete(ctx context.Context, id LedgerId) (result LedgerDeleteOperationResponse, err error)
- func (c ConfidentialLedgerClient) LedgerDeleteThenPoll(ctx context.Context, id LedgerId) error
- func (c ConfidentialLedgerClient) LedgerGet(ctx context.Context, id LedgerId) (result LedgerGetOperationResponse, err error)
- func (c ConfidentialLedgerClient) LedgerListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, ...) (result LedgerListByResourceGroupOperationResponse, err error)
- func (c ConfidentialLedgerClient) LedgerListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, ...) (LedgerListByResourceGroupCompleteResult, error)
- func (c ConfidentialLedgerClient) LedgerListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result LedgerListByResourceGroupCompleteResult, err error)
- func (c ConfidentialLedgerClient) LedgerListBySubscription(ctx context.Context, id commonids.SubscriptionId, ...) (result LedgerListBySubscriptionOperationResponse, err error)
- func (c ConfidentialLedgerClient) LedgerListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, ...) (LedgerListBySubscriptionCompleteResult, error)
- func (c ConfidentialLedgerClient) LedgerListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result LedgerListBySubscriptionCompleteResult, err error)
- func (c ConfidentialLedgerClient) LedgerUpdate(ctx context.Context, id LedgerId, input ConfidentialLedger) (result LedgerUpdateOperationResponse, err error)
- func (c ConfidentialLedgerClient) LedgerUpdateThenPoll(ctx context.Context, id LedgerId, input ConfidentialLedger) error
- type ConfidentialLedgerOperationPredicate
- type LedgerCreateOperationResponse
- type LedgerDeleteOperationResponse
- type LedgerGetOperationResponse
- type LedgerId
- type LedgerListByResourceGroupCompleteResult
- type LedgerListByResourceGroupOperationOptions
- type LedgerListByResourceGroupOperationResponse
- type LedgerListBySubscriptionCompleteResult
- type LedgerListBySubscriptionOperationOptions
- type LedgerListBySubscriptionOperationResponse
- type LedgerProperties
- type LedgerRoleName
- type LedgerType
- type LedgerUpdateOperationResponse
- type ProvisioningState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForLedgerRoleName ¶
func PossibleValuesForLedgerRoleName() []string
func PossibleValuesForLedgerType ¶
func PossibleValuesForLedgerType() []string
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func ValidateLedgerID ¶
ValidateLedgerID checks that 'input' can be parsed as a Ledger ID
Types ¶
type AADBasedSecurityPrincipal ¶
type AADBasedSecurityPrincipal struct { LedgerRoleName *LedgerRoleName `json:"ledgerRoleName,omitempty"` PrincipalId *string `json:"principalId,omitempty"` TenantId *string `json:"tenantId,omitempty"` }
type CertBasedSecurityPrincipal ¶
type CertBasedSecurityPrincipal struct { Cert *string `json:"cert,omitempty"` LedgerRoleName *LedgerRoleName `json:"ledgerRoleName,omitempty"` }
type ConfidentialLedger ¶
type ConfidentialLedger struct { Id *string `json:"id,omitempty"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` Properties *LedgerProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type ConfidentialLedgerClient ¶
type ConfidentialLedgerClient struct {
Client *resourcemanager.Client
}
func NewConfidentialLedgerClientWithBaseURI ¶
func NewConfidentialLedgerClientWithBaseURI(sdkApi sdkEnv.Api) (*ConfidentialLedgerClient, error)
func (ConfidentialLedgerClient) LedgerCreate ¶
func (c ConfidentialLedgerClient) LedgerCreate(ctx context.Context, id LedgerId, input ConfidentialLedger) (result LedgerCreateOperationResponse, err error)
LedgerCreate ...
func (ConfidentialLedgerClient) LedgerCreateThenPoll ¶
func (c ConfidentialLedgerClient) LedgerCreateThenPoll(ctx context.Context, id LedgerId, input ConfidentialLedger) error
LedgerCreateThenPoll performs LedgerCreate then polls until it's completed
func (ConfidentialLedgerClient) LedgerDelete ¶
func (c ConfidentialLedgerClient) LedgerDelete(ctx context.Context, id LedgerId) (result LedgerDeleteOperationResponse, err error)
LedgerDelete ...
func (ConfidentialLedgerClient) LedgerDeleteThenPoll ¶
func (c ConfidentialLedgerClient) LedgerDeleteThenPoll(ctx context.Context, id LedgerId) error
LedgerDeleteThenPoll performs LedgerDelete then polls until it's completed
func (ConfidentialLedgerClient) LedgerGet ¶
func (c ConfidentialLedgerClient) LedgerGet(ctx context.Context, id LedgerId) (result LedgerGetOperationResponse, err error)
LedgerGet ...
func (ConfidentialLedgerClient) LedgerListByResourceGroup ¶
func (c ConfidentialLedgerClient) LedgerListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options LedgerListByResourceGroupOperationOptions) (result LedgerListByResourceGroupOperationResponse, err error)
LedgerListByResourceGroup ...
func (ConfidentialLedgerClient) LedgerListByResourceGroupComplete ¶
func (c ConfidentialLedgerClient) LedgerListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, options LedgerListByResourceGroupOperationOptions) (LedgerListByResourceGroupCompleteResult, error)
LedgerListByResourceGroupComplete retrieves all the results into a single object
func (ConfidentialLedgerClient) LedgerListByResourceGroupCompleteMatchingPredicate ¶
func (c ConfidentialLedgerClient) LedgerListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options LedgerListByResourceGroupOperationOptions, predicate ConfidentialLedgerOperationPredicate) (result LedgerListByResourceGroupCompleteResult, err error)
LedgerListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (ConfidentialLedgerClient) LedgerListBySubscription ¶
func (c ConfidentialLedgerClient) LedgerListBySubscription(ctx context.Context, id commonids.SubscriptionId, options LedgerListBySubscriptionOperationOptions) (result LedgerListBySubscriptionOperationResponse, err error)
LedgerListBySubscription ...
func (ConfidentialLedgerClient) LedgerListBySubscriptionComplete ¶
func (c ConfidentialLedgerClient) LedgerListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options LedgerListBySubscriptionOperationOptions) (LedgerListBySubscriptionCompleteResult, error)
LedgerListBySubscriptionComplete retrieves all the results into a single object
func (ConfidentialLedgerClient) LedgerListBySubscriptionCompleteMatchingPredicate ¶
func (c ConfidentialLedgerClient) LedgerListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options LedgerListBySubscriptionOperationOptions, predicate ConfidentialLedgerOperationPredicate) (result LedgerListBySubscriptionCompleteResult, err error)
LedgerListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (ConfidentialLedgerClient) LedgerUpdate ¶
func (c ConfidentialLedgerClient) LedgerUpdate(ctx context.Context, id LedgerId, input ConfidentialLedger) (result LedgerUpdateOperationResponse, err error)
LedgerUpdate ...
func (ConfidentialLedgerClient) LedgerUpdateThenPoll ¶
func (c ConfidentialLedgerClient) LedgerUpdateThenPoll(ctx context.Context, id LedgerId, input ConfidentialLedger) error
LedgerUpdateThenPoll performs LedgerUpdate then polls until it's completed
type ConfidentialLedgerOperationPredicate ¶
type ConfidentialLedgerOperationPredicate struct { Id *string Location *string Name *string Type *string }
func (ConfidentialLedgerOperationPredicate) Matches ¶
func (p ConfidentialLedgerOperationPredicate) Matches(input ConfidentialLedger) bool
type LedgerGetOperationResponse ¶
type LedgerGetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *ConfidentialLedger }
type LedgerId ¶
LedgerId is a struct representing the Resource ID for a Ledger
func NewLedgerID ¶
NewLedgerID returns a new LedgerId struct
func ParseLedgerID ¶
ParseLedgerID parses 'input' into a LedgerId
func ParseLedgerIDInsensitively ¶
ParseLedgerIDInsensitively parses 'input' case-insensitively into a LedgerId note: this method should only be used for API response data and not user input
func (LedgerId) Segments ¶
func (id LedgerId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Ledger ID
type LedgerListByResourceGroupCompleteResult ¶
type LedgerListByResourceGroupCompleteResult struct {
Items []ConfidentialLedger
}
type LedgerListByResourceGroupOperationOptions ¶
type LedgerListByResourceGroupOperationOptions struct {
Filter *string
}
func DefaultLedgerListByResourceGroupOperationOptions ¶
func DefaultLedgerListByResourceGroupOperationOptions() LedgerListByResourceGroupOperationOptions
func (LedgerListByResourceGroupOperationOptions) ToHeaders ¶ added in v0.20230411.1183115
func (o LedgerListByResourceGroupOperationOptions) ToHeaders() *client.Headers
func (LedgerListByResourceGroupOperationOptions) ToOData ¶ added in v0.20230411.1183115
func (o LedgerListByResourceGroupOperationOptions) ToOData() *odata.Query
func (LedgerListByResourceGroupOperationOptions) ToQuery ¶ added in v0.20230411.1183115
func (o LedgerListByResourceGroupOperationOptions) ToQuery() *client.QueryParams
type LedgerListByResourceGroupOperationResponse ¶
type LedgerListByResourceGroupOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]ConfidentialLedger }
type LedgerListBySubscriptionCompleteResult ¶
type LedgerListBySubscriptionCompleteResult struct {
Items []ConfidentialLedger
}
type LedgerListBySubscriptionOperationOptions ¶
type LedgerListBySubscriptionOperationOptions struct {
Filter *string
}
func DefaultLedgerListBySubscriptionOperationOptions ¶
func DefaultLedgerListBySubscriptionOperationOptions() LedgerListBySubscriptionOperationOptions
func (LedgerListBySubscriptionOperationOptions) ToHeaders ¶ added in v0.20230411.1183115
func (o LedgerListBySubscriptionOperationOptions) ToHeaders() *client.Headers
func (LedgerListBySubscriptionOperationOptions) ToOData ¶ added in v0.20230411.1183115
func (o LedgerListBySubscriptionOperationOptions) ToOData() *odata.Query
func (LedgerListBySubscriptionOperationOptions) ToQuery ¶ added in v0.20230411.1183115
func (o LedgerListBySubscriptionOperationOptions) ToQuery() *client.QueryParams
type LedgerListBySubscriptionOperationResponse ¶
type LedgerListBySubscriptionOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]ConfidentialLedger }
type LedgerProperties ¶
type LedgerProperties struct { AadBasedSecurityPrincipals *[]AADBasedSecurityPrincipal `json:"aadBasedSecurityPrincipals,omitempty"` CertBasedSecurityPrincipals *[]CertBasedSecurityPrincipal `json:"certBasedSecurityPrincipals,omitempty"` IdentityServiceUri *string `json:"identityServiceUri,omitempty"` LedgerInternalNamespace *string `json:"ledgerInternalNamespace,omitempty"` LedgerName *string `json:"ledgerName,omitempty"` LedgerType *LedgerType `json:"ledgerType,omitempty"` LedgerUri *string `json:"ledgerUri,omitempty"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` }
type LedgerRoleName ¶
type LedgerRoleName string
const ( LedgerRoleNameAdministrator LedgerRoleName = "Administrator" LedgerRoleNameContributor LedgerRoleName = "Contributor" LedgerRoleNameReader LedgerRoleName = "Reader" )
func (*LedgerRoleName) UnmarshalJSON ¶ added in v0.20230411.1183115
func (s *LedgerRoleName) UnmarshalJSON(bytes []byte) error
type LedgerType ¶
type LedgerType string
const ( LedgerTypePrivate LedgerType = "Private" LedgerTypePublic LedgerType = "Public" LedgerTypeUnknown LedgerType = "Unknown" )
func (*LedgerType) UnmarshalJSON ¶ added in v0.20230411.1183115
func (s *LedgerType) UnmarshalJSON(bytes []byte) error
type ProvisioningState ¶
type ProvisioningState string
const ( ProvisioningStateCanceled ProvisioningState = "Canceled" ProvisioningStateCreating ProvisioningState = "Creating" ProvisioningStateDeleting ProvisioningState = "Deleting" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStateSucceeded ProvisioningState = "Succeeded" ProvisioningStateUnknown ProvisioningState = "Unknown" ProvisioningStateUpdating ProvisioningState = "Updating" )
func (*ProvisioningState) UnmarshalJSON ¶ added in v0.20230411.1183115
func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
Source Files ¶
- client.go
- constants.go
- id_ledger.go
- method_ledgercreate.go
- method_ledgerdelete.go
- method_ledgerget.go
- method_ledgerlistbyresourcegroup.go
- method_ledgerlistbysubscription.go
- method_ledgerupdate.go
- model_aadbasedsecurityprincipal.go
- model_certbasedsecurityprincipal.go
- model_confidentialledger.go
- model_ledgerproperties.go
- predicates.go
- version.go