keyvault

package
v40.4.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2020 License: Apache-2.0 Imports: 10 Imported by: 115

Documentation

Overview

Package keyvault implements the Azure ARM Keyvault service API version 2015-06-01.

The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Keyvault
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AccessPolicyEntry 

type AccessPolicyEntry struct {
	// TenantID - The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// ObjectID - The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.
	ObjectID *string `json:"objectId,omitempty"`
	// ApplicationID -  Application ID of the client making request on behalf of a principal
	ApplicationID *uuid.UUID `json:"applicationId,omitempty"`
	// Permissions - Permissions the identity has for keys, secrets and certificates.
	Permissions *Permissions `json:"permissions,omitempty"`
}

AccessPolicyEntry an identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Keyvault.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CertificatePermissions 

type CertificatePermissions string

CertificatePermissions enumerates the values for certificate permissions. 

const (
	// All ...
	All CertificatePermissions = "all"
	// Create ...
	Create CertificatePermissions = "create"
	// Delete ...
	Delete CertificatePermissions = "delete"
	// Deleteissuers ...
	Deleteissuers CertificatePermissions = "deleteissuers"
	// Get ...
	Get CertificatePermissions = "get"
	// Getissuers ...
	Getissuers CertificatePermissions = "getissuers"
	// Import ...
	Import CertificatePermissions = "import"
	// List ...
	List CertificatePermissions = "list"
	// Listissuers ...
	Listissuers CertificatePermissions = "listissuers"
	// Managecontacts ...
	Managecontacts CertificatePermissions = "managecontacts"
	// Manageissuers ...
	Manageissuers CertificatePermissions = "manageissuers"
	// Purge ...
	Purge CertificatePermissions = "purge"
	// Recover ...
	Recover CertificatePermissions = "recover"
	// Setissuers ...
	Setissuers CertificatePermissions = "setissuers"
	// Update ...
	Update CertificatePermissions = "update"
)

func PossibleCertificatePermissionsValues 

func PossibleCertificatePermissionsValues() []CertificatePermissions

PossibleCertificatePermissionsValues returns an array of possible values for the CertificatePermissions const type.

type KeyPermissions 

type KeyPermissions string

KeyPermissions enumerates the values for key permissions. 

const (
	// KeyPermissionsAll ...
	KeyPermissionsAll KeyPermissions = "all"
	// KeyPermissionsBackup ...
	KeyPermissionsBackup KeyPermissions = "backup"
	// KeyPermissionsCreate ...
	KeyPermissionsCreate KeyPermissions = "create"
	// KeyPermissionsDecrypt ...
	KeyPermissionsDecrypt KeyPermissions = "decrypt"
	// KeyPermissionsDelete ...
	KeyPermissionsDelete KeyPermissions = "delete"
	// KeyPermissionsEncrypt ...
	KeyPermissionsEncrypt KeyPermissions = "encrypt"
	// KeyPermissionsGet ...
	KeyPermissionsGet KeyPermissions = "get"
	// KeyPermissionsImport ...
	KeyPermissionsImport KeyPermissions = "import"
	// KeyPermissionsList ...
	KeyPermissionsList KeyPermissions = "list"
	// KeyPermissionsPurge ...
	KeyPermissionsPurge KeyPermissions = "purge"
	// KeyPermissionsRecover ...
	KeyPermissionsRecover KeyPermissions = "recover"
	// KeyPermissionsRestore ...
	KeyPermissionsRestore KeyPermissions = "restore"
	// KeyPermissionsSign ...
	KeyPermissionsSign KeyPermissions = "sign"
	// KeyPermissionsUnwrapKey ...
	KeyPermissionsUnwrapKey KeyPermissions = "unwrapKey"
	// KeyPermissionsUpdate ...
	KeyPermissionsUpdate KeyPermissions = "update"
	// KeyPermissionsVerify ...
	KeyPermissionsVerify KeyPermissions = "verify"
	// KeyPermissionsWrapKey ...
	KeyPermissionsWrapKey KeyPermissions = "wrapKey"
)

func PossibleKeyPermissionsValues 

