vaults

package
v0.20230630.1064152 Latest Latest
Warning

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

Go to latest
Published: Jun 30, 2023 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/keyvault/2023-02-01/vaults Documentation

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

Client Initialization

client := vaults.NewVaultsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VaultsClient.CheckNameAvailability

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

payload := vaults.VaultCheckNameAvailabilityParameters{
	// ...
}


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

Example Usage: VaultsClient.CreateOrUpdate

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

payload := vaults.VaultCreateOrUpdateParameters{
	// ...
}


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

Example Usage: VaultsClient.Delete

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

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

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

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: VaultsClient.GetDeleted

ctx := context.TODO()
id := vaults.NewDeletedVaultID("12345678-1234-9876-4563-123456789012", "locationValue", "deletedVaultValue")

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

Example Usage: VaultsClient.List

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

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

Example Usage: VaultsClient.ListByResourceGroup

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

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

Example Usage: VaultsClient.ListBySubscription

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

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

Example Usage: VaultsClient.ListDeleted

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

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

Example Usage: VaultsClient.PurgeDeleted

ctx := context.TODO()
id := vaults.NewDeletedVaultID("12345678-1234-9876-4563-123456789012", "locationValue", "deletedVaultValue")

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

Example Usage: VaultsClient.Update

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

payload := vaults.VaultPatchParameters{
	// ...
}


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
}

Example Usage: VaultsClient.UpdateAccessPolicy

ctx := context.TODO()
id := vaults.NewOperationKindID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "add")

payload := vaults.VaultAccessPolicyParameters{
	// ...
}


read, err := client.UpdateAccessPolicy(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 PossibleValuesForAccessPolicyUpdateKind

func PossibleValuesForAccessPolicyUpdateKind() []string

func PossibleValuesForActionsRequired

func PossibleValuesForActionsRequired() []string

func PossibleValuesForCertificatePermissions

func PossibleValuesForCertificatePermissions() []string

func PossibleValuesForCreateMode

func PossibleValuesForCreateMode() []string

func PossibleValuesForKeyPermissions

func PossibleValuesForKeyPermissions() []string

func PossibleValuesForNetworkRuleAction

func PossibleValuesForNetworkRuleAction() []string

func PossibleValuesForNetworkRuleBypassOptions

func PossibleValuesForNetworkRuleBypassOptions() []string

func PossibleValuesForPrivateEndpointConnectionProvisioningState

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func PossibleValuesForReason

func PossibleValuesForReason() []string

func PossibleValuesForSecretPermissions

func PossibleValuesForSecretPermissions() []string

func PossibleValuesForSkuFamily

func PossibleValuesForSkuFamily() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func PossibleValuesForStoragePermissions

func PossibleValuesForStoragePermissions() []string

func PossibleValuesForType

func PossibleValuesForType() []string

func PossibleValuesForVaultListFilterTypes

func PossibleValuesForVaultListFilterTypes() []string

func PossibleValuesForVaultProvisioningState

func PossibleValuesForVaultProvisioningState() []string

func ValidateDeletedVaultID

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

ValidateDeletedVaultID checks that 'input' can be parsed as a Deleted Vault ID

func ValidateOperationKindID

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

ValidateOperationKindID checks that 'input' can be parsed as a Operation Kind ID

Types

type AccessPolicyEntry

type AccessPolicyEntry struct {
	ApplicationId *string     `json:"applicationId,omitempty"`
	ObjectId      string      `json:"objectId"`
	Permissions   Permissions `json:"permissions"`
	TenantId      string      `json:"tenantId"`
}

type AccessPolicyUpdateKind

type AccessPolicyUpdateKind string
const (
	AccessPolicyUpdateKindAdd     AccessPolicyUpdateKind = "add"
	AccessPolicyUpdateKindRemove  AccessPolicyUpdateKind = "remove"
	AccessPolicyUpdateKindReplace AccessPolicyUpdateKind = "replace"
)

type ActionsRequired

type ActionsRequired string
const (
	ActionsRequiredNone ActionsRequired = "None"
)

type CertificatePermissions

type CertificatePermissions string
const (
	CertificatePermissionsAll            CertificatePermissions = "all"
	CertificatePermissionsBackup         CertificatePermissions = "backup"
	CertificatePermissionsCreate         CertificatePermissions = "create"
	CertificatePermissionsDelete         CertificatePermissions = "delete"
	CertificatePermissionsDeleteissuers  CertificatePermissions = "deleteissuers"
	CertificatePermissionsGet            CertificatePermissions = "get"
	CertificatePermissionsGetissuers     CertificatePermissions = "getissuers"
	CertificatePermissionsImport         CertificatePermissions = "import"
	CertificatePermissionsList           CertificatePermissions = "list"
	CertificatePermissionsListissuers    CertificatePermissions = "listissuers"
	CertificatePermissionsManagecontacts CertificatePermissions = "managecontacts"
	CertificatePermissionsManageissuers  CertificatePermissions = "manageissuers"
	CertificatePermissionsPurge          CertificatePermissions = "purge"
	CertificatePermissionsRecover        CertificatePermissions = "recover"
	CertificatePermissionsRestore        CertificatePermissions = "restore"
	CertificatePermissionsSetissuers     CertificatePermissions = "setissuers"
	CertificatePermissionsUpdate         CertificatePermissions = "update"
)

type CheckNameAvailabilityOperationResponse

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	Model        *CheckNameAvailabilityResult
}