func PossibleKeyPermissionsValues() []KeyPermissions

PossibleKeyPermissionsValues returns an array of possible values for the KeyPermissions const type.

type Permissions 

type Permissions struct {
	// Keys - Permissions to keys
	Keys *[]KeyPermissions `json:"keys,omitempty"`
	// Secrets - Permissions to secrets
	Secrets *[]SecretPermissions `json:"secrets,omitempty"`
	// Certificates - Permissions to certificates
	Certificates *[]CertificatePermissions `json:"certificates,omitempty"`
}

Permissions permissions the identity has for keys, secrets and certificates.

type Resource 

type Resource struct {
	// ID - READ-ONLY; The Azure Resource Manager resource ID for the key vault.
	ID *string `json:"id,omitempty"`
	// Name - The name of the key vault.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type of the key vault.
	Type *string `json:"type,omitempty"`
	// Location - The supported Azure location where the key vault should be created.
	Location *string `json:"location,omitempty"`
	// Tags - The tags that will be assigned to the key vault.
	Tags map[string]*string `json:"tags"`
}

Resource key Vault resource

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ResourceListResult 

type ResourceListResult struct {
	autorest.Response `json:"-"`
	// Value - Gets the list of vault resources.
	Value *[]Resource `json:"value,omitempty"`
	// NextLink - Gets the URL to get the next set of vault resources.
	NextLink *string `json:"nextLink,omitempty"`
}

ResourceListResult list of vault resources.

func (ResourceListResult) IsEmpty 