type CheckNameAvailabilityResult

type CheckNameAvailabilityResult struct {
	Message       *string `json:"message,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Reason        *Reason `json:"reason,omitempty"`
}

type CreateMode

type CreateMode string
const (
	CreateModeDefault CreateMode = "default"
	CreateModeRecover CreateMode = "recover"
)

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type DeletedVault

type DeletedVault struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *DeletedVaultProperties `json:"properties,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type DeletedVaultId

type DeletedVaultId struct {
	SubscriptionId   string
	LocationName     string
	DeletedVaultName string
}

DeletedVaultId is a struct representing the Resource ID for a Deleted Vault

func NewDeletedVaultID

func NewDeletedVaultID(subscriptionId string, locationName string, deletedVaultName string) DeletedVaultId

NewDeletedVaultID returns a new DeletedVaultId struct

func ParseDeletedVaultID

func ParseDeletedVaultID(input string) (*DeletedVaultId, error)

ParseDeletedVaultID parses 'input' into a DeletedVaultId

func ParseDeletedVaultIDInsensitively

func ParseDeletedVaultIDInsensitively(input string) (*DeletedVaultId, error)

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

func (DeletedVaultId) ID

func (id DeletedVaultId) ID() string

ID returns the formatted Deleted Vault ID

func (DeletedVaultId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Deleted Vault ID

func (DeletedVaultId) String

func (id DeletedVaultId) String() string

String returns a human-readable description of this Deleted Vault ID

type DeletedVaultOperationPredicate

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

func (DeletedVaultOperationPredicate) Matches

type DeletedVaultProperties

type DeletedVaultProperties struct {
	DeletionDate           *string            `json:"deletionDate,omitempty"`
	Location               *string            `json:"location,omitempty"`
	PurgeProtectionEnabled *bool              `json:"purgeProtectionEnabled,omitempty"`
	ScheduledPurgeDate     *string            `json:"scheduledPurgeDate,omitempty"`
	Tags                   *map[string]string `json:"tags,omitempty"`
	VaultId                *string            `json:"vaultId,omitempty"`
}

func (*DeletedVaultProperties) GetDeletionDateAsTime

func (o *DeletedVaultProperties) GetDeletionDateAsTime() (*time.Time, error)

func (*DeletedVaultProperties) GetScheduledPurgeDateAsTime

func (o *DeletedVaultProperties) GetScheduledPurgeDateAsTime() (*time.Time, error)

func (*DeletedVaultProperties) SetDeletionDateAsTime

func (o *DeletedVaultProperties) SetDeletionDateAsTime(input time.Time)

func (*DeletedVaultProperties) SetScheduledPurgeDateAsTime

func (o *DeletedVaultProperties) SetScheduledPurgeDateAsTime(input time.Time)

type GetDeletedOperationResponse

type GetDeletedOperationResponse struct {
	HttpResponse *http.Response
	Model        *DeletedVault
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *Vault
}

type IPRule

type IPRule struct {
	Value string `json:"value"`
}

type KeyPermissions

type KeyPermissions string
const (
	KeyPermissionsAll               KeyPermissions = "all"
	KeyPermissionsBackup            KeyPermissions = "backup"
	KeyPermissionsCreate            KeyPermissions = "create"
	KeyPermissionsDecrypt           KeyPermissions = "decrypt"
	KeyPermissionsDelete            KeyPermissions = "delete"
	KeyPermissionsEncrypt           KeyPermissions = "encrypt"
	KeyPermissionsGet               KeyPermissions = "get"
	KeyPermissionsGetrotationpolicy KeyPermissions = "getrotationpolicy"
	KeyPermissionsImport            KeyPermissions = "import"
	KeyPermissionsList              KeyPermissions = "list"
	KeyPermissionsPurge             KeyPermissions = "purge"
	KeyPermissionsRecover           KeyPermissions = "recover"
	KeyPermissionsRelease           KeyPermissions = "release"
	KeyPermissionsRestore           KeyPermissions = "restore"
	KeyPermissionsRotate            KeyPermissions = "rotate"
	KeyPermissionsSetrotationpolicy KeyPermissions = "setrotationpolicy"
	KeyPermissionsSign              KeyPermissions = "sign"
	KeyPermissionsUnwrapKey         KeyPermissions = "unwrapKey"
	KeyPermissionsUpdate            KeyPermissions = "update"
	KeyPermissionsVerify            KeyPermissions = "verify"
	KeyPermissionsWrapKey           KeyPermissions = "wrapKey"
)

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []Vault
}

type ListByResourceGroupOperationOptions

type ListByResourceGroupOperationOptions struct {
	Top *int64
}

func DefaultListByResourceGroupOperationOptions

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]Vault
	// contains filtered or unexported fields
}