func (rlr ResourceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceListResultIterator 

type ResourceListResultIterator struct {
	// contains filtered or unexported fields
}

ResourceListResultIterator provides access to a complete listing of Resource values.

func NewResourceListResultIterator 

func NewResourceListResultIterator(page ResourceListResultPage) ResourceListResultIterator

Creates a new instance of the ResourceListResultIterator type.

func (*ResourceListResultIterator) Next 

func (iter *ResourceListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ResourceListResultIterator) NextWithContext 

func (iter *ResourceListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ResourceListResultIterator) NotDone 

func (iter ResourceListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ResourceListResultIterator) Response 

func (iter ResourceListResultIterator) Response() ResourceListResult

Response returns the raw server response from the last page request.

func (ResourceListResultIterator) Value 

func (iter ResourceListResultIterator) Value() Resource

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ResourceListResultPage 

type ResourceListResultPage struct {
	// contains filtered or unexported fields
}

ResourceListResultPage contains a page of Resource values.

func NewResourceListResultPage 

func NewResourceListResultPage(getNextPage func(context.Context, ResourceListResult) (ResourceListResult, error)) ResourceListResultPage

Creates a new instance of the ResourceListResultPage type.

func (*ResourceListResultPage) Next 

func (page *ResourceListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ResourceListResultPage) NextWithContext 

func (page *ResourceListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ResourceListResultPage) NotDone 

func (page ResourceListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ResourceListResultPage) Response 

func (page ResourceListResultPage) Response() ResourceListResult

Response returns the raw server response from the last page request.

func (ResourceListResultPage) Values 

func (page ResourceListResultPage) Values() []Resource

Values returns the slice of values for the current page or nil if there are no values.

type SecretPermissions 

type SecretPermissions string

SecretPermissions enumerates the values for secret permissions. 

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

func PossibleSecretPermissionsValues 

func PossibleSecretPermissionsValues() []SecretPermissions

PossibleSecretPermissionsValues returns an array of possible values for the SecretPermissions const type.

type Sku 

type Sku struct {
	// Family - SKU family name
	Family *string `json:"family,omitempty"`
	// Name - SKU name to specify whether the key vault is a standard vault or a premium vault. Possible values include: 'Standard', 'Premium'
	Name SkuName `json:"name,omitempty"`
}

Sku SKU details

type SkuName 

type SkuName string

SkuName enumerates the values for sku name. 

const (
	// Premium ...
	Premium SkuName = "premium"
	// Standard ...
	Standard SkuName = "standard"
)

func PossibleSkuNameValues 

func PossibleSkuNameValues() []SkuName

PossibleSkuNameValues returns an array of possible values for the SkuName const type.

type Vault 

type Vault struct {
	autorest.Response `json:"-"`
	// Properties - Properties of the vault
	Properties *VaultProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The Azure Resource Manager resource ID for the key vault.
	ID *string `json:"id,omitempty"`
	// Name - The name of the key vault.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type of the key vault.
	Type *string `json:"type,omitempty"`
	// Location - The supported Azure location where the key vault should be created.
	Location *string `json:"location,omitempty"`
	// Tags - The tags that will be assigned to the key vault.
	Tags map[string]*string `json:"tags"`
}

Vault resource information with extended details.

func (Vault) MarshalJSON 

func (vVar Vault) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Vault.

type VaultCreateOrUpdateParameters 

type VaultCreateOrUpdateParameters struct {
	// Location - The supported Azure location where the key vault should be created.
	Location *string `json:"location,omitempty"`
	// Tags - The tags that will be assigned to the key vault.
	Tags map[string]*string `json:"tags"`
	// Properties - Properties of the vault
	Properties *VaultProperties `json:"properties,omitempty"`
}

VaultCreateOrUpdateParameters parameters for creating or updating a vault

func (VaultCreateOrUpdateParameters) MarshalJSON 

func (vcoup VaultCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VaultCreateOrUpdateParameters.

type VaultListResult 

type VaultListResult struct {
	autorest.Response `json:"-"`
	// Value - Gets or sets the list of vaults.
	Value *[]Vault `json:"value,omitempty"`
	// NextLink - Gets or sets the URL to get the next set of vaults.
	NextLink *string `json:"nextLink,omitempty"`
}

VaultListResult list of vaults

func (VaultListResult) IsEmpty 

func (vlr VaultListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type VaultListResultIterator 

type VaultListResultIterator struct {
	// contains filtered or unexported fields
}

VaultListResultIterator provides access to a complete listing of Vault values.

func NewVaultListResultIterator 

func NewVaultListResultIterator(page VaultListResultPage) VaultListResultIterator

Creates a new instance of the VaultListResultIterator type.

func (*VaultListResultIterator) Next 

func (iter *VaultListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*VaultListResultIterator) NextWithContext 

func (iter *VaultListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (VaultListResultIterator) NotDone 

func (iter VaultListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (VaultListResultIterator) Response 

func (iter VaultListResultIterator) Response() VaultListResult

Response returns the raw server response from the last page request.

func (VaultListResultIterator) Value 

func (iter VaultListResultIterator) Value() Vault

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type VaultListResultPage 

type VaultListResultPage struct {
	// contains filtered or unexported fields
}

VaultListResultPage contains a page of Vault values.

func NewVaultListResultPage 

func NewVaultListResultPage(getNextPage func(context.Context, VaultListResult) (VaultListResult, error)) VaultListResultPage

Creates a new instance of the VaultListResultPage type.

func (*VaultListResultPage) Next 

func (page *VaultListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*VaultListResultPage) NextWithContext 

func (page *VaultListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (VaultListResultPage) NotDone 

func (page VaultListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (VaultListResultPage) Response 

func (page VaultListResultPage) Response() VaultListResult

Response returns the raw server response from the last page request.

func (VaultListResultPage) Values 

func (page VaultListResultPage) Values() []Vault

Values returns the slice of values for the current page or nil if there are no values.

type VaultProperties 

type VaultProperties struct {
	// VaultURI - The URI of the vault for performing operations on keys and secrets.
	VaultURI *string `json:"vaultUri,omitempty"`
	// TenantID - The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// Sku - SKU details
	Sku *Sku `json:"sku,omitempty"`
	// AccessPolicies - An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.
	AccessPolicies *[]AccessPolicyEntry `json:"accessPolicies,omitempty"`
	// EnabledForDeployment - Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
	EnabledForDeployment *bool `json:"enabledForDeployment,omitempty"`
	// EnabledForDiskEncryption - Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
	EnabledForDiskEncryption *bool `json:"enabledForDiskEncryption,omitempty"`
	// EnabledForTemplateDeployment - Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
	EnabledForTemplateDeployment *bool `json:"enabledForTemplateDeployment,omitempty"`
	// EnableSoftDelete - Property to specify whether the 'soft delete' functionality is enabled for this key vault.
	EnableSoftDelete *bool `json:"enableSoftDelete,omitempty"`
}

VaultProperties properties of the vault

type VaultsClient 

type VaultsClient struct {
	BaseClient
}

VaultsClient is the the Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

func NewVaultsClient 

func NewVaultsClient(subscriptionID string) VaultsClient

NewVaultsClient creates an instance of the VaultsClient client.

func NewVaultsClientWithBaseURI 

func NewVaultsClientWithBaseURI(baseURI string, subscriptionID string) VaultsClient

NewVaultsClientWithBaseURI creates an instance of the VaultsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (VaultsClient) CreateOrUpdate 

func (client VaultsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, vaultName string, parameters VaultCreateOrUpdateParameters) (result Vault, err error)

CreateOrUpdate create or update a key vault in the specified subscription. Parameters: resourceGroupName - the name of the Resource Group to which the server belongs. vaultName - name of the vault parameters - parameters to create or update the vault

func (VaultsClient) CreateOrUpdatePreparer 

func (client VaultsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, vaultName string, parameters VaultCreateOrUpdateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (VaultsClient) CreateOrUpdateResponder 

func (client VaultsClient) CreateOrUpdateResponder(resp *http.Response) (result Vault, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (VaultsClient) CreateOrUpdateSender 

func (client VaultsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (VaultsClient) Delete 

func (client VaultsClient) Delete(ctx context.Context, resourceGroupName string, vaultName string) (result autorest.Response, err error)

Delete deletes the specified Azure key vault. Parameters: resourceGroupName - the name of the Resource Group to which the vault belongs. vaultName - the name of the vault to delete

func (VaultsClient) DeletePreparer 

func (client VaultsClient) DeletePreparer(ctx context.Context, resourceGroupName string, vaultName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (VaultsClient) DeleteResponder 

func (client VaultsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (VaultsClient) DeleteSender 

func (client VaultsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (VaultsClient) Get 

func (client VaultsClient) Get(ctx context.Context, resourceGroupName string, vaultName string) (result Vault, err error)

Get gets the specified Azure key vault. Parameters: resourceGroupName - the name of the Resource Group to which the vault belongs. vaultName - the name of the vault.

func (VaultsClient) GetPreparer 

func (client VaultsClient) GetPreparer(ctx context.Context, resourceGroupName string, vaultName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (VaultsClient) GetResponder 

func (client VaultsClient) GetResponder(resp *http.Response) (result Vault, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (VaultsClient) GetSender 

func (client VaultsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (VaultsClient) List 

func (client VaultsClient) List(ctx context.Context, top *int32) (result ResourceListResultPage, err error)

List the List operation gets information about the vaults associated with the subscription. Parameters: top - maximum number of results to return.

func (VaultsClient) ListByResourceGroup 

func (client VaultsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, top *int32) (result VaultListResultPage, err error)

ListByResourceGroup the List operation gets information about the vaults associated with the subscription and within the specified resource group. Parameters: resourceGroupName - the name of the Resource Group to which the vault belongs. top - maximum number of results to return.

func (VaultsClient) ListByResourceGroupComplete 

func (client VaultsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, top *int32) (result VaultListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (VaultsClient) ListByResourceGroupPreparer 

func (client VaultsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, top *int32) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (VaultsClient) ListByResourceGroupResponder 

func (client VaultsClient) ListByResourceGroupResponder(resp *http.Response) (result VaultListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (VaultsClient) ListByResourceGroupSender 

func (client VaultsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (VaultsClient) ListComplete 

func (client VaultsClient) ListComplete(ctx context.Context, top *int32) (result ResourceListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (VaultsClient) ListPreparer 

func (client VaultsClient) ListPreparer(ctx context.Context, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (VaultsClient) ListResponder 

func (client VaultsClient) ListResponder(resp *http.Response) (result ResourceListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (VaultsClient) ListSender 

func (client VaultsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

Source Files

View all Source files

Directories

Path Synopsis

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.