func (ListByResourceGroupOperationResponse) HasMore

func (ListByResourceGroupOperationResponse) LoadMore

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []Vault
}

type ListBySubscriptionOperationOptions

type ListBySubscriptionOperationOptions struct {
	Top *int64
}

func DefaultListBySubscriptionOperationOptions

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]Vault
	// contains filtered or unexported fields
}

func (ListBySubscriptionOperationResponse) HasMore

func (ListBySubscriptionOperationResponse) LoadMore

type ListCompleteResult

type ListCompleteResult struct {
	Items []Resource
}

type ListDeletedCompleteResult

type ListDeletedCompleteResult struct {
	Items []DeletedVault
}

type ListDeletedOperationResponse

type ListDeletedOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]DeletedVault
	// contains filtered or unexported fields
}

func (ListDeletedOperationResponse) HasMore

func (r ListDeletedOperationResponse) HasMore() bool

func (ListDeletedOperationResponse) LoadMore

type ListOperationOptions

type ListOperationOptions struct {
	Filter *VaultListFilterTypes
	Top    *int64
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]Resource
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

type NetworkRuleAction

type NetworkRuleAction string
const (
	NetworkRuleActionAllow NetworkRuleAction = "Allow"
	NetworkRuleActionDeny  NetworkRuleAction = "Deny"
)

type NetworkRuleBypassOptions

type NetworkRuleBypassOptions string
const (
	NetworkRuleBypassOptionsAzureServices NetworkRuleBypassOptions = "AzureServices"
	NetworkRuleBypassOptionsNone          NetworkRuleBypassOptions = "None"
)

type NetworkRuleSet

type NetworkRuleSet struct {
	Bypass              *NetworkRuleBypassOptions `json:"bypass,omitempty"`
	DefaultAction       *NetworkRuleAction        `json:"defaultAction,omitempty"`
	IPRules             *[]IPRule                 `json:"ipRules,omitempty"`
	VirtualNetworkRules *[]VirtualNetworkRule     `json:"virtualNetworkRules,omitempty"`
}

type OperationKindId

type OperationKindId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
	OperationKind     AccessPolicyUpdateKind
}

OperationKindId is a struct representing the Resource ID for a Operation Kind

func NewOperationKindID

func NewOperationKindID(subscriptionId string, resourceGroupName string, vaultName string, operationKind AccessPolicyUpdateKind) OperationKindId

NewOperationKindID returns a new OperationKindId struct

func ParseOperationKindID

func ParseOperationKindID(input string) (*OperationKindId, error)

ParseOperationKindID parses 'input' into a OperationKindId

func ParseOperationKindIDInsensitively

func ParseOperationKindIDInsensitively(input string) (*OperationKindId, error)

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

func (OperationKindId) ID

func (id OperationKindId) ID() string

ID returns the formatted Operation Kind ID

func (OperationKindId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Operation Kind ID

func (OperationKindId) String

func (id OperationKindId) String() string

String returns a human-readable description of this Operation Kind ID

type Permissions

type Permissions struct {
	Certificates *[]CertificatePermissions `json:"certificates,omitempty"`
	Keys         *[]KeyPermissions         `json:"keys,omitempty"`
	Secrets      *[]SecretPermissions      `json:"secrets,omitempty"`
	Storage      *[]StoragePermissions     `json:"storage,omitempty"`
}

type PrivateEndpoint

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnectionItem

type PrivateEndpointConnectionItem struct {
	Etag       *string                              `json:"etag,omitempty"`
	Id         *string                              `json:"id,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
}

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState          `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateCreating     PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting     PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateDisconnected PrivateEndpointConnectionProvisioningState = "Disconnected"
	PrivateEndpointConnectionProvisioningStateFailed       PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded    PrivateEndpointConnectionProvisioningState = "Succeeded"
	PrivateEndpointConnectionProvisioningStateUpdating     PrivateEndpointConnectionProvisioningState = "Updating"
)

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string
const (
	PrivateEndpointServiceConnectionStatusApproved     PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusDisconnected PrivateEndpointServiceConnectionStatus = "Disconnected"
	PrivateEndpointServiceConnectionStatusPending      PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected     PrivateEndpointServiceConnectionStatus = "Rejected"
)

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *ActionsRequired                        `json:"actionsRequired,omitempty"`
	Description     *string                                 `json:"description,omitempty"`
	Status          *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

type PurgeDeletedOperationResponse

type PurgeDeletedOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type Reason

type Reason string
const (
	ReasonAccountNameInvalid Reason = "AccountNameInvalid"
	ReasonAlreadyExists      Reason = "AlreadyExists"
)

type Resource

type Resource struct {
	Id       *string            `json:"id,omitempty"`
	Location *string            `json:"location,omitempty"`
	Name     *string            `json:"name,omitempty"`
	Tags     *map[string]string `json:"tags,omitempty"`
	Type     *string            `json:"type,omitempty"`
}

type ResourceOperationPredicate

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

func (ResourceOperationPredicate) Matches

func (p ResourceOperationPredicate) Matches(input Resource) bool

type SecretPermissions

type SecretPermissions string
const (
	SecretPermissionsAll     SecretPermissions = "all"
	SecretPermissionsBackup  SecretPermissions = "backup"
	SecretPermissionsDelete  SecretPermissions = "delete"
	SecretPermissionsGet     SecretPermissions = "get"
	SecretPermissionsList    SecretPermissions = "list"
	SecretPermissionsPurge   SecretPermissions = "purge"
	SecretPermissionsRecover SecretPermissions = "recover"
	SecretPermissionsRestore SecretPermissions = "restore"
	SecretPermissionsSet     SecretPermissions = "set"
)

type Sku

type Sku struct {
	Family SkuFamily `json:"family"`
	Name   SkuName   `json:"name"`
}

type SkuFamily

type SkuFamily string
const (
	SkuFamilyA SkuFamily = "A"
)

type SkuName

type SkuName string
const (
	SkuNamePremium  SkuName = "premium"
	SkuNameStandard SkuName = "standard"
)

type StoragePermissions

type StoragePermissions string
const (
	StoragePermissionsAll           StoragePermissions = "all"
	StoragePermissionsBackup        StoragePermissions = "backup"
	StoragePermissionsDelete        StoragePermissions = "delete"
	StoragePermissionsDeletesas     StoragePermissions = "deletesas"
	StoragePermissionsGet           StoragePermissions = "get"
	StoragePermissionsGetsas        StoragePermissions = "getsas"
	StoragePermissionsList          StoragePermissions = "list"
	StoragePermissionsListsas       StoragePermissions = "listsas"
	StoragePermissionsPurge         StoragePermissions = "purge"
	StoragePermissionsRecover       StoragePermissions = "recover"
	StoragePermissionsRegeneratekey StoragePermissions = "regeneratekey"
	StoragePermissionsRestore       StoragePermissions = "restore"
	StoragePermissionsSet           StoragePermissions = "set"
	StoragePermissionsSetsas        StoragePermissions = "setsas"
	StoragePermissionsUpdate        StoragePermissions = "update"
)

type Type

type Type string
const (
	TypeMicrosoftPointKeyVaultVaults Type = "Microsoft.KeyVault/vaults"
)

type UpdateAccessPolicyOperationResponse

type UpdateAccessPolicyOperationResponse struct {
	HttpResponse *http.Response
	Model        *VaultAccessPolicyParameters
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *Vault
}

type Vault

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

type VaultAccessPolicyParameters

type VaultAccessPolicyParameters struct {
	Id         *string                     `json:"id,omitempty"`
	Location   *string                     `json:"location,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties VaultAccessPolicyProperties `json:"properties"`
	Type       *string                     `json:"type,omitempty"`
}

type VaultAccessPolicyProperties

type VaultAccessPolicyProperties struct {
	AccessPolicies []AccessPolicyEntry `json:"accessPolicies"`
}

type VaultCheckNameAvailabilityParameters

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

type VaultCreateOrUpdateParameters

type VaultCreateOrUpdateParameters struct {
	Location   string             `json:"location"`
	Properties VaultProperties    `json:"properties"`
	Tags       *map[string]string `json:"tags,omitempty"`
}

type VaultListFilterTypes

type VaultListFilterTypes string
const (
	VaultListFilterTypesResourceTypeEqMicrosoftPointKeyVaultVaults VaultListFilterTypes = "resourceType eq 'Microsoft.KeyVault/vaults'"
)

type VaultOperationPredicate

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

func (VaultOperationPredicate) Matches

func (p VaultOperationPredicate) Matches(input Vault) bool

type VaultPatchParameters

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

type VaultPatchProperties

type VaultPatchProperties struct {
	AccessPolicies               *[]AccessPolicyEntry `json:"accessPolicies,omitempty"`
	CreateMode                   *CreateMode          `json:"createMode,omitempty"`
	EnablePurgeProtection        *bool                `json:"enablePurgeProtection,omitempty"`
	EnableRbacAuthorization      *bool                `json:"enableRbacAuthorization,omitempty"`
	EnableSoftDelete             *bool                `json:"enableSoftDelete,omitempty"`
	EnabledForDeployment         *bool                `json:"enabledForDeployment,omitempty"`
	EnabledForDiskEncryption     *bool                `json:"enabledForDiskEncryption,omitempty"`
	EnabledForTemplateDeployment *bool                `json:"enabledForTemplateDeployment,omitempty"`
	NetworkAcls                  *NetworkRuleSet      `json:"networkAcls,omitempty"`
	PublicNetworkAccess          *string              `json:"publicNetworkAccess,omitempty"`
	Sku                          *Sku                 `json:"sku,omitempty"`
	SoftDeleteRetentionInDays    *int64               `json:"softDeleteRetentionInDays,omitempty"`
	TenantId                     *string              `json:"tenantId,omitempty"`
}

type VaultProperties

type VaultProperties struct {
	AccessPolicies               *[]AccessPolicyEntry             `json:"accessPolicies,omitempty"`
	CreateMode                   *CreateMode                      `json:"createMode,omitempty"`
	EnablePurgeProtection        *bool                            `json:"enablePurgeProtection,omitempty"`
	EnableRbacAuthorization      *bool                            `json:"enableRbacAuthorization,omitempty"`
	EnableSoftDelete             *bool                            `json:"enableSoftDelete,omitempty"`
	EnabledForDeployment         *bool                            `json:"enabledForDeployment,omitempty"`
	EnabledForDiskEncryption     *bool                            `json:"enabledForDiskEncryption,omitempty"`
	EnabledForTemplateDeployment *bool                            `json:"enabledForTemplateDeployment,omitempty"`
	HsmPoolResourceId            *string                          `json:"hsmPoolResourceId,omitempty"`
	NetworkAcls                  *NetworkRuleSet                  `json:"networkAcls,omitempty"`
	PrivateEndpointConnections   *[]PrivateEndpointConnectionItem `json:"privateEndpointConnections,omitempty"`
	ProvisioningState            *VaultProvisioningState          `json:"provisioningState,omitempty"`
	PublicNetworkAccess          *string                          `json:"publicNetworkAccess,omitempty"`
	Sku                          Sku                              `json:"sku"`
	SoftDeleteRetentionInDays    *int64                           `json:"softDeleteRetentionInDays,omitempty"`
	TenantId                     string                           `json:"tenantId"`
	VaultUri                     *string                          `json:"vaultUri,omitempty"`
}

type VaultProvisioningState

type VaultProvisioningState string
const (
	VaultProvisioningStateRegisteringDns VaultProvisioningState = "RegisteringDns"
	VaultProvisioningStateSucceeded      VaultProvisioningState = "Succeeded"
)

type VaultsClient

type VaultsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewVaultsClientWithBaseURI

func NewVaultsClientWithBaseURI(endpoint string) VaultsClient

func (VaultsClient) CheckNameAvailability

CheckNameAvailability ...

func (VaultsClient) CreateOrUpdate

CreateOrUpdate ...

func (VaultsClient) CreateOrUpdateThenPoll

func (c VaultsClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.KeyVaultId, input VaultCreateOrUpdateParameters) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (VaultsClient) Delete

Delete ...

func (VaultsClient) Get

Get ...

func (VaultsClient) GetDeleted

func (c VaultsClient) GetDeleted(ctx context.Context, id DeletedVaultId) (result GetDeletedOperationResponse, err error)

GetDeleted ...

func (VaultsClient) List

List ...

func (VaultsClient) ListByResourceGroup

ListByResourceGroup ...

func (VaultsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all of the results into a single object

func (VaultsClient) ListByResourceGroupCompleteMatchingPredicate

func (c VaultsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions, predicate VaultOperationPredicate) (resp ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (VaultsClient) ListBySubscription

ListBySubscription ...

func (VaultsClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all of the results into a single object

func (VaultsClient) ListBySubscriptionCompleteMatchingPredicate

func (c VaultsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions, predicate VaultOperationPredicate) (resp ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (VaultsClient) ListComplete

ListComplete retrieves all of the results into a single object

func (VaultsClient) ListCompleteMatchingPredicate

func (c VaultsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate ResourceOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (VaultsClient) ListDeleted

ListDeleted ...

func (VaultsClient) ListDeletedComplete

ListDeletedComplete retrieves all of the results into a single object

func (VaultsClient) ListDeletedCompleteMatchingPredicate

func (c VaultsClient) ListDeletedCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DeletedVaultOperationPredicate) (resp ListDeletedCompleteResult, err error)

ListDeletedCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (VaultsClient) PurgeDeleted

func (c VaultsClient) PurgeDeleted(ctx context.Context, id DeletedVaultId) (result PurgeDeletedOperationResponse, err error)

PurgeDeleted ...

func (VaultsClient) PurgeDeletedThenPoll

func (c VaultsClient) PurgeDeletedThenPoll(ctx context.Context, id DeletedVaultId) error

PurgeDeletedThenPoll performs PurgeDeleted then polls until it's completed

func (VaultsClient) Update

Update ...

func (VaultsClient) UpdateAccessPolicy

UpdateAccessPolicy ...

type VirtualNetworkRule

type VirtualNetworkRule struct {
	Id                               string `json:"id"`
	IgnoreMissingVnetServiceEndpoint *bool  `json:"ignoreMissingVnetServiceEndpoint,omitempty"`
}

Jump to

Keyboard shortcuts

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