azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/keyvault/v7.0/keyvault Index | Files | Directories

package keyvault

import "github.com/Azure/azure-sdk-for-go/services/keyvault/v7.0/keyvault"

Package keyvault implements the Azure ARM Keyvault service API version 7.0.

The key vault client performs cryptographic key operations and vault operations against the Key Vault service.

Index

Package Files

client.go models.go version.go

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type Action Uses

type Action struct {
    // ActionType - The type of the action. Possible values include: 'EmailContacts', 'AutoRenew'
    ActionType ActionType `json:"action_type,omitempty"`
}

Action the action that will be executed.

type ActionType Uses

type ActionType string

ActionType enumerates the values for action type.

const (
    // AutoRenew ...
    AutoRenew ActionType = "AutoRenew"
    // EmailContacts ...
    EmailContacts ActionType = "EmailContacts"
)

func PossibleActionTypeValues Uses

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns an array of possible values for the ActionType const type.

type AdministratorDetails Uses

type AdministratorDetails struct {
    // FirstName - First name.
    FirstName *string `json:"first_name,omitempty"`
    // LastName - Last name.
    LastName *string `json:"last_name,omitempty"`
    // EmailAddress - Email address.
    EmailAddress *string `json:"email,omitempty"`
    // Phone - Phone number.
    Phone *string `json:"phone,omitempty"`
}

AdministratorDetails details of the organization administrator of the certificate issuer.

type Attributes Uses

type Attributes struct {
    // Enabled - Determines whether the object is enabled.
    Enabled *bool `json:"enabled,omitempty"`
    // NotBefore - Not before date in UTC.
    NotBefore *date.UnixTime `json:"nbf,omitempty"`
    // Expires - Expiry date in UTC.
    Expires *date.UnixTime `json:"exp,omitempty"`
    // Created - READ-ONLY; Creation time in UTC.
    Created *date.UnixTime `json:"created,omitempty"`
    // Updated - READ-ONLY; Last updated time in UTC.
    Updated *date.UnixTime `json:"updated,omitempty"`
}

Attributes the object attributes managed by the KeyVault service.

type BackupCertificateResult Uses

type BackupCertificateResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The backup blob containing the backed up certificate. (a URL-encoded base64 string)
    Value *string `json:"value,omitempty"`
}

BackupCertificateResult the backup certificate result, containing the backup blob.

type BackupKeyResult Uses

type BackupKeyResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The backup blob containing the backed up key. (a URL-encoded base64 string)
    Value *string `json:"value,omitempty"`
}

BackupKeyResult the backup key result, containing the backup blob.

type BackupSecretResult Uses

type BackupSecretResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The backup blob containing the backed up secret. (a URL-encoded base64 string)
    Value *string `json:"value,omitempty"`
}

BackupSecretResult the backup secret result, containing the backup blob.

type BackupStorageResult Uses

type BackupStorageResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The backup blob containing the backed up storage account. (a URL-encoded base64 string)
    Value *string `json:"value,omitempty"`
}

BackupStorageResult the backup storage result, containing the backup blob.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
}

BaseClient is the base client for Keyvault.

func New Uses

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults Uses

func NewWithoutDefaults() BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

func (BaseClient) BackupCertificate Uses

func (client BaseClient) BackupCertificate(ctx context.Context, vaultBaseURL string, certificateName string) (result BackupCertificateResult, err error)

BackupCertificate requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate.

func (BaseClient) BackupCertificatePreparer Uses

func (client BaseClient) BackupCertificatePreparer(ctx context.Context, vaultBaseURL string, certificateName string) (*http.Request, error)

BackupCertificatePreparer prepares the BackupCertificate request.

func (BaseClient) BackupCertificateResponder Uses

func (client BaseClient) BackupCertificateResponder(resp *http.Response) (result BackupCertificateResult, err error)

BackupCertificateResponder handles the response to the BackupCertificate request. The method always closes the http.Response Body.

func (BaseClient) BackupCertificateSender Uses

func (client BaseClient) BackupCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) BackupKey Uses

func (client BaseClient) BackupKey(ctx context.Context, vaultBaseURL string, keyName string) (result BackupKeyResult, err error)

BackupKey the Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation requires the key/backup permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key.

func (BaseClient) BackupKeyPreparer Uses

func (client BaseClient) BackupKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string) (*http.Request, error)

BackupKeyPreparer prepares the BackupKey request.

func (BaseClient) BackupKeyResponder Uses

func (client BaseClient) BackupKeyResponder(resp *http.Response) (result BackupKeyResult, err error)

BackupKeyResponder handles the response to the BackupKey request. The method always closes the http.Response Body.

func (BaseClient) BackupKeySender Uses

func (client BaseClient) BackupKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) BackupSecret Uses

func (client BaseClient) BackupSecret(ctx context.Context, vaultBaseURL string, secretName string) (result BackupSecretResult, err error)

BackupSecret requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. secretName - the name of the secret.

func (BaseClient) BackupSecretPreparer Uses

func (client BaseClient) BackupSecretPreparer(ctx context.Context, vaultBaseURL string, secretName string) (*http.Request, error)

BackupSecretPreparer prepares the BackupSecret request.

func (BaseClient) BackupSecretResponder Uses

func (client BaseClient) BackupSecretResponder(resp *http.Response) (result BackupSecretResult, err error)

BackupSecretResponder handles the response to the BackupSecret request. The method always closes the http.Response Body.

func (BaseClient) BackupSecretSender Uses

func (client BaseClient) BackupSecretSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) BackupStorageAccount Uses

func (client BaseClient) BackupStorageAccount(ctx context.Context, vaultBaseURL string, storageAccountName string) (result BackupStorageResult, err error)

BackupStorageAccount requests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account.

func (BaseClient) BackupStorageAccountPreparer Uses

func (client BaseClient) BackupStorageAccountPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string) (*http.Request, error)

BackupStorageAccountPreparer prepares the BackupStorageAccount request.

func (BaseClient) BackupStorageAccountResponder Uses

func (client BaseClient) BackupStorageAccountResponder(resp *http.Response) (result BackupStorageResult, err error)

BackupStorageAccountResponder handles the response to the BackupStorageAccount request. The method always closes the http.Response Body.

func (BaseClient) BackupStorageAccountSender Uses

func (client BaseClient) BackupStorageAccountSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) CreateCertificate Uses

func (client BaseClient) CreateCertificate(ctx context.Context, vaultBaseURL string, certificateName string, parameters CertificateCreateParameters) (result CertificateOperation, err error)

CreateCertificate if this is the first version, the certificate resource is created. This operation requires the certificates/create permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate. parameters - the parameters to create a certificate.

func (BaseClient) CreateCertificatePreparer Uses

func (client BaseClient) CreateCertificatePreparer(ctx context.Context, vaultBaseURL string, certificateName string, parameters CertificateCreateParameters) (*http.Request, error)

CreateCertificatePreparer prepares the CreateCertificate request.

func (BaseClient) CreateCertificateResponder Uses

func (client BaseClient) CreateCertificateResponder(resp *http.Response) (result CertificateOperation, err error)

CreateCertificateResponder handles the response to the CreateCertificate request. The method always closes the http.Response Body.

func (BaseClient) CreateCertificateSender Uses

func (client BaseClient) CreateCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) CreateKey Uses

func (client BaseClient) CreateKey(ctx context.Context, vaultBaseURL string, keyName string, parameters KeyCreateParameters) (result KeyBundle, err error)

CreateKey the create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name for the new key. The system will generate the version name for the new key. parameters - the parameters to create a key.

func (BaseClient) CreateKeyPreparer Uses

func (client BaseClient) CreateKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string, parameters KeyCreateParameters) (*http.Request, error)

CreateKeyPreparer prepares the CreateKey request.

func (BaseClient) CreateKeyResponder Uses

func (client BaseClient) CreateKeyResponder(resp *http.Response) (result KeyBundle, err error)

CreateKeyResponder handles the response to the CreateKey request. The method always closes the http.Response Body.

func (BaseClient) CreateKeySender Uses

func (client BaseClient) CreateKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) Decrypt Uses

func (client BaseClient) Decrypt(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyOperationsParameters) (result KeyOperationResult, err error)

Decrypt the DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/decrypt permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key. keyVersion - the version of the key. parameters - the parameters for the decryption operation.

func (BaseClient) DecryptPreparer Uses

func (client BaseClient) DecryptPreparer(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyOperationsParameters) (*http.Request, error)

DecryptPreparer prepares the Decrypt request.

func (BaseClient) DecryptResponder Uses

func (client BaseClient) DecryptResponder(resp *http.Response) (result KeyOperationResult, err error)

DecryptResponder handles the response to the Decrypt request. The method always closes the http.Response Body.

func (BaseClient) DecryptSender Uses

func (client BaseClient) DecryptSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) DeleteCertificate Uses

func (client BaseClient) DeleteCertificate(ctx context.Context, vaultBaseURL string, certificateName string) (result DeletedCertificateBundle, err error)

DeleteCertificate deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate.

func (BaseClient) DeleteCertificateContacts Uses

func (client BaseClient) DeleteCertificateContacts(ctx context.Context, vaultBaseURL string) (result Contacts, err error)

DeleteCertificateContacts deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net.

func (BaseClient) DeleteCertificateContactsPreparer Uses

func (client BaseClient) DeleteCertificateContactsPreparer(ctx context.Context, vaultBaseURL string) (*http.Request, error)

DeleteCertificateContactsPreparer prepares the DeleteCertificateContacts request.

func (BaseClient) DeleteCertificateContactsResponder Uses

func (client BaseClient) DeleteCertificateContactsResponder(resp *http.Response) (result Contacts, err error)

DeleteCertificateContactsResponder handles the response to the DeleteCertificateContacts request. The method always closes the http.Response Body.

func (BaseClient) DeleteCertificateContactsSender Uses

func (client BaseClient) DeleteCertificateContactsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) DeleteCertificateIssuer Uses

func (client BaseClient) DeleteCertificateIssuer(ctx context.Context, vaultBaseURL string, issuerName string) (result IssuerBundle, err error)

DeleteCertificateIssuer the DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. issuerName - the name of the issuer.

func (BaseClient) DeleteCertificateIssuerPreparer Uses

func (client BaseClient) DeleteCertificateIssuerPreparer(ctx context.Context, vaultBaseURL string, issuerName string) (*http.Request, error)

DeleteCertificateIssuerPreparer prepares the DeleteCertificateIssuer request.

func (BaseClient) DeleteCertificateIssuerResponder Uses

func (client BaseClient) DeleteCertificateIssuerResponder(resp *http.Response) (result IssuerBundle, err error)

DeleteCertificateIssuerResponder handles the response to the DeleteCertificateIssuer request. The method always closes the http.Response Body.

func (BaseClient) DeleteCertificateIssuerSender Uses

func (client BaseClient) DeleteCertificateIssuerSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) DeleteCertificateOperation Uses

func (client BaseClient) DeleteCertificateOperation(ctx context.Context, vaultBaseURL string, certificateName string) (result CertificateOperation, err error)

DeleteCertificateOperation deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate.

func (BaseClient) DeleteCertificateOperationPreparer Uses

func (client BaseClient) DeleteCertificateOperationPreparer(ctx context.Context, vaultBaseURL string, certificateName string) (*http.Request, error)

DeleteCertificateOperationPreparer prepares the DeleteCertificateOperation request.

func (BaseClient) DeleteCertificateOperationResponder Uses

func (client BaseClient) DeleteCertificateOperationResponder(resp *http.Response) (result CertificateOperation, err error)

DeleteCertificateOperationResponder handles the response to the DeleteCertificateOperation request. The method always closes the http.Response Body.

func (BaseClient) DeleteCertificateOperationSender Uses

func (client BaseClient) DeleteCertificateOperationSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) DeleteCertificatePreparer Uses

func (client BaseClient) DeleteCertificatePreparer(ctx context.Context, vaultBaseURL string, certificateName string) (*http.Request, error)

DeleteCertificatePreparer prepares the DeleteCertificate request.

func (BaseClient) DeleteCertificateResponder Uses

func (client BaseClient) DeleteCertificateResponder(resp *http.Response) (result DeletedCertificateBundle, err error)

DeleteCertificateResponder handles the response to the DeleteCertificate request. The method always closes the http.Response Body.

func (BaseClient) DeleteCertificateSender Uses

func (client BaseClient) DeleteCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) DeleteKey Uses

func (client BaseClient) DeleteKey(ctx context.Context, vaultBaseURL string, keyName string) (result DeletedKeyBundle, err error)

DeleteKey the delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the keys/delete permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key to delete.

func (BaseClient) DeleteKeyPreparer Uses

func (client BaseClient) DeleteKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string) (*http.Request, error)

DeleteKeyPreparer prepares the DeleteKey request.

func (BaseClient) DeleteKeyResponder Uses

func (client BaseClient) DeleteKeyResponder(resp *http.Response) (result DeletedKeyBundle, err error)

DeleteKeyResponder handles the response to the DeleteKey request. The method always closes the http.Response Body.

func (BaseClient) DeleteKeySender Uses

func (client BaseClient) DeleteKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) DeleteSasDefinition Uses

func (client BaseClient) DeleteSasDefinition(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string) (result DeletedSasDefinitionBundle, err error)

DeleteSasDefinition deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. sasDefinitionName - the name of the SAS definition.

func (BaseClient) DeleteSasDefinitionPreparer Uses

func (client BaseClient) DeleteSasDefinitionPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string) (*http.Request, error)

DeleteSasDefinitionPreparer prepares the DeleteSasDefinition request.

func (BaseClient) DeleteSasDefinitionResponder Uses

func (client BaseClient) DeleteSasDefinitionResponder(resp *http.Response) (result DeletedSasDefinitionBundle, err error)

DeleteSasDefinitionResponder handles the response to the DeleteSasDefinition request. The method always closes the http.Response Body.

func (BaseClient) DeleteSasDefinitionSender Uses

func (client BaseClient) DeleteSasDefinitionSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) DeleteSecret Uses

func (client BaseClient) DeleteSecret(ctx context.Context, vaultBaseURL string, secretName string) (result DeletedSecretBundle, err error)

DeleteSecret the DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. secretName - the name of the secret.

func (BaseClient) DeleteSecretPreparer Uses

func (client BaseClient) DeleteSecretPreparer(ctx context.Context, vaultBaseURL string, secretName string) (*http.Request, error)

DeleteSecretPreparer prepares the DeleteSecret request.

func (BaseClient) DeleteSecretResponder Uses

func (client BaseClient) DeleteSecretResponder(resp *http.Response) (result DeletedSecretBundle, err error)

DeleteSecretResponder handles the response to the DeleteSecret request. The method always closes the http.Response Body.

func (BaseClient) DeleteSecretSender Uses

func (client BaseClient) DeleteSecretSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) DeleteStorageAccount Uses

func (client BaseClient) DeleteStorageAccount(ctx context.Context, vaultBaseURL string, storageAccountName string) (result DeletedStorageBundle, err error)

DeleteStorageAccount deletes a storage account. This operation requires the storage/delete permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account.

func (BaseClient) DeleteStorageAccountPreparer Uses

func (client BaseClient) DeleteStorageAccountPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string) (*http.Request, error)

DeleteStorageAccountPreparer prepares the DeleteStorageAccount request.

func (BaseClient) DeleteStorageAccountResponder Uses

func (client BaseClient) DeleteStorageAccountResponder(resp *http.Response) (result DeletedStorageBundle, err error)

DeleteStorageAccountResponder handles the response to the DeleteStorageAccount request. The method always closes the http.Response Body.

func (BaseClient) DeleteStorageAccountSender Uses

func (client BaseClient) DeleteStorageAccountSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) Encrypt Uses

func (client BaseClient) Encrypt(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyOperationsParameters) (result KeyOperationResult, err error)

Encrypt the ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key. keyVersion - the version of the key. parameters - the parameters for the encryption operation.

func (BaseClient) EncryptPreparer Uses

func (client BaseClient) EncryptPreparer(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyOperationsParameters) (*http.Request, error)

EncryptPreparer prepares the Encrypt request.

func (BaseClient) EncryptResponder Uses

func (client BaseClient) EncryptResponder(resp *http.Response) (result KeyOperationResult, err error)

EncryptResponder handles the response to the Encrypt request. The method always closes the http.Response Body.

func (BaseClient) EncryptSender Uses

func (client BaseClient) EncryptSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetCertificate Uses

func (client BaseClient) GetCertificate(ctx context.Context, vaultBaseURL string, certificateName string, certificateVersion string) (result CertificateBundle, err error)

GetCertificate gets information about a specific certificate. This operation requires the certificates/get permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate in the given vault. certificateVersion - the version of the certificate.

func (BaseClient) GetCertificateContacts Uses

func (client BaseClient) GetCertificateContacts(ctx context.Context, vaultBaseURL string) (result Contacts, err error)

GetCertificateContacts the GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net.

func (BaseClient) GetCertificateContactsPreparer Uses

func (client BaseClient) GetCertificateContactsPreparer(ctx context.Context, vaultBaseURL string) (*http.Request, error)

GetCertificateContactsPreparer prepares the GetCertificateContacts request.

func (BaseClient) GetCertificateContactsResponder Uses

func (client BaseClient) GetCertificateContactsResponder(resp *http.Response) (result Contacts, err error)

GetCertificateContactsResponder handles the response to the GetCertificateContacts request. The method always closes the http.Response Body.

func (BaseClient) GetCertificateContactsSender Uses

func (client BaseClient) GetCertificateContactsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetCertificateIssuer Uses

func (client BaseClient) GetCertificateIssuer(ctx context.Context, vaultBaseURL string, issuerName string) (result IssuerBundle, err error)

GetCertificateIssuer the GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. issuerName - the name of the issuer.

func (BaseClient) GetCertificateIssuerPreparer Uses

func (client BaseClient) GetCertificateIssuerPreparer(ctx context.Context, vaultBaseURL string, issuerName string) (*http.Request, error)

GetCertificateIssuerPreparer prepares the GetCertificateIssuer request.

func (BaseClient) GetCertificateIssuerResponder Uses

func (client BaseClient) GetCertificateIssuerResponder(resp *http.Response) (result IssuerBundle, err error)

GetCertificateIssuerResponder handles the response to the GetCertificateIssuer request. The method always closes the http.Response Body.

func (BaseClient) GetCertificateIssuerSender Uses

func (client BaseClient) GetCertificateIssuerSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetCertificateIssuers Uses

func (client BaseClient) GetCertificateIssuers(ctx context.Context, vaultBaseURL string, maxresults *int32) (result CertificateIssuerListResultPage, err error)

GetCertificateIssuers the GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results.

func (BaseClient) GetCertificateIssuersComplete Uses

func (client BaseClient) GetCertificateIssuersComplete(ctx context.Context, vaultBaseURL string, maxresults *int32) (result CertificateIssuerListResultIterator, err error)

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

func (BaseClient) GetCertificateIssuersPreparer Uses

func (client BaseClient) GetCertificateIssuersPreparer(ctx context.Context, vaultBaseURL string, maxresults *int32) (*http.Request, error)

GetCertificateIssuersPreparer prepares the GetCertificateIssuers request.

func (BaseClient) GetCertificateIssuersResponder Uses

func (client BaseClient) GetCertificateIssuersResponder(resp *http.Response) (result CertificateIssuerListResult, err error)

GetCertificateIssuersResponder handles the response to the GetCertificateIssuers request. The method always closes the http.Response Body.

func (BaseClient) GetCertificateIssuersSender Uses

func (client BaseClient) GetCertificateIssuersSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetCertificateOperation Uses

func (client BaseClient) GetCertificateOperation(ctx context.Context, vaultBaseURL string, certificateName string) (result CertificateOperation, err error)

GetCertificateOperation gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate.

func (BaseClient) GetCertificateOperationPreparer Uses

func (client BaseClient) GetCertificateOperationPreparer(ctx context.Context, vaultBaseURL string, certificateName string) (*http.Request, error)

GetCertificateOperationPreparer prepares the GetCertificateOperation request.

func (BaseClient) GetCertificateOperationResponder Uses

func (client BaseClient) GetCertificateOperationResponder(resp *http.Response) (result CertificateOperation, err error)

GetCertificateOperationResponder handles the response to the GetCertificateOperation request. The method always closes the http.Response Body.

func (BaseClient) GetCertificateOperationSender Uses

func (client BaseClient) GetCertificateOperationSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetCertificatePolicy Uses

func (client BaseClient) GetCertificatePolicy(ctx context.Context, vaultBaseURL string, certificateName string) (result CertificatePolicy, err error)

GetCertificatePolicy the GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate in a given key vault.

func (BaseClient) GetCertificatePolicyPreparer Uses

func (client BaseClient) GetCertificatePolicyPreparer(ctx context.Context, vaultBaseURL string, certificateName string) (*http.Request, error)

GetCertificatePolicyPreparer prepares the GetCertificatePolicy request.

func (BaseClient) GetCertificatePolicyResponder Uses

func (client BaseClient) GetCertificatePolicyResponder(resp *http.Response) (result CertificatePolicy, err error)

GetCertificatePolicyResponder handles the response to the GetCertificatePolicy request. The method always closes the http.Response Body.

func (BaseClient) GetCertificatePolicySender Uses

func (client BaseClient) GetCertificatePolicySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetCertificatePreparer Uses

func (client BaseClient) GetCertificatePreparer(ctx context.Context, vaultBaseURL string, certificateName string, certificateVersion string) (*http.Request, error)

GetCertificatePreparer prepares the GetCertificate request.

func (BaseClient) GetCertificateResponder Uses

func (client BaseClient) GetCertificateResponder(resp *http.Response) (result CertificateBundle, err error)

GetCertificateResponder handles the response to the GetCertificate request. The method always closes the http.Response Body.

func (BaseClient) GetCertificateSender Uses

func (client BaseClient) GetCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetCertificateVersions Uses

func (client BaseClient) GetCertificateVersions(ctx context.Context, vaultBaseURL string, certificateName string, maxresults *int32) (result CertificateListResultPage, err error)

GetCertificateVersions the GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results.

func (BaseClient) GetCertificateVersionsComplete Uses

func (client BaseClient) GetCertificateVersionsComplete(ctx context.Context, vaultBaseURL string, certificateName string, maxresults *int32) (result CertificateListResultIterator, err error)

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

func (BaseClient) GetCertificateVersionsPreparer Uses

func (client BaseClient) GetCertificateVersionsPreparer(ctx context.Context, vaultBaseURL string, certificateName string, maxresults *int32) (*http.Request, error)

GetCertificateVersionsPreparer prepares the GetCertificateVersions request.

func (BaseClient) GetCertificateVersionsResponder Uses

func (client BaseClient) GetCertificateVersionsResponder(resp *http.Response) (result CertificateListResult, err error)

GetCertificateVersionsResponder handles the response to the GetCertificateVersions request. The method always closes the http.Response Body.

func (BaseClient) GetCertificateVersionsSender Uses

func (client BaseClient) GetCertificateVersionsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetCertificates Uses

func (client BaseClient) GetCertificates(ctx context.Context, vaultBaseURL string, maxresults *int32, includePending *bool) (result CertificateListResultPage, err error)

GetCertificates the GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results. includePending - specifies whether to include certificates which are not completely provisioned.

func (BaseClient) GetCertificatesComplete Uses

func (client BaseClient) GetCertificatesComplete(ctx context.Context, vaultBaseURL string, maxresults *int32, includePending *bool) (result CertificateListResultIterator, err error)

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

func (BaseClient) GetCertificatesPreparer Uses

func (client BaseClient) GetCertificatesPreparer(ctx context.Context, vaultBaseURL string, maxresults *int32, includePending *bool) (*http.Request, error)

GetCertificatesPreparer prepares the GetCertificates request.

func (BaseClient) GetCertificatesResponder Uses

func (client BaseClient) GetCertificatesResponder(resp *http.Response) (result CertificateListResult, err error)

GetCertificatesResponder handles the response to the GetCertificates request. The method always closes the http.Response Body.

func (BaseClient) GetCertificatesSender Uses

func (client BaseClient) GetCertificatesSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetDeletedCertificate Uses

func (client BaseClient) GetDeletedCertificate(ctx context.Context, vaultBaseURL string, certificateName string) (result DeletedCertificateBundle, err error)

GetDeletedCertificate the GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the certificates/get permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate

func (BaseClient) GetDeletedCertificatePreparer Uses

func (client BaseClient) GetDeletedCertificatePreparer(ctx context.Context, vaultBaseURL string, certificateName string) (*http.Request, error)

GetDeletedCertificatePreparer prepares the GetDeletedCertificate request.

func (BaseClient) GetDeletedCertificateResponder Uses

func (client BaseClient) GetDeletedCertificateResponder(resp *http.Response) (result DeletedCertificateBundle, err error)

GetDeletedCertificateResponder handles the response to the GetDeletedCertificate request. The method always closes the http.Response Body.

func (BaseClient) GetDeletedCertificateSender Uses

func (client BaseClient) GetDeletedCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetDeletedCertificates Uses

func (client BaseClient) GetDeletedCertificates(ctx context.Context, vaultBaseURL string, maxresults *int32, includePending *bool) (result DeletedCertificateListResultPage, err error)

GetDeletedCertificates the GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results. includePending - specifies whether to include certificates which are not completely provisioned.

func (BaseClient) GetDeletedCertificatesComplete Uses

func (client BaseClient) GetDeletedCertificatesComplete(ctx context.Context, vaultBaseURL string, maxresults *int32, includePending *bool) (result DeletedCertificateListResultIterator, err error)

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

func (BaseClient) GetDeletedCertificatesPreparer Uses

func (client BaseClient) GetDeletedCertificatesPreparer(ctx context.Context, vaultBaseURL string, maxresults *int32, includePending *bool) (*http.Request, error)

GetDeletedCertificatesPreparer prepares the GetDeletedCertificates request.

func (BaseClient) GetDeletedCertificatesResponder Uses

func (client BaseClient) GetDeletedCertificatesResponder(resp *http.Response) (result DeletedCertificateListResult, err error)

GetDeletedCertificatesResponder handles the response to the GetDeletedCertificates request. The method always closes the http.Response Body.

func (BaseClient) GetDeletedCertificatesSender Uses

func (client BaseClient) GetDeletedCertificatesSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetDeletedKey Uses

func (client BaseClient) GetDeletedKey(ctx context.Context, vaultBaseURL string, keyName string) (result DeletedKeyBundle, err error)

GetDeletedKey the Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/get permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key.

func (BaseClient) GetDeletedKeyPreparer Uses

func (client BaseClient) GetDeletedKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string) (*http.Request, error)

GetDeletedKeyPreparer prepares the GetDeletedKey request.

func (BaseClient) GetDeletedKeyResponder Uses

func (client BaseClient) GetDeletedKeyResponder(resp *http.Response) (result DeletedKeyBundle, err error)

GetDeletedKeyResponder handles the response to the GetDeletedKey request. The method always closes the http.Response Body.

func (BaseClient) GetDeletedKeySender Uses

func (client BaseClient) GetDeletedKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetDeletedKeys Uses

func (client BaseClient) GetDeletedKeys(ctx context.Context, vaultBaseURL string, maxresults *int32) (result DeletedKeyListResultPage, err error)

GetDeletedKeys retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results.

func (BaseClient) GetDeletedKeysComplete Uses

func (client BaseClient) GetDeletedKeysComplete(ctx context.Context, vaultBaseURL string, maxresults *int32) (result DeletedKeyListResultIterator, err error)

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

func (BaseClient) GetDeletedKeysPreparer Uses

func (client BaseClient) GetDeletedKeysPreparer(ctx context.Context, vaultBaseURL string, maxresults *int32) (*http.Request, error)

GetDeletedKeysPreparer prepares the GetDeletedKeys request.

func (BaseClient) GetDeletedKeysResponder Uses

func (client BaseClient) GetDeletedKeysResponder(resp *http.Response) (result DeletedKeyListResult, err error)

GetDeletedKeysResponder handles the response to the GetDeletedKeys request. The method always closes the http.Response Body.

func (BaseClient) GetDeletedKeysSender Uses

func (client BaseClient) GetDeletedKeysSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetDeletedSasDefinition Uses

func (client BaseClient) GetDeletedSasDefinition(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string) (result DeletedSasDefinitionBundle, err error)

GetDeletedSasDefinition the Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. sasDefinitionName - the name of the SAS definition.

func (BaseClient) GetDeletedSasDefinitionPreparer Uses

func (client BaseClient) GetDeletedSasDefinitionPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string) (*http.Request, error)

GetDeletedSasDefinitionPreparer prepares the GetDeletedSasDefinition request.

func (BaseClient) GetDeletedSasDefinitionResponder Uses

func (client BaseClient) GetDeletedSasDefinitionResponder(resp *http.Response) (result DeletedSasDefinitionBundle, err error)

GetDeletedSasDefinitionResponder handles the response to the GetDeletedSasDefinition request. The method always closes the http.Response Body.

func (BaseClient) GetDeletedSasDefinitionSender Uses

func (client BaseClient) GetDeletedSasDefinitionSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetDeletedSasDefinitions Uses

func (client BaseClient) GetDeletedSasDefinitions(ctx context.Context, vaultBaseURL string, storageAccountName string, maxresults *int32) (result DeletedSasDefinitionListResultPage, err error)

GetDeletedSasDefinitions the Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results.

func (BaseClient) GetDeletedSasDefinitionsComplete Uses

func (client BaseClient) GetDeletedSasDefinitionsComplete(ctx context.Context, vaultBaseURL string, storageAccountName string, maxresults *int32) (result DeletedSasDefinitionListResultIterator, err error)

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

func (BaseClient) GetDeletedSasDefinitionsPreparer Uses

func (client BaseClient) GetDeletedSasDefinitionsPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, maxresults *int32) (*http.Request, error)

GetDeletedSasDefinitionsPreparer prepares the GetDeletedSasDefinitions request.

func (BaseClient) GetDeletedSasDefinitionsResponder Uses

func (client BaseClient) GetDeletedSasDefinitionsResponder(resp *http.Response) (result DeletedSasDefinitionListResult, err error)

GetDeletedSasDefinitionsResponder handles the response to the GetDeletedSasDefinitions request. The method always closes the http.Response Body.

func (BaseClient) GetDeletedSasDefinitionsSender Uses

func (client BaseClient) GetDeletedSasDefinitionsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetDeletedSecret Uses

func (client BaseClient) GetDeletedSecret(ctx context.Context, vaultBaseURL string, secretName string) (result DeletedSecretBundle, err error)

GetDeletedSecret the Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. secretName - the name of the secret.

func (BaseClient) GetDeletedSecretPreparer Uses

func (client BaseClient) GetDeletedSecretPreparer(ctx context.Context, vaultBaseURL string, secretName string) (*http.Request, error)

GetDeletedSecretPreparer prepares the GetDeletedSecret request.

func (BaseClient) GetDeletedSecretResponder Uses

func (client BaseClient) GetDeletedSecretResponder(resp *http.Response) (result DeletedSecretBundle, err error)

GetDeletedSecretResponder handles the response to the GetDeletedSecret request. The method always closes the http.Response Body.

func (BaseClient) GetDeletedSecretSender Uses

func (client BaseClient) GetDeletedSecretSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetDeletedSecrets Uses

func (client BaseClient) GetDeletedSecrets(ctx context.Context, vaultBaseURL string, maxresults *int32) (result DeletedSecretListResultPage, err error)

GetDeletedSecrets the Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results.

func (BaseClient) GetDeletedSecretsComplete Uses

func (client BaseClient) GetDeletedSecretsComplete(ctx context.Context, vaultBaseURL string, maxresults *int32) (result DeletedSecretListResultIterator, err error)

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

func (BaseClient) GetDeletedSecretsPreparer Uses

func (client BaseClient) GetDeletedSecretsPreparer(ctx context.Context, vaultBaseURL string, maxresults *int32) (*http.Request, error)

GetDeletedSecretsPreparer prepares the GetDeletedSecrets request.

func (BaseClient) GetDeletedSecretsResponder Uses

func (client BaseClient) GetDeletedSecretsResponder(resp *http.Response) (result DeletedSecretListResult, err error)

GetDeletedSecretsResponder handles the response to the GetDeletedSecrets request. The method always closes the http.Response Body.

func (BaseClient) GetDeletedSecretsSender Uses

func (client BaseClient) GetDeletedSecretsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetDeletedStorageAccount Uses

func (client BaseClient) GetDeletedStorageAccount(ctx context.Context, vaultBaseURL string, storageAccountName string) (result DeletedStorageBundle, err error)

GetDeletedStorageAccount the Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account.

func (BaseClient) GetDeletedStorageAccountPreparer Uses

func (client BaseClient) GetDeletedStorageAccountPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string) (*http.Request, error)

GetDeletedStorageAccountPreparer prepares the GetDeletedStorageAccount request.

func (BaseClient) GetDeletedStorageAccountResponder Uses

func (client BaseClient) GetDeletedStorageAccountResponder(resp *http.Response) (result DeletedStorageBundle, err error)

GetDeletedStorageAccountResponder handles the response to the GetDeletedStorageAccount request. The method always closes the http.Response Body.

func (BaseClient) GetDeletedStorageAccountSender Uses

func (client BaseClient) GetDeletedStorageAccountSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetDeletedStorageAccounts Uses

func (client BaseClient) GetDeletedStorageAccounts(ctx context.Context, vaultBaseURL string, maxresults *int32) (result DeletedStorageListResultPage, err error)

GetDeletedStorageAccounts the Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results.

func (BaseClient) GetDeletedStorageAccountsComplete Uses

func (client BaseClient) GetDeletedStorageAccountsComplete(ctx context.Context, vaultBaseURL string, maxresults *int32) (result DeletedStorageListResultIterator, err error)

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

func (BaseClient) GetDeletedStorageAccountsPreparer Uses

func (client BaseClient) GetDeletedStorageAccountsPreparer(ctx context.Context, vaultBaseURL string, maxresults *int32) (*http.Request, error)

GetDeletedStorageAccountsPreparer prepares the GetDeletedStorageAccounts request.

func (BaseClient) GetDeletedStorageAccountsResponder Uses

func (client BaseClient) GetDeletedStorageAccountsResponder(resp *http.Response) (result DeletedStorageListResult, err error)

GetDeletedStorageAccountsResponder handles the response to the GetDeletedStorageAccounts request. The method always closes the http.Response Body.

func (BaseClient) GetDeletedStorageAccountsSender Uses

func (client BaseClient) GetDeletedStorageAccountsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetKey Uses

func (client BaseClient) GetKey(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string) (result KeyBundle, err error)

GetKey the get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key to get. keyVersion - adding the version parameter retrieves a specific version of a key.

func (BaseClient) GetKeyPreparer Uses

func (client BaseClient) GetKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string) (*http.Request, error)

GetKeyPreparer prepares the GetKey request.

func (BaseClient) GetKeyResponder Uses

func (client BaseClient) GetKeyResponder(resp *http.Response) (result KeyBundle, err error)

GetKeyResponder handles the response to the GetKey request. The method always closes the http.Response Body.

func (BaseClient) GetKeySender Uses

func (client BaseClient) GetKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetKeyVersions Uses

func (client BaseClient) GetKeyVersions(ctx context.Context, vaultBaseURL string, keyName string, maxresults *int32) (result KeyListResultPage, err error)

GetKeyVersions the full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results.

func (BaseClient) GetKeyVersionsComplete Uses

func (client BaseClient) GetKeyVersionsComplete(ctx context.Context, vaultBaseURL string, keyName string, maxresults *int32) (result KeyListResultIterator, err error)

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

func (BaseClient) GetKeyVersionsPreparer Uses

func (client BaseClient) GetKeyVersionsPreparer(ctx context.Context, vaultBaseURL string, keyName string, maxresults *int32) (*http.Request, error)

GetKeyVersionsPreparer prepares the GetKeyVersions request.

func (BaseClient) GetKeyVersionsResponder Uses

func (client BaseClient) GetKeyVersionsResponder(resp *http.Response) (result KeyListResult, err error)

GetKeyVersionsResponder handles the response to the GetKeyVersions request. The method always closes the http.Response Body.

func (BaseClient) GetKeyVersionsSender Uses

func (client BaseClient) GetKeyVersionsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetKeys Uses

func (client BaseClient) GetKeys(ctx context.Context, vaultBaseURL string, maxresults *int32) (result KeyListResultPage, err error)

GetKeys retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results.

func (BaseClient) GetKeysComplete Uses

func (client BaseClient) GetKeysComplete(ctx context.Context, vaultBaseURL string, maxresults *int32) (result KeyListResultIterator, err error)

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

func (BaseClient) GetKeysPreparer Uses

func (client BaseClient) GetKeysPreparer(ctx context.Context, vaultBaseURL string, maxresults *int32) (*http.Request, error)

GetKeysPreparer prepares the GetKeys request.

func (BaseClient) GetKeysResponder Uses

func (client BaseClient) GetKeysResponder(resp *http.Response) (result KeyListResult, err error)

GetKeysResponder handles the response to the GetKeys request. The method always closes the http.Response Body.

func (BaseClient) GetKeysSender Uses

func (client BaseClient) GetKeysSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetSasDefinition Uses

func (client BaseClient) GetSasDefinition(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string) (result SasDefinitionBundle, err error)

GetSasDefinition gets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. sasDefinitionName - the name of the SAS definition.

func (BaseClient) GetSasDefinitionPreparer Uses

func (client BaseClient) GetSasDefinitionPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string) (*http.Request, error)

GetSasDefinitionPreparer prepares the GetSasDefinition request.

func (BaseClient) GetSasDefinitionResponder Uses

func (client BaseClient) GetSasDefinitionResponder(resp *http.Response) (result SasDefinitionBundle, err error)

GetSasDefinitionResponder handles the response to the GetSasDefinition request. The method always closes the http.Response Body.

func (BaseClient) GetSasDefinitionSender Uses

func (client BaseClient) GetSasDefinitionSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetSasDefinitions Uses

func (client BaseClient) GetSasDefinitions(ctx context.Context, vaultBaseURL string, storageAccountName string, maxresults *int32) (result SasDefinitionListResultPage, err error)

GetSasDefinitions list storage SAS definitions for the given storage account. This operation requires the storage/listsas permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results.

func (BaseClient) GetSasDefinitionsComplete Uses

func (client BaseClient) GetSasDefinitionsComplete(ctx context.Context, vaultBaseURL string, storageAccountName string, maxresults *int32) (result SasDefinitionListResultIterator, err error)

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

func (BaseClient) GetSasDefinitionsPreparer Uses

func (client BaseClient) GetSasDefinitionsPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, maxresults *int32) (*http.Request, error)

GetSasDefinitionsPreparer prepares the GetSasDefinitions request.

func (BaseClient) GetSasDefinitionsResponder Uses

func (client BaseClient) GetSasDefinitionsResponder(resp *http.Response) (result SasDefinitionListResult, err error)

GetSasDefinitionsResponder handles the response to the GetSasDefinitions request. The method always closes the http.Response Body.

func (BaseClient) GetSasDefinitionsSender Uses

func (client BaseClient) GetSasDefinitionsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetSecret Uses

func (client BaseClient) GetSecret(ctx context.Context, vaultBaseURL string, secretName string, secretVersion string) (result SecretBundle, err error)

GetSecret the GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. secretName - the name of the secret. secretVersion - the version of the secret.

func (BaseClient) GetSecretPreparer Uses

func (client BaseClient) GetSecretPreparer(ctx context.Context, vaultBaseURL string, secretName string, secretVersion string) (*http.Request, error)

GetSecretPreparer prepares the GetSecret request.

func (BaseClient) GetSecretResponder Uses

func (client BaseClient) GetSecretResponder(resp *http.Response) (result SecretBundle, err error)

GetSecretResponder handles the response to the GetSecret request. The method always closes the http.Response Body.

func (BaseClient) GetSecretSender Uses

func (client BaseClient) GetSecretSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetSecretVersions Uses

func (client BaseClient) GetSecretVersions(ctx context.Context, vaultBaseURL string, secretName string, maxresults *int32) (result SecretListResultPage, err error)

GetSecretVersions the full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. secretName - the name of the secret. maxresults - maximum number of results to return in a page. If not specified, the service will return up to 25 results.

func (BaseClient) GetSecretVersionsComplete Uses

func (client BaseClient) GetSecretVersionsComplete(ctx context.Context, vaultBaseURL string, secretName string, maxresults *int32) (result SecretListResultIterator, err error)

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

func (BaseClient) GetSecretVersionsPreparer Uses

func (client BaseClient) GetSecretVersionsPreparer(ctx context.Context, vaultBaseURL string, secretName string, maxresults *int32) (*http.Request, error)

GetSecretVersionsPreparer prepares the GetSecretVersions request.

func (BaseClient) GetSecretVersionsResponder Uses

func (client BaseClient) GetSecretVersionsResponder(resp *http.Response) (result SecretListResult, err error)

GetSecretVersionsResponder handles the response to the GetSecretVersions request. The method always closes the http.Response Body.

func (BaseClient) GetSecretVersionsSender Uses

func (client BaseClient) GetSecretVersionsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetSecrets Uses

func (client BaseClient) GetSecrets(ctx context.Context, vaultBaseURL string, maxresults *int32) (result SecretListResultPage, err error)

GetSecrets the Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. maxresults - maximum number of results to return in a page. If not specified, the service will return up to 25 results.

func (BaseClient) GetSecretsComplete Uses

func (client BaseClient) GetSecretsComplete(ctx context.Context, vaultBaseURL string, maxresults *int32) (result SecretListResultIterator, err error)

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

func (BaseClient) GetSecretsPreparer Uses

func (client BaseClient) GetSecretsPreparer(ctx context.Context, vaultBaseURL string, maxresults *int32) (*http.Request, error)

GetSecretsPreparer prepares the GetSecrets request.

func (BaseClient) GetSecretsResponder Uses

func (client BaseClient) GetSecretsResponder(resp *http.Response) (result SecretListResult, err error)

GetSecretsResponder handles the response to the GetSecrets request. The method always closes the http.Response Body.

func (BaseClient) GetSecretsSender Uses

func (client BaseClient) GetSecretsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetStorageAccount Uses

func (client BaseClient) GetStorageAccount(ctx context.Context, vaultBaseURL string, storageAccountName string) (result StorageBundle, err error)

GetStorageAccount gets information about a specified storage account. This operation requires the storage/get permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account.

func (BaseClient) GetStorageAccountPreparer Uses

func (client BaseClient) GetStorageAccountPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string) (*http.Request, error)

GetStorageAccountPreparer prepares the GetStorageAccount request.

func (BaseClient) GetStorageAccountResponder Uses

func (client BaseClient) GetStorageAccountResponder(resp *http.Response) (result StorageBundle, err error)

GetStorageAccountResponder handles the response to the GetStorageAccount request. The method always closes the http.Response Body.

func (BaseClient) GetStorageAccountSender Uses

func (client BaseClient) GetStorageAccountSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) GetStorageAccounts Uses

func (client BaseClient) GetStorageAccounts(ctx context.Context, vaultBaseURL string, maxresults *int32) (result StorageListResultPage, err error)

GetStorageAccounts list storage accounts managed by the specified key vault. This operation requires the storage/list permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. maxresults - maximum number of results to return in a page. If not specified the service will return up to 25 results.

func (BaseClient) GetStorageAccountsComplete Uses

func (client BaseClient) GetStorageAccountsComplete(ctx context.Context, vaultBaseURL string, maxresults *int32) (result StorageListResultIterator, err error)

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

func (BaseClient) GetStorageAccountsPreparer Uses

func (client BaseClient) GetStorageAccountsPreparer(ctx context.Context, vaultBaseURL string, maxresults *int32) (*http.Request, error)

GetStorageAccountsPreparer prepares the GetStorageAccounts request.

func (BaseClient) GetStorageAccountsResponder Uses

func (client BaseClient) GetStorageAccountsResponder(resp *http.Response) (result StorageListResult, err error)

GetStorageAccountsResponder handles the response to the GetStorageAccounts request. The method always closes the http.Response Body.

func (BaseClient) GetStorageAccountsSender Uses

func (client BaseClient) GetStorageAccountsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) ImportCertificate Uses

func (client BaseClient) ImportCertificate(ctx context.Context, vaultBaseURL string, certificateName string, parameters CertificateImportParameters) (result CertificateBundle, err error)

ImportCertificate imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as well as x509 certificates. This operation requires the certificates/import permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate. parameters - the parameters to import the certificate.

func (BaseClient) ImportCertificatePreparer Uses

func (client BaseClient) ImportCertificatePreparer(ctx context.Context, vaultBaseURL string, certificateName string, parameters CertificateImportParameters) (*http.Request, error)

ImportCertificatePreparer prepares the ImportCertificate request.

func (BaseClient) ImportCertificateResponder Uses

func (client BaseClient) ImportCertificateResponder(resp *http.Response) (result CertificateBundle, err error)

ImportCertificateResponder handles the response to the ImportCertificate request. The method always closes the http.Response Body.

func (BaseClient) ImportCertificateSender Uses

func (client BaseClient) ImportCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) ImportKey Uses

func (client BaseClient) ImportKey(ctx context.Context, vaultBaseURL string, keyName string, parameters KeyImportParameters) (result KeyBundle, err error)

ImportKey the import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - name for the imported key. parameters - the parameters to import a key.

func (BaseClient) ImportKeyPreparer Uses

func (client BaseClient) ImportKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string, parameters KeyImportParameters) (*http.Request, error)

ImportKeyPreparer prepares the ImportKey request.

func (BaseClient) ImportKeyResponder Uses

func (client BaseClient) ImportKeyResponder(resp *http.Response) (result KeyBundle, err error)

ImportKeyResponder handles the response to the ImportKey request. The method always closes the http.Response Body.

func (BaseClient) ImportKeySender Uses

func (client BaseClient) ImportKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) MergeCertificate Uses

func (client BaseClient) MergeCertificate(ctx context.Context, vaultBaseURL string, certificateName string, parameters CertificateMergeParameters) (result CertificateBundle, err error)

MergeCertificate the MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate. parameters - the parameters to merge certificate.

func (BaseClient) MergeCertificatePreparer Uses

func (client BaseClient) MergeCertificatePreparer(ctx context.Context, vaultBaseURL string, certificateName string, parameters CertificateMergeParameters) (*http.Request, error)

MergeCertificatePreparer prepares the MergeCertificate request.

func (BaseClient) MergeCertificateResponder Uses

func (client BaseClient) MergeCertificateResponder(resp *http.Response) (result CertificateBundle, err error)

MergeCertificateResponder handles the response to the MergeCertificate request. The method always closes the http.Response Body.

func (BaseClient) MergeCertificateSender Uses

func (client BaseClient) MergeCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) PurgeDeletedCertificate Uses

func (client BaseClient) PurgeDeletedCertificate(ctx context.Context, vaultBaseURL string, certificateName string) (result autorest.Response, err error)

PurgeDeletedCertificate the PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify 'Purgeable'. This operation requires the certificate/purge permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate

func (BaseClient) PurgeDeletedCertificatePreparer Uses

func (client BaseClient) PurgeDeletedCertificatePreparer(ctx context.Context, vaultBaseURL string, certificateName string) (*http.Request, error)

PurgeDeletedCertificatePreparer prepares the PurgeDeletedCertificate request.

func (BaseClient) PurgeDeletedCertificateResponder Uses

func (client BaseClient) PurgeDeletedCertificateResponder(resp *http.Response) (result autorest.Response, err error)

PurgeDeletedCertificateResponder handles the response to the PurgeDeletedCertificate request. The method always closes the http.Response Body.

func (BaseClient) PurgeDeletedCertificateSender Uses

func (client BaseClient) PurgeDeletedCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) PurgeDeletedKey Uses

func (client BaseClient) PurgeDeletedKey(ctx context.Context, vaultBaseURL string, keyName string) (result autorest.Response, err error)

PurgeDeletedKey the Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/purge permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key

func (BaseClient) PurgeDeletedKeyPreparer Uses

func (client BaseClient) PurgeDeletedKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string) (*http.Request, error)

PurgeDeletedKeyPreparer prepares the PurgeDeletedKey request.

func (BaseClient) PurgeDeletedKeyResponder Uses

func (client BaseClient) PurgeDeletedKeyResponder(resp *http.Response) (result autorest.Response, err error)

PurgeDeletedKeyResponder handles the response to the PurgeDeletedKey request. The method always closes the http.Response Body.

func (BaseClient) PurgeDeletedKeySender Uses

func (client BaseClient) PurgeDeletedKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) PurgeDeletedSecret Uses

func (client BaseClient) PurgeDeletedSecret(ctx context.Context, vaultBaseURL string, secretName string) (result autorest.Response, err error)

PurgeDeletedSecret the purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. secretName - the name of the secret.

func (BaseClient) PurgeDeletedSecretPreparer Uses

func (client BaseClient) PurgeDeletedSecretPreparer(ctx context.Context, vaultBaseURL string, secretName string) (*http.Request, error)

PurgeDeletedSecretPreparer prepares the PurgeDeletedSecret request.

func (BaseClient) PurgeDeletedSecretResponder Uses

func (client BaseClient) PurgeDeletedSecretResponder(resp *http.Response) (result autorest.Response, err error)

PurgeDeletedSecretResponder handles the response to the PurgeDeletedSecret request. The method always closes the http.Response Body.

func (BaseClient) PurgeDeletedSecretSender Uses

func (client BaseClient) PurgeDeletedSecretSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) PurgeDeletedStorageAccount Uses

func (client BaseClient) PurgeDeletedStorageAccount(ctx context.Context, vaultBaseURL string, storageAccountName string) (result autorest.Response, err error)

PurgeDeletedStorageAccount the purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account.

func (BaseClient) PurgeDeletedStorageAccountPreparer Uses

func (client BaseClient) PurgeDeletedStorageAccountPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string) (*http.Request, error)

PurgeDeletedStorageAccountPreparer prepares the PurgeDeletedStorageAccount request.

func (BaseClient) PurgeDeletedStorageAccountResponder Uses

func (client BaseClient) PurgeDeletedStorageAccountResponder(resp *http.Response) (result autorest.Response, err error)

PurgeDeletedStorageAccountResponder handles the response to the PurgeDeletedStorageAccount request. The method always closes the http.Response Body.

func (BaseClient) PurgeDeletedStorageAccountSender Uses

func (client BaseClient) PurgeDeletedStorageAccountSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) RecoverDeletedCertificate Uses

func (client BaseClient) RecoverDeletedCertificate(ctx context.Context, vaultBaseURL string, certificateName string) (result CertificateBundle, err error)

RecoverDeletedCertificate the RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted certificate's attributes). This operation requires the certificates/recover permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the deleted certificate

func (BaseClient) RecoverDeletedCertificatePreparer Uses

func (client BaseClient) RecoverDeletedCertificatePreparer(ctx context.Context, vaultBaseURL string, certificateName string) (*http.Request, error)

RecoverDeletedCertificatePreparer prepares the RecoverDeletedCertificate request.

func (BaseClient) RecoverDeletedCertificateResponder Uses

func (client BaseClient) RecoverDeletedCertificateResponder(resp *http.Response) (result CertificateBundle, err error)

RecoverDeletedCertificateResponder handles the response to the RecoverDeletedCertificate request. The method always closes the http.Response Body.

func (BaseClient) RecoverDeletedCertificateSender Uses

func (client BaseClient) RecoverDeletedCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) RecoverDeletedKey Uses

func (client BaseClient) RecoverDeletedKey(ctx context.Context, vaultBaseURL string, keyName string) (result KeyBundle, err error)

RecoverDeletedKey the Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the deleted key.

func (BaseClient) RecoverDeletedKeyPreparer Uses

func (client BaseClient) RecoverDeletedKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string) (*http.Request, error)

RecoverDeletedKeyPreparer prepares the RecoverDeletedKey request.

func (BaseClient) RecoverDeletedKeyResponder Uses

func (client BaseClient) RecoverDeletedKeyResponder(resp *http.Response) (result KeyBundle, err error)

RecoverDeletedKeyResponder handles the response to the RecoverDeletedKey request. The method always closes the http.Response Body.

func (BaseClient) RecoverDeletedKeySender Uses

func (client BaseClient) RecoverDeletedKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) RecoverDeletedSasDefinition Uses

func (client BaseClient) RecoverDeletedSasDefinition(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string) (result SasDefinitionBundle, err error)

RecoverDeletedSasDefinition recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. sasDefinitionName - the name of the SAS definition.

func (BaseClient) RecoverDeletedSasDefinitionPreparer Uses

func (client BaseClient) RecoverDeletedSasDefinitionPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string) (*http.Request, error)

RecoverDeletedSasDefinitionPreparer prepares the RecoverDeletedSasDefinition request.

func (BaseClient) RecoverDeletedSasDefinitionResponder Uses

func (client BaseClient) RecoverDeletedSasDefinitionResponder(resp *http.Response) (result SasDefinitionBundle, err error)

RecoverDeletedSasDefinitionResponder handles the response to the RecoverDeletedSasDefinition request. The method always closes the http.Response Body.

func (BaseClient) RecoverDeletedSasDefinitionSender Uses

func (client BaseClient) RecoverDeletedSasDefinitionSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) RecoverDeletedSecret Uses

func (client BaseClient) RecoverDeletedSecret(ctx context.Context, vaultBaseURL string, secretName string) (result SecretBundle, err error)

RecoverDeletedSecret recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. secretName - the name of the deleted secret.

func (BaseClient) RecoverDeletedSecretPreparer Uses

func (client BaseClient) RecoverDeletedSecretPreparer(ctx context.Context, vaultBaseURL string, secretName string) (*http.Request, error)

RecoverDeletedSecretPreparer prepares the RecoverDeletedSecret request.

func (BaseClient) RecoverDeletedSecretResponder Uses

func (client BaseClient) RecoverDeletedSecretResponder(resp *http.Response) (result SecretBundle, err error)

RecoverDeletedSecretResponder handles the response to the RecoverDeletedSecret request. The method always closes the http.Response Body.

func (BaseClient) RecoverDeletedSecretSender Uses

func (client BaseClient) RecoverDeletedSecretSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) RecoverDeletedStorageAccount Uses

func (client BaseClient) RecoverDeletedStorageAccount(ctx context.Context, vaultBaseURL string, storageAccountName string) (result StorageBundle, err error)

RecoverDeletedStorageAccount recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account.

func (BaseClient) RecoverDeletedStorageAccountPreparer Uses

func (client BaseClient) RecoverDeletedStorageAccountPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string) (*http.Request, error)

RecoverDeletedStorageAccountPreparer prepares the RecoverDeletedStorageAccount request.

func (BaseClient) RecoverDeletedStorageAccountResponder Uses

func (client BaseClient) RecoverDeletedStorageAccountResponder(resp *http.Response) (result StorageBundle, err error)

RecoverDeletedStorageAccountResponder handles the response to the RecoverDeletedStorageAccount request. The method always closes the http.Response Body.

func (BaseClient) RecoverDeletedStorageAccountSender Uses

func (client BaseClient) RecoverDeletedStorageAccountSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) RegenerateStorageAccountKey Uses

func (client BaseClient) RegenerateStorageAccountKey(ctx context.Context, vaultBaseURL string, storageAccountName string, parameters StorageAccountRegenerteKeyParameters) (result StorageBundle, err error)

RegenerateStorageAccountKey regenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. parameters - the parameters to regenerate storage account key.

func (BaseClient) RegenerateStorageAccountKeyPreparer Uses

func (client BaseClient) RegenerateStorageAccountKeyPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, parameters StorageAccountRegenerteKeyParameters) (*http.Request, error)

RegenerateStorageAccountKeyPreparer prepares the RegenerateStorageAccountKey request.

func (BaseClient) RegenerateStorageAccountKeyResponder Uses

func (client BaseClient) RegenerateStorageAccountKeyResponder(resp *http.Response) (result StorageBundle, err error)

RegenerateStorageAccountKeyResponder handles the response to the RegenerateStorageAccountKey request. The method always closes the http.Response Body.

func (BaseClient) RegenerateStorageAccountKeySender Uses

func (client BaseClient) RegenerateStorageAccountKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) RestoreCertificate Uses

func (client BaseClient) RestoreCertificate(ctx context.Context, vaultBaseURL string, parameters CertificateRestoreParameters) (result CertificateBundle, err error)

RestoreCertificate restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. parameters - the parameters to restore the certificate.

func (BaseClient) RestoreCertificatePreparer Uses

func (client BaseClient) RestoreCertificatePreparer(ctx context.Context, vaultBaseURL string, parameters CertificateRestoreParameters) (*http.Request, error)

RestoreCertificatePreparer prepares the RestoreCertificate request.

func (BaseClient) RestoreCertificateResponder Uses

func (client BaseClient) RestoreCertificateResponder(resp *http.Response) (result CertificateBundle, err error)

RestoreCertificateResponder handles the response to the RestoreCertificate request. The method always closes the http.Response Body.

func (BaseClient) RestoreCertificateSender Uses

func (client BaseClient) RestoreCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) RestoreKey Uses

func (client BaseClient) RestoreKey(ctx context.Context, vaultBaseURL string, parameters KeyRestoreParameters) (result KeyBundle, err error)

RestoreKey imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. parameters - the parameters to restore the key.

func (BaseClient) RestoreKeyPreparer Uses

func (client BaseClient) RestoreKeyPreparer(ctx context.Context, vaultBaseURL string, parameters KeyRestoreParameters) (*http.Request, error)

RestoreKeyPreparer prepares the RestoreKey request.

func (BaseClient) RestoreKeyResponder Uses

func (client BaseClient) RestoreKeyResponder(resp *http.Response) (result KeyBundle, err error)

RestoreKeyResponder handles the response to the RestoreKey request. The method always closes the http.Response Body.

func (BaseClient) RestoreKeySender Uses

func (client BaseClient) RestoreKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) RestoreSecret Uses

func (client BaseClient) RestoreSecret(ctx context.Context, vaultBaseURL string, parameters SecretRestoreParameters) (result SecretBundle, err error)

RestoreSecret restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. parameters - the parameters to restore the secret.

func (BaseClient) RestoreSecretPreparer Uses

func (client BaseClient) RestoreSecretPreparer(ctx context.Context, vaultBaseURL string, parameters SecretRestoreParameters) (*http.Request, error)

RestoreSecretPreparer prepares the RestoreSecret request.

func (BaseClient) RestoreSecretResponder Uses

func (client BaseClient) RestoreSecretResponder(resp *http.Response) (result SecretBundle, err error)

RestoreSecretResponder handles the response to the RestoreSecret request. The method always closes the http.Response Body.

func (BaseClient) RestoreSecretSender Uses

func (client BaseClient) RestoreSecretSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) RestoreStorageAccount Uses

func (client BaseClient) RestoreStorageAccount(ctx context.Context, vaultBaseURL string, parameters StorageRestoreParameters) (result StorageBundle, err error)

RestoreStorageAccount restores a backed up storage account to a vault. This operation requires the storage/restore permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. parameters - the parameters to restore the storage account.

func (BaseClient) RestoreStorageAccountPreparer Uses

func (client BaseClient) RestoreStorageAccountPreparer(ctx context.Context, vaultBaseURL string, parameters StorageRestoreParameters) (*http.Request, error)

RestoreStorageAccountPreparer prepares the RestoreStorageAccount request.

func (BaseClient) RestoreStorageAccountResponder Uses

func (client BaseClient) RestoreStorageAccountResponder(resp *http.Response) (result StorageBundle, err error)

RestoreStorageAccountResponder handles the response to the RestoreStorageAccount request. The method always closes the http.Response Body.

func (BaseClient) RestoreStorageAccountSender Uses

func (client BaseClient) RestoreStorageAccountSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) SetCertificateContacts Uses

func (client BaseClient) SetCertificateContacts(ctx context.Context, vaultBaseURL string, contacts Contacts) (result Contacts, err error)

SetCertificateContacts sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. contacts - the contacts for the key vault certificate.

func (BaseClient) SetCertificateContactsPreparer Uses

func (client BaseClient) SetCertificateContactsPreparer(ctx context.Context, vaultBaseURL string, contacts Contacts) (*http.Request, error)

SetCertificateContactsPreparer prepares the SetCertificateContacts request.

func (BaseClient) SetCertificateContactsResponder Uses

func (client BaseClient) SetCertificateContactsResponder(resp *http.Response) (result Contacts, err error)

SetCertificateContactsResponder handles the response to the SetCertificateContacts request. The method always closes the http.Response Body.

func (BaseClient) SetCertificateContactsSender Uses

func (client BaseClient) SetCertificateContactsSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) SetCertificateIssuer Uses

func (client BaseClient) SetCertificateIssuer(ctx context.Context, vaultBaseURL string, issuerName string, parameter CertificateIssuerSetParameters) (result IssuerBundle, err error)

SetCertificateIssuer the SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. issuerName - the name of the issuer. parameter - certificate issuer set parameter.

func (BaseClient) SetCertificateIssuerPreparer Uses

func (client BaseClient) SetCertificateIssuerPreparer(ctx context.Context, vaultBaseURL string, issuerName string, parameter CertificateIssuerSetParameters) (*http.Request, error)

SetCertificateIssuerPreparer prepares the SetCertificateIssuer request.

func (BaseClient) SetCertificateIssuerResponder Uses

func (client BaseClient) SetCertificateIssuerResponder(resp *http.Response) (result IssuerBundle, err error)

SetCertificateIssuerResponder handles the response to the SetCertificateIssuer request. The method always closes the http.Response Body.

func (BaseClient) SetCertificateIssuerSender Uses

func (client BaseClient) SetCertificateIssuerSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) SetSasDefinition Uses

func (client BaseClient) SetSasDefinition(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string, parameters SasDefinitionCreateParameters) (result SasDefinitionBundle, err error)

SetSasDefinition creates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. sasDefinitionName - the name of the SAS definition. parameters - the parameters to create a SAS definition.

func (BaseClient) SetSasDefinitionPreparer Uses

func (client BaseClient) SetSasDefinitionPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string, parameters SasDefinitionCreateParameters) (*http.Request, error)

SetSasDefinitionPreparer prepares the SetSasDefinition request.

func (BaseClient) SetSasDefinitionResponder Uses

func (client BaseClient) SetSasDefinitionResponder(resp *http.Response) (result SasDefinitionBundle, err error)

SetSasDefinitionResponder handles the response to the SetSasDefinition request. The method always closes the http.Response Body.

func (BaseClient) SetSasDefinitionSender Uses

func (client BaseClient) SetSasDefinitionSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) SetSecret Uses

func (client BaseClient) SetSecret(ctx context.Context, vaultBaseURL string, secretName string, parameters SecretSetParameters) (result SecretBundle, err error)

SetSecret the SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. secretName - the name of the secret. parameters - the parameters for setting the secret.

func (BaseClient) SetSecretPreparer Uses

func (client BaseClient) SetSecretPreparer(ctx context.Context, vaultBaseURL string, secretName string, parameters SecretSetParameters) (*http.Request, error)

SetSecretPreparer prepares the SetSecret request.

func (BaseClient) SetSecretResponder Uses

func (client BaseClient) SetSecretResponder(resp *http.Response) (result SecretBundle, err error)

SetSecretResponder handles the response to the SetSecret request. The method always closes the http.Response Body.

func (BaseClient) SetSecretSender Uses

func (client BaseClient) SetSecretSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) SetStorageAccount Uses

func (client BaseClient) SetStorageAccount(ctx context.Context, vaultBaseURL string, storageAccountName string, parameters StorageAccountCreateParameters) (result StorageBundle, err error)

SetStorageAccount creates or updates a new storage account. This operation requires the storage/set permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. parameters - the parameters to create a storage account.

func (BaseClient) SetStorageAccountPreparer Uses

func (client BaseClient) SetStorageAccountPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, parameters StorageAccountCreateParameters) (*http.Request, error)

SetStorageAccountPreparer prepares the SetStorageAccount request.

func (BaseClient) SetStorageAccountResponder Uses

func (client BaseClient) SetStorageAccountResponder(resp *http.Response) (result StorageBundle, err error)

SetStorageAccountResponder handles the response to the SetStorageAccount request. The method always closes the http.Response Body.

func (BaseClient) SetStorageAccountSender Uses

func (client BaseClient) SetStorageAccountSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) Sign Uses

func (client BaseClient) Sign(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeySignParameters) (result KeyOperationResult, err error)

Sign the SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This operation requires the keys/sign permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key. keyVersion - the version of the key. parameters - the parameters for the signing operation.

func (BaseClient) SignPreparer Uses

func (client BaseClient) SignPreparer(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeySignParameters) (*http.Request, error)

SignPreparer prepares the Sign request.

func (BaseClient) SignResponder Uses

func (client BaseClient) SignResponder(resp *http.Response) (result KeyOperationResult, err error)

SignResponder handles the response to the Sign request. The method always closes the http.Response Body.

func (BaseClient) SignSender Uses

func (client BaseClient) SignSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) UnwrapKey Uses

func (client BaseClient) UnwrapKey(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyOperationsParameters) (result KeyOperationResult, err error)

UnwrapKey the UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key. keyVersion - the version of the key. parameters - the parameters for the key operation.

func (BaseClient) UnwrapKeyPreparer Uses

func (client BaseClient) UnwrapKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyOperationsParameters) (*http.Request, error)

UnwrapKeyPreparer prepares the UnwrapKey request.

func (BaseClient) UnwrapKeyResponder Uses

func (client BaseClient) UnwrapKeyResponder(resp *http.Response) (result KeyOperationResult, err error)

UnwrapKeyResponder handles the response to the UnwrapKey request. The method always closes the http.Response Body.

func (BaseClient) UnwrapKeySender Uses

func (client BaseClient) UnwrapKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) UpdateCertificate Uses

func (client BaseClient) UpdateCertificate(ctx context.Context, vaultBaseURL string, certificateName string, certificateVersion string, parameters CertificateUpdateParameters) (result CertificateBundle, err error)

UpdateCertificate the UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This operation requires the certificates/update permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate in the given key vault. certificateVersion - the version of the certificate. parameters - the parameters for certificate update.

func (BaseClient) UpdateCertificateIssuer Uses

func (client BaseClient) UpdateCertificateIssuer(ctx context.Context, vaultBaseURL string, issuerName string, parameter CertificateIssuerUpdateParameters) (result IssuerBundle, err error)

UpdateCertificateIssuer the UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. issuerName - the name of the issuer. parameter - certificate issuer update parameter.

func (BaseClient) UpdateCertificateIssuerPreparer Uses

func (client BaseClient) UpdateCertificateIssuerPreparer(ctx context.Context, vaultBaseURL string, issuerName string, parameter CertificateIssuerUpdateParameters) (*http.Request, error)

UpdateCertificateIssuerPreparer prepares the UpdateCertificateIssuer request.

func (BaseClient) UpdateCertificateIssuerResponder Uses

func (client BaseClient) UpdateCertificateIssuerResponder(resp *http.Response) (result IssuerBundle, err error)

UpdateCertificateIssuerResponder handles the response to the UpdateCertificateIssuer request. The method always closes the http.Response Body.

func (BaseClient) UpdateCertificateIssuerSender Uses

func (client BaseClient) UpdateCertificateIssuerSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) UpdateCertificateOperation Uses

func (client BaseClient) UpdateCertificateOperation(ctx context.Context, vaultBaseURL string, certificateName string, certificateOperation CertificateOperationUpdateParameter) (result CertificateOperation, err error)

UpdateCertificateOperation updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate. certificateOperation - the certificate operation response.

func (BaseClient) UpdateCertificateOperationPreparer Uses

func (client BaseClient) UpdateCertificateOperationPreparer(ctx context.Context, vaultBaseURL string, certificateName string, certificateOperation CertificateOperationUpdateParameter) (*http.Request, error)

UpdateCertificateOperationPreparer prepares the UpdateCertificateOperation request.

func (BaseClient) UpdateCertificateOperationResponder Uses

func (client BaseClient) UpdateCertificateOperationResponder(resp *http.Response) (result CertificateOperation, err error)

UpdateCertificateOperationResponder handles the response to the UpdateCertificateOperation request. The method always closes the http.Response Body.

func (BaseClient) UpdateCertificateOperationSender Uses

func (client BaseClient) UpdateCertificateOperationSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) UpdateCertificatePolicy Uses

func (client BaseClient) UpdateCertificatePolicy(ctx context.Context, vaultBaseURL string, certificateName string, certificatePolicy CertificatePolicy) (result CertificatePolicy, err error)

UpdateCertificatePolicy set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. certificateName - the name of the certificate in the given vault. certificatePolicy - the policy for the certificate.

func (BaseClient) UpdateCertificatePolicyPreparer Uses

func (client BaseClient) UpdateCertificatePolicyPreparer(ctx context.Context, vaultBaseURL string, certificateName string, certificatePolicy CertificatePolicy) (*http.Request, error)

UpdateCertificatePolicyPreparer prepares the UpdateCertificatePolicy request.

func (BaseClient) UpdateCertificatePolicyResponder Uses

func (client BaseClient) UpdateCertificatePolicyResponder(resp *http.Response) (result CertificatePolicy, err error)

UpdateCertificatePolicyResponder handles the response to the UpdateCertificatePolicy request. The method always closes the http.Response Body.

func (BaseClient) UpdateCertificatePolicySender Uses

func (client BaseClient) UpdateCertificatePolicySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) UpdateCertificatePreparer Uses

func (client BaseClient) UpdateCertificatePreparer(ctx context.Context, vaultBaseURL string, certificateName string, certificateVersion string, parameters CertificateUpdateParameters) (*http.Request, error)

UpdateCertificatePreparer prepares the UpdateCertificate request.

func (BaseClient) UpdateCertificateResponder Uses

func (client BaseClient) UpdateCertificateResponder(resp *http.Response) (result CertificateBundle, err error)

UpdateCertificateResponder handles the response to the UpdateCertificate request. The method always closes the http.Response Body.

func (BaseClient) UpdateCertificateSender Uses

func (client BaseClient) UpdateCertificateSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) UpdateKey Uses

func (client BaseClient) UpdateKey(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyUpdateParameters) (result KeyBundle, err error)

UpdateKey in order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of key to update. keyVersion - the version of the key to update. parameters - the parameters of the key to update.

func (BaseClient) UpdateKeyPreparer Uses

func (client BaseClient) UpdateKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyUpdateParameters) (*http.Request, error)

UpdateKeyPreparer prepares the UpdateKey request.

func (BaseClient) UpdateKeyResponder Uses

func (client BaseClient) UpdateKeyResponder(resp *http.Response) (result KeyBundle, err error)

UpdateKeyResponder handles the response to the UpdateKey request. The method always closes the http.Response Body.

func (BaseClient) UpdateKeySender Uses

func (client BaseClient) UpdateKeySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) UpdateSasDefinition Uses

func (client BaseClient) UpdateSasDefinition(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string, parameters SasDefinitionUpdateParameters) (result SasDefinitionBundle, err error)

UpdateSasDefinition updates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. sasDefinitionName - the name of the SAS definition. parameters - the parameters to update a SAS definition.

func (BaseClient) UpdateSasDefinitionPreparer Uses

func (client BaseClient) UpdateSasDefinitionPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, sasDefinitionName string, parameters SasDefinitionUpdateParameters) (*http.Request, error)

UpdateSasDefinitionPreparer prepares the UpdateSasDefinition request.

func (BaseClient) UpdateSasDefinitionResponder Uses

func (client BaseClient) UpdateSasDefinitionResponder(resp *http.Response) (result SasDefinitionBundle, err error)

UpdateSasDefinitionResponder handles the response to the UpdateSasDefinition request. The method always closes the http.Response Body.

func (BaseClient) UpdateSasDefinitionSender Uses

func (client BaseClient) UpdateSasDefinitionSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) UpdateSecret Uses

func (client BaseClient) UpdateSecret(ctx context.Context, vaultBaseURL string, secretName string, secretVersion string, parameters SecretUpdateParameters) (result SecretBundle, err error)

UpdateSecret the UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the secrets/set permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. secretName - the name of the secret. secretVersion - the version of the secret. parameters - the parameters for update secret operation.

func (BaseClient) UpdateSecretPreparer Uses

func (client BaseClient) UpdateSecretPreparer(ctx context.Context, vaultBaseURL string, secretName string, secretVersion string, parameters SecretUpdateParameters) (*http.Request, error)

UpdateSecretPreparer prepares the UpdateSecret request.

func (BaseClient) UpdateSecretResponder Uses

func (client BaseClient) UpdateSecretResponder(resp *http.Response) (result SecretBundle, err error)

UpdateSecretResponder handles the response to the UpdateSecret request. The method always closes the http.Response Body.

func (BaseClient) UpdateSecretSender Uses

func (client BaseClient) UpdateSecretSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) UpdateStorageAccount Uses

func (client BaseClient) UpdateStorageAccount(ctx context.Context, vaultBaseURL string, storageAccountName string, parameters StorageAccountUpdateParameters) (result StorageBundle, err error)

UpdateStorageAccount updates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. storageAccountName - the name of the storage account. parameters - the parameters to update a storage account.

func (BaseClient) UpdateStorageAccountPreparer Uses

func (client BaseClient) UpdateStorageAccountPreparer(ctx context.Context, vaultBaseURL string, storageAccountName string, parameters StorageAccountUpdateParameters) (*http.Request, error)

UpdateStorageAccountPreparer prepares the UpdateStorageAccount request.

func (BaseClient) UpdateStorageAccountResponder Uses

func (client BaseClient) UpdateStorageAccountResponder(resp *http.Response) (result StorageBundle, err error)

UpdateStorageAccountResponder handles the response to the UpdateStorageAccount request. The method always closes the http.Response Body.

func (BaseClient) UpdateStorageAccountSender Uses

func (client BaseClient) UpdateStorageAccountSender(req *http.Request) (*http.Response, error)

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

func (BaseClient) Verify Uses

func (client BaseClient) Verify(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyVerifyParameters) (result KeyVerifyResult, err error)

Verify the VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key. keyVersion - the version of the key. parameters - the parameters for verify operations.

func (BaseClient) VerifyPreparer Uses

func (client BaseClient) VerifyPreparer(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyVerifyParameters) (*http.Request, error)

VerifyPreparer prepares the Verify request.

func (BaseClient) VerifyResponder Uses

func (client BaseClient) VerifyResponder(resp *http.Response) (result KeyVerifyResult, err error)

VerifyResponder handles the response to the Verify request. The method always closes the http.Response Body.

func (BaseClient) VerifySender Uses

func (client BaseClient) VerifySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) WrapKey Uses

func (client BaseClient) WrapKey(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyOperationsParameters) (result KeyOperationResult, err error)

WrapKey the WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/wrapKey permission. Parameters: vaultBaseURL - the vault name, for example https://myvault.vault.azure.net. keyName - the name of the key. keyVersion - the version of the key. parameters - the parameters for wrap operation.

func (BaseClient) WrapKeyPreparer Uses

func (client BaseClient) WrapKeyPreparer(ctx context.Context, vaultBaseURL string, keyName string, keyVersion string, parameters KeyOperationsParameters) (*http.Request, error)

WrapKeyPreparer prepares the WrapKey request.

func (BaseClient) WrapKeyResponder Uses

func (client BaseClient) WrapKeyResponder(resp *http.Response) (result KeyOperationResult, err error)

WrapKeyResponder handles the response to the WrapKey request. The method always closes the http.Response Body.

func (BaseClient) WrapKeySender Uses

func (client BaseClient) WrapKeySender(req *http.Request) (*http.Response, error)

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

type CertificateAttributes Uses

type CertificateAttributes struct {
    // RecoveryLevel - READ-ONLY; Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system can purge the certificate, at the end of the retention interval. Possible values include: 'Purgeable', 'RecoverablePurgeable', 'Recoverable', 'RecoverableProtectedSubscription'
    RecoveryLevel DeletionRecoveryLevel `json:"recoveryLevel,omitempty"`
    // Enabled - Determines whether the object is enabled.
    Enabled *bool `json:"enabled,omitempty"`
    // NotBefore - Not before date in UTC.
    NotBefore *date.UnixTime `json:"nbf,omitempty"`
    // Expires - Expiry date in UTC.
    Expires *date.UnixTime `json:"exp,omitempty"`
    // Created - READ-ONLY; Creation time in UTC.
    Created *date.UnixTime `json:"created,omitempty"`
    // Updated - READ-ONLY; Last updated time in UTC.
    Updated *date.UnixTime `json:"updated,omitempty"`
}

CertificateAttributes the certificate management attributes.

type CertificateBundle Uses

type CertificateBundle struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; The certificate id.
    ID  *string `json:"id,omitempty"`
    // Kid - READ-ONLY; The key id.
    Kid *string `json:"kid,omitempty"`
    // Sid - READ-ONLY; The secret id.
    Sid *string `json:"sid,omitempty"`
    // X509Thumbprint - READ-ONLY; Thumbprint of the certificate. (a URL-encoded base64 string)
    X509Thumbprint *string `json:"x5t,omitempty"`
    // Policy - READ-ONLY; The management policy.
    Policy *CertificatePolicy `json:"policy,omitempty"`
    // Cer - CER contents of x509 certificate.
    Cer *[]byte `json:"cer,omitempty"`
    // ContentType - The content type of the secret.
    ContentType *string `json:"contentType,omitempty"`
    // Attributes - The certificate attributes.
    Attributes *CertificateAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs
    Tags map[string]*string `json:"tags"`
}

CertificateBundle a certificate bundle consists of a certificate (X509) plus its attributes.

func (CertificateBundle) MarshalJSON Uses

func (cb CertificateBundle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateBundle.

type CertificateCreateParameters Uses

type CertificateCreateParameters struct {
    // CertificatePolicy - The management policy for the certificate.
    CertificatePolicy *CertificatePolicy `json:"policy,omitempty"`
    // CertificateAttributes - The attributes of the certificate (optional).
    CertificateAttributes *CertificateAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

CertificateCreateParameters the certificate create parameters.

func (CertificateCreateParameters) MarshalJSON Uses

func (ccp CertificateCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateCreateParameters.

type CertificateImportParameters Uses

type CertificateImportParameters struct {
    // Base64EncodedCertificate - Base64 encoded representation of the certificate object to import. This certificate needs to contain the private key.
    Base64EncodedCertificate *string `json:"value,omitempty"`
    // Password - If the private key in base64EncodedCertificate is encrypted, the password used for encryption.
    Password *string `json:"pwd,omitempty"`
    // CertificatePolicy - The management policy for the certificate.
    CertificatePolicy *CertificatePolicy `json:"policy,omitempty"`
    // CertificateAttributes - The attributes of the certificate (optional).
    CertificateAttributes *CertificateAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

CertificateImportParameters the certificate import parameters.

func (CertificateImportParameters) MarshalJSON Uses

func (cip CertificateImportParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateImportParameters.

type CertificateIssuerItem Uses

type CertificateIssuerItem struct {
    // ID - Certificate Identifier.
    ID  *string `json:"id,omitempty"`
    // Provider - The issuer provider.
    Provider *string `json:"provider,omitempty"`
}

CertificateIssuerItem the certificate issuer item containing certificate issuer metadata.

type CertificateIssuerListResult Uses

type CertificateIssuerListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of certificate issuers in the key vault along with a link to the next page of certificate issuers.
    Value *[]CertificateIssuerItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of certificate issuers.
    NextLink *string `json:"nextLink,omitempty"`
}

CertificateIssuerListResult the certificate issuer list result.

func (CertificateIssuerListResult) IsEmpty Uses

func (cilr CertificateIssuerListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CertificateIssuerListResultIterator Uses

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

CertificateIssuerListResultIterator provides access to a complete listing of CertificateIssuerItem values.

func NewCertificateIssuerListResultIterator Uses

func NewCertificateIssuerListResultIterator(page CertificateIssuerListResultPage) CertificateIssuerListResultIterator

Creates a new instance of the CertificateIssuerListResultIterator type.

func (*CertificateIssuerListResultIterator) Next Uses

func (iter *CertificateIssuerListResultIterator) 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 (*CertificateIssuerListResultIterator) NextWithContext Uses

func (iter *CertificateIssuerListResultIterator) 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 (CertificateIssuerListResultIterator) NotDone Uses

func (iter CertificateIssuerListResultIterator) NotDone() bool

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

func (CertificateIssuerListResultIterator) Response Uses

func (iter CertificateIssuerListResultIterator) Response() CertificateIssuerListResult

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

func (CertificateIssuerListResultIterator) Value Uses

func (iter CertificateIssuerListResultIterator) Value() CertificateIssuerItem

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

type CertificateIssuerListResultPage Uses

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

CertificateIssuerListResultPage contains a page of CertificateIssuerItem values.

func NewCertificateIssuerListResultPage Uses

func NewCertificateIssuerListResultPage(getNextPage func(context.Context, CertificateIssuerListResult) (CertificateIssuerListResult, error)) CertificateIssuerListResultPage

Creates a new instance of the CertificateIssuerListResultPage type.

func (*CertificateIssuerListResultPage) Next Uses

func (page *CertificateIssuerListResultPage) 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 (*CertificateIssuerListResultPage) NextWithContext Uses

func (page *CertificateIssuerListResultPage) 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 (CertificateIssuerListResultPage) NotDone Uses

func (page CertificateIssuerListResultPage) NotDone() bool

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

func (CertificateIssuerListResultPage) Response Uses

func (page CertificateIssuerListResultPage) Response() CertificateIssuerListResult

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

func (CertificateIssuerListResultPage) Values Uses

func (page CertificateIssuerListResultPage) Values() []CertificateIssuerItem

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

type CertificateIssuerSetParameters Uses

type CertificateIssuerSetParameters struct {
    // Provider - The issuer provider.
    Provider *string `json:"provider,omitempty"`
    // Credentials - The credentials to be used for the issuer.
    Credentials *IssuerCredentials `json:"credentials,omitempty"`
    // OrganizationDetails - Details of the organization as provided to the issuer.
    OrganizationDetails *OrganizationDetails `json:"org_details,omitempty"`
    // Attributes - Attributes of the issuer object.
    Attributes *IssuerAttributes `json:"attributes,omitempty"`
}

CertificateIssuerSetParameters the certificate issuer set parameters.

type CertificateIssuerUpdateParameters Uses

type CertificateIssuerUpdateParameters struct {
    // Provider - The issuer provider.
    Provider *string `json:"provider,omitempty"`
    // Credentials - The credentials to be used for the issuer.
    Credentials *IssuerCredentials `json:"credentials,omitempty"`
    // OrganizationDetails - Details of the organization as provided to the issuer.
    OrganizationDetails *OrganizationDetails `json:"org_details,omitempty"`
    // Attributes - Attributes of the issuer object.
    Attributes *IssuerAttributes `json:"attributes,omitempty"`
}

CertificateIssuerUpdateParameters the certificate issuer update parameters.

type CertificateItem Uses

type CertificateItem struct {
    // ID - Certificate identifier.
    ID  *string `json:"id,omitempty"`
    // Attributes - The certificate management attributes.
    Attributes *CertificateAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // X509Thumbprint - Thumbprint of the certificate. (a URL-encoded base64 string)
    X509Thumbprint *string `json:"x5t,omitempty"`
}

CertificateItem the certificate item containing certificate metadata.

func (CertificateItem) MarshalJSON Uses

func (ci CertificateItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateItem.

type CertificateListResult Uses

type CertificateListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of certificates in the key vault along with a link to the next page of certificates.
    Value *[]CertificateItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of certificates.
    NextLink *string `json:"nextLink,omitempty"`
}

CertificateListResult the certificate list result.

func (CertificateListResult) IsEmpty Uses

func (clr CertificateListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CertificateListResultIterator Uses

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

CertificateListResultIterator provides access to a complete listing of CertificateItem values.

func NewCertificateListResultIterator Uses

func NewCertificateListResultIterator(page CertificateListResultPage) CertificateListResultIterator

Creates a new instance of the CertificateListResultIterator type.

func (*CertificateListResultIterator) Next Uses

func (iter *CertificateListResultIterator) 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 (*CertificateListResultIterator) NextWithContext Uses

func (iter *CertificateListResultIterator) 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 (CertificateListResultIterator) NotDone Uses

func (iter CertificateListResultIterator) NotDone() bool

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

func (CertificateListResultIterator) Response Uses

func (iter CertificateListResultIterator) Response() CertificateListResult

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

func (CertificateListResultIterator) Value Uses

func (iter CertificateListResultIterator) Value() CertificateItem

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

type CertificateListResultPage Uses

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

CertificateListResultPage contains a page of CertificateItem values.

func NewCertificateListResultPage Uses

func NewCertificateListResultPage(getNextPage func(context.Context, CertificateListResult) (CertificateListResult, error)) CertificateListResultPage

Creates a new instance of the CertificateListResultPage type.

func (*CertificateListResultPage) Next Uses

func (page *CertificateListResultPage) 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 (*CertificateListResultPage) NextWithContext Uses

func (page *CertificateListResultPage) 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 (CertificateListResultPage) NotDone Uses

func (page CertificateListResultPage) NotDone() bool

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

func (CertificateListResultPage) Response Uses

func (page CertificateListResultPage) Response() CertificateListResult

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

func (CertificateListResultPage) Values Uses

func (page CertificateListResultPage) Values() []CertificateItem

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

type CertificateMergeParameters Uses

type CertificateMergeParameters struct {
    // X509Certificates - The certificate or the certificate chain to merge.
    X509Certificates *[][]byte `json:"x5c,omitempty"`
    // CertificateAttributes - The attributes of the certificate (optional).
    CertificateAttributes *CertificateAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

CertificateMergeParameters the certificate merge parameters

func (CertificateMergeParameters) MarshalJSON Uses

func (cmp CertificateMergeParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateMergeParameters.

type CertificateOperation Uses

type CertificateOperation struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; The certificate id.
    ID  *string `json:"id,omitempty"`
    // IssuerParameters - Parameters for the issuer of the X509 component of a certificate.
    IssuerParameters *IssuerParameters `json:"issuer,omitempty"`
    // Csr - The certificate signing request (CSR) that is being used in the certificate operation.
    Csr *[]byte `json:"csr,omitempty"`
    // CancellationRequested - Indicates if cancellation was requested on the certificate operation.
    CancellationRequested *bool `json:"cancellation_requested,omitempty"`
    // Status - Status of the certificate operation.
    Status *string `json:"status,omitempty"`
    // StatusDetails - The status details of the certificate operation.
    StatusDetails *string `json:"status_details,omitempty"`
    // Error - Error encountered, if any, during the certificate operation.
    Error *Error `json:"error,omitempty"`
    // Target - Location which contains the result of the certificate operation.
    Target *string `json:"target,omitempty"`
    // RequestID - Identifier for the certificate operation.
    RequestID *string `json:"request_id,omitempty"`
}

CertificateOperation a certificate operation is returned in case of asynchronous requests.

type CertificateOperationUpdateParameter Uses

type CertificateOperationUpdateParameter struct {
    // CancellationRequested - Indicates if cancellation was requested on the certificate operation.
    CancellationRequested *bool `json:"cancellation_requested,omitempty"`
}

CertificateOperationUpdateParameter the certificate operation update parameters.

type CertificatePolicy Uses

type CertificatePolicy struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; The certificate id.
    ID  *string `json:"id,omitempty"`
    // KeyProperties - Properties of the key backing a certificate.
    KeyProperties *KeyProperties `json:"key_props,omitempty"`
    // SecretProperties - Properties of the secret backing a certificate.
    SecretProperties *SecretProperties `json:"secret_props,omitempty"`
    // X509CertificateProperties - Properties of the X509 component of a certificate.
    X509CertificateProperties *X509CertificateProperties `json:"x509_props,omitempty"`
    // LifetimeActions - Actions that will be performed by Key Vault over the lifetime of a certificate.
    LifetimeActions *[]LifetimeAction `json:"lifetime_actions,omitempty"`
    // IssuerParameters - Parameters for the issuer of the X509 component of a certificate.
    IssuerParameters *IssuerParameters `json:"issuer,omitempty"`
    // Attributes - The certificate attributes.
    Attributes *CertificateAttributes `json:"attributes,omitempty"`
}

CertificatePolicy management policy for a certificate.

type CertificateRestoreParameters Uses

type CertificateRestoreParameters struct {
    // CertificateBundleBackup - The backup blob associated with a certificate bundle. (a URL-encoded base64 string)
    CertificateBundleBackup *string `json:"value,omitempty"`
}

CertificateRestoreParameters the certificate restore parameters.

type CertificateUpdateParameters Uses

type CertificateUpdateParameters struct {
    // CertificatePolicy - The management policy for the certificate.
    CertificatePolicy *CertificatePolicy `json:"policy,omitempty"`
    // CertificateAttributes - The attributes of the certificate (optional).
    CertificateAttributes *CertificateAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

CertificateUpdateParameters the certificate update parameters.

func (CertificateUpdateParameters) MarshalJSON Uses

func (cup CertificateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CertificateUpdateParameters.

type Contact Uses

type Contact struct {
    // EmailAddress - Email address.
    EmailAddress *string `json:"email,omitempty"`
    // Name - Name.
    Name *string `json:"name,omitempty"`
    // Phone - Phone number.
    Phone *string `json:"phone,omitempty"`
}

Contact the contact information for the vault certificates.

type Contacts Uses

type Contacts struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Identifier for the contacts collection.
    ID  *string `json:"id,omitempty"`
    // ContactList - The contact list for the vault certificates.
    ContactList *[]Contact `json:"contacts,omitempty"`
}

Contacts the contacts for the vault certificates.

type DeletedCertificateBundle Uses

type DeletedCertificateBundle struct {
    autorest.Response `json:"-"`
    // RecoveryID - The url of the recovery object, used to identify and recover the deleted certificate.
    RecoveryID *string `json:"recoveryId,omitempty"`
    // ScheduledPurgeDate - READ-ONLY; The time when the certificate is scheduled to be purged, in UTC
    ScheduledPurgeDate *date.UnixTime `json:"scheduledPurgeDate,omitempty"`
    // DeletedDate - READ-ONLY; The time when the certificate was deleted, in UTC
    DeletedDate *date.UnixTime `json:"deletedDate,omitempty"`
    // ID - READ-ONLY; The certificate id.
    ID  *string `json:"id,omitempty"`
    // Kid - READ-ONLY; The key id.
    Kid *string `json:"kid,omitempty"`
    // Sid - READ-ONLY; The secret id.
    Sid *string `json:"sid,omitempty"`
    // X509Thumbprint - READ-ONLY; Thumbprint of the certificate. (a URL-encoded base64 string)
    X509Thumbprint *string `json:"x5t,omitempty"`
    // Policy - READ-ONLY; The management policy.
    Policy *CertificatePolicy `json:"policy,omitempty"`
    // Cer - CER contents of x509 certificate.
    Cer *[]byte `json:"cer,omitempty"`
    // ContentType - The content type of the secret.
    ContentType *string `json:"contentType,omitempty"`
    // Attributes - The certificate attributes.
    Attributes *CertificateAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs
    Tags map[string]*string `json:"tags"`
}

DeletedCertificateBundle a Deleted Certificate consisting of its previous id, attributes and its tags, as well as information on when it will be purged.

func (DeletedCertificateBundle) MarshalJSON Uses

func (dcb DeletedCertificateBundle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedCertificateBundle.

type DeletedCertificateItem Uses

type DeletedCertificateItem struct {
    // RecoveryID - The url of the recovery object, used to identify and recover the deleted certificate.
    RecoveryID *string `json:"recoveryId,omitempty"`
    // ScheduledPurgeDate - READ-ONLY; The time when the certificate is scheduled to be purged, in UTC
    ScheduledPurgeDate *date.UnixTime `json:"scheduledPurgeDate,omitempty"`
    // DeletedDate - READ-ONLY; The time when the certificate was deleted, in UTC
    DeletedDate *date.UnixTime `json:"deletedDate,omitempty"`
    // ID - Certificate identifier.
    ID  *string `json:"id,omitempty"`
    // Attributes - The certificate management attributes.
    Attributes *CertificateAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // X509Thumbprint - Thumbprint of the certificate. (a URL-encoded base64 string)
    X509Thumbprint *string `json:"x5t,omitempty"`
}

DeletedCertificateItem the deleted certificate item containing metadata about the deleted certificate.

func (DeletedCertificateItem) MarshalJSON Uses

func (dci DeletedCertificateItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedCertificateItem.

type DeletedCertificateListResult Uses

type DeletedCertificateListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of deleted certificates in the vault along with a link to the next page of deleted certificates
    Value *[]DeletedCertificateItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of deleted certificates.
    NextLink *string `json:"nextLink,omitempty"`
}

DeletedCertificateListResult a list of certificates that have been deleted in this vault.

func (DeletedCertificateListResult) IsEmpty Uses

func (dclr DeletedCertificateListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeletedCertificateListResultIterator Uses

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

DeletedCertificateListResultIterator provides access to a complete listing of DeletedCertificateItem values.

func NewDeletedCertificateListResultIterator Uses

func NewDeletedCertificateListResultIterator(page DeletedCertificateListResultPage) DeletedCertificateListResultIterator

Creates a new instance of the DeletedCertificateListResultIterator type.

func (*DeletedCertificateListResultIterator) Next Uses

func (iter *DeletedCertificateListResultIterator) 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 (*DeletedCertificateListResultIterator) NextWithContext Uses

func (iter *DeletedCertificateListResultIterator) 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 (DeletedCertificateListResultIterator) NotDone Uses

func (iter DeletedCertificateListResultIterator) NotDone() bool

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

func (DeletedCertificateListResultIterator) Response Uses

func (iter DeletedCertificateListResultIterator) Response() DeletedCertificateListResult

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

func (DeletedCertificateListResultIterator) Value Uses

func (iter DeletedCertificateListResultIterator) Value() DeletedCertificateItem

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

type DeletedCertificateListResultPage Uses

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

DeletedCertificateListResultPage contains a page of DeletedCertificateItem values.

func NewDeletedCertificateListResultPage Uses

func NewDeletedCertificateListResultPage(getNextPage func(context.Context, DeletedCertificateListResult) (DeletedCertificateListResult, error)) DeletedCertificateListResultPage

Creates a new instance of the DeletedCertificateListResultPage type.

func (*DeletedCertificateListResultPage) Next Uses

func (page *DeletedCertificateListResultPage) 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 (*DeletedCertificateListResultPage) NextWithContext Uses

func (page *DeletedCertificateListResultPage) 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 (DeletedCertificateListResultPage) NotDone Uses

func (page DeletedCertificateListResultPage) NotDone() bool

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

func (DeletedCertificateListResultPage) Response Uses

func (page DeletedCertificateListResultPage) Response() DeletedCertificateListResult

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

func (DeletedCertificateListResultPage) Values Uses

func (page DeletedCertificateListResultPage) Values() []DeletedCertificateItem

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

type DeletedKeyBundle Uses

type DeletedKeyBundle struct {
    autorest.Response `json:"-"`
    // RecoveryID - The url of the recovery object, used to identify and recover the deleted key.
    RecoveryID *string `json:"recoveryId,omitempty"`
    // ScheduledPurgeDate - READ-ONLY; The time when the key is scheduled to be purged, in UTC
    ScheduledPurgeDate *date.UnixTime `json:"scheduledPurgeDate,omitempty"`
    // DeletedDate - READ-ONLY; The time when the key was deleted, in UTC
    DeletedDate *date.UnixTime `json:"deletedDate,omitempty"`
    // Key - The Json web key.
    Key *JSONWebKey `json:"key,omitempty"`
    // Attributes - The key management attributes.
    Attributes *KeyAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // Managed - READ-ONLY; True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
    Managed *bool `json:"managed,omitempty"`
}

DeletedKeyBundle a DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion info

func (DeletedKeyBundle) MarshalJSON Uses

func (dkb DeletedKeyBundle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedKeyBundle.

type DeletedKeyItem Uses

type DeletedKeyItem struct {
    // RecoveryID - The url of the recovery object, used to identify and recover the deleted key.
    RecoveryID *string `json:"recoveryId,omitempty"`
    // ScheduledPurgeDate - READ-ONLY; The time when the key is scheduled to be purged, in UTC
    ScheduledPurgeDate *date.UnixTime `json:"scheduledPurgeDate,omitempty"`
    // DeletedDate - READ-ONLY; The time when the key was deleted, in UTC
    DeletedDate *date.UnixTime `json:"deletedDate,omitempty"`
    // Kid - Key identifier.
    Kid *string `json:"kid,omitempty"`
    // Attributes - The key management attributes.
    Attributes *KeyAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // Managed - READ-ONLY; True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
    Managed *bool `json:"managed,omitempty"`
}

DeletedKeyItem the deleted key item containing the deleted key metadata and information about deletion.

func (DeletedKeyItem) MarshalJSON Uses

func (dki DeletedKeyItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedKeyItem.

type DeletedKeyListResult Uses

type DeletedKeyListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of deleted keys in the vault along with a link to the next page of deleted keys
    Value *[]DeletedKeyItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of deleted keys.
    NextLink *string `json:"nextLink,omitempty"`
}

DeletedKeyListResult a list of keys that have been deleted in this vault.

func (DeletedKeyListResult) IsEmpty Uses

func (dklr DeletedKeyListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeletedKeyListResultIterator Uses

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

DeletedKeyListResultIterator provides access to a complete listing of DeletedKeyItem values.

func NewDeletedKeyListResultIterator Uses

func NewDeletedKeyListResultIterator(page DeletedKeyListResultPage) DeletedKeyListResultIterator

Creates a new instance of the DeletedKeyListResultIterator type.

func (*DeletedKeyListResultIterator) Next Uses

func (iter *DeletedKeyListResultIterator) 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 (*DeletedKeyListResultIterator) NextWithContext Uses

func (iter *DeletedKeyListResultIterator) 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 (DeletedKeyListResultIterator) NotDone Uses

func (iter DeletedKeyListResultIterator) NotDone() bool

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

func (DeletedKeyListResultIterator) Response Uses

func (iter DeletedKeyListResultIterator) Response() DeletedKeyListResult

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

func (DeletedKeyListResultIterator) Value Uses

func (iter DeletedKeyListResultIterator) Value() DeletedKeyItem

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

type DeletedKeyListResultPage Uses

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

DeletedKeyListResultPage contains a page of DeletedKeyItem values.

func NewDeletedKeyListResultPage Uses

func NewDeletedKeyListResultPage(getNextPage func(context.Context, DeletedKeyListResult) (DeletedKeyListResult, error)) DeletedKeyListResultPage

Creates a new instance of the DeletedKeyListResultPage type.

func (*DeletedKeyListResultPage) Next Uses

func (page *DeletedKeyListResultPage) 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 (*DeletedKeyListResultPage) NextWithContext Uses

func (page *DeletedKeyListResultPage) 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 (DeletedKeyListResultPage) NotDone Uses

func (page DeletedKeyListResultPage) NotDone() bool

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

func (DeletedKeyListResultPage) Response Uses

func (page DeletedKeyListResultPage) Response() DeletedKeyListResult

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

func (DeletedKeyListResultPage) Values Uses

func (page DeletedKeyListResultPage) Values() []DeletedKeyItem

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

type DeletedSasDefinitionBundle Uses

type DeletedSasDefinitionBundle struct {
    autorest.Response `json:"-"`
    // RecoveryID - The url of the recovery object, used to identify and recover the deleted SAS definition.
    RecoveryID *string `json:"recoveryId,omitempty"`
    // ScheduledPurgeDate - READ-ONLY; The time when the SAS definition is scheduled to be purged, in UTC
    ScheduledPurgeDate *date.UnixTime `json:"scheduledPurgeDate,omitempty"`
    // DeletedDate - READ-ONLY; The time when the SAS definition was deleted, in UTC
    DeletedDate *date.UnixTime `json:"deletedDate,omitempty"`
    // ID - READ-ONLY; The SAS definition id.
    ID  *string `json:"id,omitempty"`
    // SecretID - READ-ONLY; Storage account SAS definition secret id.
    SecretID *string `json:"sid,omitempty"`
    // TemplateURI - READ-ONLY; The SAS definition token template signed with an arbitrary key.  Tokens created according to the SAS definition will have the same properties as the template.
    TemplateURI *string `json:"templateUri,omitempty"`
    // SasType - READ-ONLY; The type of SAS token the SAS definition will create. Possible values include: 'Account', 'Service'
    SasType SasTokenType `json:"sasType,omitempty"`
    // ValidityPeriod - READ-ONLY; The validity period of SAS tokens created according to the SAS definition.
    ValidityPeriod *string `json:"validityPeriod,omitempty"`
    // Attributes - READ-ONLY; The SAS definition attributes.
    Attributes *SasDefinitionAttributes `json:"attributes,omitempty"`
    // Tags - READ-ONLY; Application specific metadata in the form of key-value pairs
    Tags map[string]*string `json:"tags"`
}

DeletedSasDefinitionBundle a deleted SAS definition bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged.

func (DeletedSasDefinitionBundle) MarshalJSON Uses

func (dsdb DeletedSasDefinitionBundle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedSasDefinitionBundle.

type DeletedSasDefinitionItem Uses

type DeletedSasDefinitionItem struct {
    // RecoveryID - The url of the recovery object, used to identify and recover the deleted SAS definition.
    RecoveryID *string `json:"recoveryId,omitempty"`
    // ScheduledPurgeDate - READ-ONLY; The time when the SAS definition is scheduled to be purged, in UTC
    ScheduledPurgeDate *date.UnixTime `json:"scheduledPurgeDate,omitempty"`
    // DeletedDate - READ-ONLY; The time when the SAS definition was deleted, in UTC
    DeletedDate *date.UnixTime `json:"deletedDate,omitempty"`
    // ID - READ-ONLY; The storage SAS identifier.
    ID  *string `json:"id,omitempty"`
    // SecretID - READ-ONLY; The storage account SAS definition secret id.
    SecretID *string `json:"sid,omitempty"`
    // Attributes - READ-ONLY; The SAS definition management attributes.
    Attributes *SasDefinitionAttributes `json:"attributes,omitempty"`
    // Tags - READ-ONLY; Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

DeletedSasDefinitionItem the deleted SAS definition item containing metadata about the deleted SAS definition.

func (DeletedSasDefinitionItem) MarshalJSON Uses

func (dsdi DeletedSasDefinitionItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedSasDefinitionItem.

type DeletedSasDefinitionListResult Uses

type DeletedSasDefinitionListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of the deleted SAS definitions in the vault along with a link to the next page of deleted sas definitions
    Value *[]DeletedSasDefinitionItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of deleted SAS definitions.
    NextLink *string `json:"nextLink,omitempty"`
}

DeletedSasDefinitionListResult the deleted SAS definition list result

func (DeletedSasDefinitionListResult) IsEmpty Uses

func (dsdlr DeletedSasDefinitionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeletedSasDefinitionListResultIterator Uses

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

DeletedSasDefinitionListResultIterator provides access to a complete listing of DeletedSasDefinitionItem values.

func NewDeletedSasDefinitionListResultIterator Uses

func NewDeletedSasDefinitionListResultIterator(page DeletedSasDefinitionListResultPage) DeletedSasDefinitionListResultIterator

Creates a new instance of the DeletedSasDefinitionListResultIterator type.

func (*DeletedSasDefinitionListResultIterator) Next Uses

func (iter *DeletedSasDefinitionListResultIterator) 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 (*DeletedSasDefinitionListResultIterator) NextWithContext Uses

func (iter *DeletedSasDefinitionListResultIterator) 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 (DeletedSasDefinitionListResultIterator) NotDone Uses

func (iter DeletedSasDefinitionListResultIterator) NotDone() bool

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

func (DeletedSasDefinitionListResultIterator) Response Uses

func (iter DeletedSasDefinitionListResultIterator) Response() DeletedSasDefinitionListResult

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

func (DeletedSasDefinitionListResultIterator) Value Uses

func (iter DeletedSasDefinitionListResultIterator) Value() DeletedSasDefinitionItem

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

type DeletedSasDefinitionListResultPage Uses

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

DeletedSasDefinitionListResultPage contains a page of DeletedSasDefinitionItem values.

func NewDeletedSasDefinitionListResultPage Uses

func NewDeletedSasDefinitionListResultPage(getNextPage func(context.Context, DeletedSasDefinitionListResult) (DeletedSasDefinitionListResult, error)) DeletedSasDefinitionListResultPage

Creates a new instance of the DeletedSasDefinitionListResultPage type.

func (*DeletedSasDefinitionListResultPage) Next Uses

func (page *DeletedSasDefinitionListResultPage) 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 (*DeletedSasDefinitionListResultPage) NextWithContext Uses

func (page *DeletedSasDefinitionListResultPage) 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 (DeletedSasDefinitionListResultPage) NotDone Uses

func (page DeletedSasDefinitionListResultPage) NotDone() bool

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

func (DeletedSasDefinitionListResultPage) Response Uses

func (page DeletedSasDefinitionListResultPage) Response() DeletedSasDefinitionListResult

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

func (DeletedSasDefinitionListResultPage) Values Uses

func (page DeletedSasDefinitionListResultPage) Values() []DeletedSasDefinitionItem

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

type DeletedSecretBundle Uses

type DeletedSecretBundle struct {
    autorest.Response `json:"-"`
    // RecoveryID - The url of the recovery object, used to identify and recover the deleted secret.
    RecoveryID *string `json:"recoveryId,omitempty"`
    // ScheduledPurgeDate - READ-ONLY; The time when the secret is scheduled to be purged, in UTC
    ScheduledPurgeDate *date.UnixTime `json:"scheduledPurgeDate,omitempty"`
    // DeletedDate - READ-ONLY; The time when the secret was deleted, in UTC
    DeletedDate *date.UnixTime `json:"deletedDate,omitempty"`
    // Value - The secret value.
    Value *string `json:"value,omitempty"`
    // ID - The secret id.
    ID  *string `json:"id,omitempty"`
    // ContentType - The content type of the secret.
    ContentType *string `json:"contentType,omitempty"`
    // Attributes - The secret management attributes.
    Attributes *SecretAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // Kid - READ-ONLY; If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.
    Kid *string `json:"kid,omitempty"`
    // Managed - READ-ONLY; True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.
    Managed *bool `json:"managed,omitempty"`
}

DeletedSecretBundle a Deleted Secret consisting of its previous id, attributes and its tags, as well as information on when it will be purged.

func (DeletedSecretBundle) MarshalJSON Uses

func (dsb DeletedSecretBundle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedSecretBundle.

type DeletedSecretItem Uses

type DeletedSecretItem struct {
    // RecoveryID - The url of the recovery object, used to identify and recover the deleted secret.
    RecoveryID *string `json:"recoveryId,omitempty"`
    // ScheduledPurgeDate - READ-ONLY; The time when the secret is scheduled to be purged, in UTC
    ScheduledPurgeDate *date.UnixTime `json:"scheduledPurgeDate,omitempty"`
    // DeletedDate - READ-ONLY; The time when the secret was deleted, in UTC
    DeletedDate *date.UnixTime `json:"deletedDate,omitempty"`
    // ID - Secret identifier.
    ID  *string `json:"id,omitempty"`
    // Attributes - The secret management attributes.
    Attributes *SecretAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // ContentType - Type of the secret value such as a password.
    ContentType *string `json:"contentType,omitempty"`
    // Managed - READ-ONLY; True if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
    Managed *bool `json:"managed,omitempty"`
}

DeletedSecretItem the deleted secret item containing metadata about the deleted secret.

func (DeletedSecretItem) MarshalJSON Uses

func (dsi DeletedSecretItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedSecretItem.

type DeletedSecretListResult Uses

type DeletedSecretListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of the deleted secrets in the vault along with a link to the next page of deleted secrets
    Value *[]DeletedSecretItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of deleted secrets.
    NextLink *string `json:"nextLink,omitempty"`
}

DeletedSecretListResult the deleted secret list result

func (DeletedSecretListResult) IsEmpty Uses

func (dslr DeletedSecretListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeletedSecretListResultIterator Uses

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

DeletedSecretListResultIterator provides access to a complete listing of DeletedSecretItem values.

func NewDeletedSecretListResultIterator Uses

func NewDeletedSecretListResultIterator(page DeletedSecretListResultPage) DeletedSecretListResultIterator

Creates a new instance of the DeletedSecretListResultIterator type.

func (*DeletedSecretListResultIterator) Next Uses

func (iter *DeletedSecretListResultIterator) 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 (*DeletedSecretListResultIterator) NextWithContext Uses

func (iter *DeletedSecretListResultIterator) 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 (DeletedSecretListResultIterator) NotDone Uses

func (iter DeletedSecretListResultIterator) NotDone() bool

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

func (DeletedSecretListResultIterator) Response Uses

func (iter DeletedSecretListResultIterator) Response() DeletedSecretListResult

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

func (DeletedSecretListResultIterator) Value Uses

func (iter DeletedSecretListResultIterator) Value() DeletedSecretItem

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

type DeletedSecretListResultPage Uses

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

DeletedSecretListResultPage contains a page of DeletedSecretItem values.

func NewDeletedSecretListResultPage Uses

func NewDeletedSecretListResultPage(getNextPage func(context.Context, DeletedSecretListResult) (DeletedSecretListResult, error)) DeletedSecretListResultPage

Creates a new instance of the DeletedSecretListResultPage type.

func (*DeletedSecretListResultPage) Next Uses

func (page *DeletedSecretListResultPage) 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 (*DeletedSecretListResultPage) NextWithContext Uses

func (page *DeletedSecretListResultPage) 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 (DeletedSecretListResultPage) NotDone Uses

func (page DeletedSecretListResultPage) NotDone() bool

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

func (DeletedSecretListResultPage) Response Uses

func (page DeletedSecretListResultPage) Response() DeletedSecretListResult

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

func (DeletedSecretListResultPage) Values Uses

func (page DeletedSecretListResultPage) Values() []DeletedSecretItem

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

type DeletedStorageAccountItem Uses

type DeletedStorageAccountItem struct {
    // RecoveryID - The url of the recovery object, used to identify and recover the deleted storage account.
    RecoveryID *string `json:"recoveryId,omitempty"`
    // ScheduledPurgeDate - READ-ONLY; The time when the storage account is scheduled to be purged, in UTC
    ScheduledPurgeDate *date.UnixTime `json:"scheduledPurgeDate,omitempty"`
    // DeletedDate - READ-ONLY; The time when the storage account was deleted, in UTC
    DeletedDate *date.UnixTime `json:"deletedDate,omitempty"`
    // ID - READ-ONLY; Storage identifier.
    ID  *string `json:"id,omitempty"`
    // ResourceID - READ-ONLY; Storage account resource Id.
    ResourceID *string `json:"resourceId,omitempty"`
    // Attributes - READ-ONLY; The storage account management attributes.
    Attributes *StorageAccountAttributes `json:"attributes,omitempty"`
    // Tags - READ-ONLY; Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

DeletedStorageAccountItem the deleted storage account item containing metadata about the deleted storage account.

func (DeletedStorageAccountItem) MarshalJSON Uses

func (dsai DeletedStorageAccountItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedStorageAccountItem.

type DeletedStorageBundle Uses

type DeletedStorageBundle struct {
    autorest.Response `json:"-"`
    // RecoveryID - The url of the recovery object, used to identify and recover the deleted storage account.
    RecoveryID *string `json:"recoveryId,omitempty"`
    // ScheduledPurgeDate - READ-ONLY; The time when the storage account is scheduled to be purged, in UTC
    ScheduledPurgeDate *date.UnixTime `json:"scheduledPurgeDate,omitempty"`
    // DeletedDate - READ-ONLY; The time when the storage account was deleted, in UTC
    DeletedDate *date.UnixTime `json:"deletedDate,omitempty"`
    // ID - READ-ONLY; The storage account id.
    ID  *string `json:"id,omitempty"`
    // ResourceID - READ-ONLY; The storage account resource id.
    ResourceID *string `json:"resourceId,omitempty"`
    // ActiveKeyName - READ-ONLY; The current active storage account key name.
    ActiveKeyName *string `json:"activeKeyName,omitempty"`
    // AutoRegenerateKey - READ-ONLY; whether keyvault should manage the storage account for the user.
    AutoRegenerateKey *bool `json:"autoRegenerateKey,omitempty"`
    // RegenerationPeriod - READ-ONLY; The key regeneration time duration specified in ISO-8601 format.
    RegenerationPeriod *string `json:"regenerationPeriod,omitempty"`
    // Attributes - READ-ONLY; The storage account attributes.
    Attributes *StorageAccountAttributes `json:"attributes,omitempty"`
    // Tags - READ-ONLY; Application specific metadata in the form of key-value pairs
    Tags map[string]*string `json:"tags"`
}

DeletedStorageBundle a deleted storage account bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged.

func (DeletedStorageBundle) MarshalJSON Uses

func (dsb DeletedStorageBundle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedStorageBundle.

type DeletedStorageListResult Uses

type DeletedStorageListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of the deleted storage accounts in the vault along with a link to the next page of deleted storage accounts
    Value *[]DeletedStorageAccountItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of deleted storage accounts.
    NextLink *string `json:"nextLink,omitempty"`
}

DeletedStorageListResult the deleted storage account list result

func (DeletedStorageListResult) IsEmpty Uses

func (dslr DeletedStorageListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeletedStorageListResultIterator Uses

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

DeletedStorageListResultIterator provides access to a complete listing of DeletedStorageAccountItem values.

func NewDeletedStorageListResultIterator Uses

func NewDeletedStorageListResultIterator(page DeletedStorageListResultPage) DeletedStorageListResultIterator

Creates a new instance of the DeletedStorageListResultIterator type.

func (*DeletedStorageListResultIterator) Next Uses

func (iter *DeletedStorageListResultIterator) 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 (*DeletedStorageListResultIterator) NextWithContext Uses

func (iter *DeletedStorageListResultIterator) 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 (DeletedStorageListResultIterator) NotDone Uses

func (iter DeletedStorageListResultIterator) NotDone() bool

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

func (DeletedStorageListResultIterator) Response Uses

func (iter DeletedStorageListResultIterator) Response() DeletedStorageListResult

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

func (DeletedStorageListResultIterator) Value Uses

func (iter DeletedStorageListResultIterator) Value() DeletedStorageAccountItem

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

type DeletedStorageListResultPage Uses

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

DeletedStorageListResultPage contains a page of DeletedStorageAccountItem values.

func NewDeletedStorageListResultPage Uses

func NewDeletedStorageListResultPage(getNextPage func(context.Context, DeletedStorageListResult) (DeletedStorageListResult, error)) DeletedStorageListResultPage

Creates a new instance of the DeletedStorageListResultPage type.

func (*DeletedStorageListResultPage) Next Uses

func (page *DeletedStorageListResultPage) 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 (*DeletedStorageListResultPage) NextWithContext Uses

func (page *DeletedStorageListResultPage) 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 (DeletedStorageListResultPage) NotDone Uses

func (page DeletedStorageListResultPage) NotDone() bool

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

func (DeletedStorageListResultPage) Response Uses

func (page DeletedStorageListResultPage) Response() DeletedStorageListResult

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

func (DeletedStorageListResultPage) Values Uses

func (page DeletedStorageListResultPage) Values() []DeletedStorageAccountItem

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

type DeletionRecoveryLevel Uses

type DeletionRecoveryLevel string

DeletionRecoveryLevel enumerates the values for deletion recovery level.

const (
    // Purgeable ...
    Purgeable DeletionRecoveryLevel = "Purgeable"
    // Recoverable ...
    Recoverable DeletionRecoveryLevel = "Recoverable"
    // RecoverableProtectedSubscription ...
    RecoverableProtectedSubscription DeletionRecoveryLevel = "Recoverable+ProtectedSubscription"
    // RecoverablePurgeable ...
    RecoverablePurgeable DeletionRecoveryLevel = "Recoverable+Purgeable"
)

func PossibleDeletionRecoveryLevelValues Uses

func PossibleDeletionRecoveryLevelValues() []DeletionRecoveryLevel

PossibleDeletionRecoveryLevelValues returns an array of possible values for the DeletionRecoveryLevel const type.

type Error Uses

type Error struct {
    // Code - READ-ONLY; The error code.
    Code *string `json:"code,omitempty"`
    // Message - READ-ONLY; The error message.
    Message *string `json:"message,omitempty"`
    // InnerError - READ-ONLY
    InnerError *Error `json:"innererror,omitempty"`
}

Error the key vault server error.

type ErrorType Uses

type ErrorType struct {
    // Error - READ-ONLY
    Error *Error `json:"error,omitempty"`
}

ErrorType the key vault error exception.

type IssuerAttributes Uses

type IssuerAttributes struct {
    // Enabled - Determines whether the issuer is enabled.
    Enabled *bool `json:"enabled,omitempty"`
    // Created - READ-ONLY; Creation time in UTC.
    Created *date.UnixTime `json:"created,omitempty"`
    // Updated - READ-ONLY; Last updated time in UTC.
    Updated *date.UnixTime `json:"updated,omitempty"`
}

IssuerAttributes the attributes of an issuer managed by the Key Vault service.

type IssuerBundle Uses

type IssuerBundle struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; Identifier for the issuer object.
    ID  *string `json:"id,omitempty"`
    // Provider - The issuer provider.
    Provider *string `json:"provider,omitempty"`
    // Credentials - The credentials to be used for the issuer.
    Credentials *IssuerCredentials `json:"credentials,omitempty"`
    // OrganizationDetails - Details of the organization as provided to the issuer.
    OrganizationDetails *OrganizationDetails `json:"org_details,omitempty"`
    // Attributes - Attributes of the issuer object.
    Attributes *IssuerAttributes `json:"attributes,omitempty"`
}

IssuerBundle the issuer for Key Vault certificate.

type IssuerCredentials Uses

type IssuerCredentials struct {
    // AccountID - The user name/account name/account id.
    AccountID *string `json:"account_id,omitempty"`
    // Password - The password/secret/account key.
    Password *string `json:"pwd,omitempty"`
}

IssuerCredentials the credentials to be used for the certificate issuer.

type IssuerParameters Uses

type IssuerParameters struct {
    // Name - Name of the referenced issuer object or reserved names; for example, 'Self' or 'Unknown'.
    Name *string `json:"name,omitempty"`
    // CertificateType - Type of certificate to be requested from the issuer provider.
    CertificateType *string `json:"cty,omitempty"`
    // CertificateTransparency - Indicates if the certificates generated under this policy should be published to certificate transparency logs.
    CertificateTransparency *bool `json:"cert_transparency,omitempty"`
}

IssuerParameters parameters for the issuer of the X509 component of a certificate.

type JSONWebKey Uses

type JSONWebKey struct {
    // Kid - Key identifier.
    Kid *string `json:"kid,omitempty"`
    // Kty - JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include: 'EC', 'ECHSM', 'RSA', 'RSAHSM', 'Oct'
    Kty    JSONWebKeyType `json:"kty,omitempty"`
    KeyOps *[]string      `json:"key_ops,omitempty"`
    // N - RSA modulus. (a URL-encoded base64 string)
    N   *string `json:"n,omitempty"`
    // E - RSA public exponent. (a URL-encoded base64 string)
    E   *string `json:"e,omitempty"`
    // D - RSA private exponent, or the D component of an EC private key. (a URL-encoded base64 string)
    D   *string `json:"d,omitempty"`
    // DP - RSA private key parameter. (a URL-encoded base64 string)
    DP  *string `json:"dp,omitempty"`
    // DQ - RSA private key parameter. (a URL-encoded base64 string)
    DQ  *string `json:"dq,omitempty"`
    // QI - RSA private key parameter. (a URL-encoded base64 string)
    QI  *string `json:"qi,omitempty"`
    // P - RSA secret prime. (a URL-encoded base64 string)
    P   *string `json:"p,omitempty"`
    // Q - RSA secret prime, with p < q. (a URL-encoded base64 string)
    Q   *string `json:"q,omitempty"`
    // K - Symmetric key. (a URL-encoded base64 string)
    K   *string `json:"k,omitempty"`
    // T - HSM Token, used with 'Bring Your Own Key'. (a URL-encoded base64 string)
    T   *string `json:"key_hsm,omitempty"`
    // Crv - Elliptic curve name. For valid values, see JsonWebKeyCurveName. Possible values include: 'P256', 'P384', 'P521', 'P256K'
    Crv JSONWebKeyCurveName `json:"crv,omitempty"`
    // X - X component of an EC public key. (a URL-encoded base64 string)
    X   *string `json:"x,omitempty"`
    // Y - Y component of an EC public key. (a URL-encoded base64 string)
    Y   *string `json:"y,omitempty"`
}

JSONWebKey as of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

type JSONWebKeyCurveName Uses

type JSONWebKeyCurveName string

JSONWebKeyCurveName enumerates the values for json web key curve name.

const (
    // P256 The NIST P-256 elliptic curve, AKA SECG curve SECP256R1.
    P256 JSONWebKeyCurveName = "P-256"
    // P256K The SECG SECP256K1 elliptic curve.
    P256K JSONWebKeyCurveName = "P-256K"
    // P384 The NIST P-384 elliptic curve, AKA SECG curve SECP384R1.
    P384 JSONWebKeyCurveName = "P-384"
    // P521 The NIST P-521 elliptic curve, AKA SECG curve SECP521R1.
    P521 JSONWebKeyCurveName = "P-521"
)

func PossibleJSONWebKeyCurveNameValues Uses

func PossibleJSONWebKeyCurveNameValues() []JSONWebKeyCurveName

PossibleJSONWebKeyCurveNameValues returns an array of possible values for the JSONWebKeyCurveName const type.

type JSONWebKeyEncryptionAlgorithm Uses

type JSONWebKeyEncryptionAlgorithm string

JSONWebKeyEncryptionAlgorithm enumerates the values for json web key encryption algorithm.

const (
    // RSA15 ...
    RSA15 JSONWebKeyEncryptionAlgorithm = "RSA1_5"
    // RSAOAEP ...
    RSAOAEP JSONWebKeyEncryptionAlgorithm = "RSA-OAEP"
    // RSAOAEP256 ...
    RSAOAEP256 JSONWebKeyEncryptionAlgorithm = "RSA-OAEP-256"
)

func PossibleJSONWebKeyEncryptionAlgorithmValues Uses

func PossibleJSONWebKeyEncryptionAlgorithmValues() []JSONWebKeyEncryptionAlgorithm

PossibleJSONWebKeyEncryptionAlgorithmValues returns an array of possible values for the JSONWebKeyEncryptionAlgorithm const type.

type JSONWebKeyOperation Uses

type JSONWebKeyOperation string

JSONWebKeyOperation enumerates the values for json web key operation.

const (
    // Decrypt ...
    Decrypt JSONWebKeyOperation = "decrypt"
    // Encrypt ...
    Encrypt JSONWebKeyOperation = "encrypt"
    // Sign ...
    Sign JSONWebKeyOperation = "sign"
    // UnwrapKey ...
    UnwrapKey JSONWebKeyOperation = "unwrapKey"
    // Verify ...
    Verify JSONWebKeyOperation = "verify"
    // WrapKey ...
    WrapKey JSONWebKeyOperation = "wrapKey"
)

func PossibleJSONWebKeyOperationValues Uses

func PossibleJSONWebKeyOperationValues() []JSONWebKeyOperation

PossibleJSONWebKeyOperationValues returns an array of possible values for the JSONWebKeyOperation const type.

type JSONWebKeySignatureAlgorithm Uses

type JSONWebKeySignatureAlgorithm string

JSONWebKeySignatureAlgorithm enumerates the values for json web key signature algorithm.

const (
    // ES256 ECDSA using P-256 and SHA-256, as described in https://tools.ietf.org/html/rfc7518.
    ES256 JSONWebKeySignatureAlgorithm = "ES256"
    // ES256K ECDSA using P-256K and SHA-256, as described in https://tools.ietf.org/html/rfc7518
    ES256K JSONWebKeySignatureAlgorithm = "ES256K"
    // ES384 ECDSA using P-384 and SHA-384, as described in https://tools.ietf.org/html/rfc7518
    ES384 JSONWebKeySignatureAlgorithm = "ES384"
    // ES512 ECDSA using P-521 and SHA-512, as described in https://tools.ietf.org/html/rfc7518
    ES512 JSONWebKeySignatureAlgorithm = "ES512"
    // PS256 RSASSA-PSS using SHA-256 and MGF1 with SHA-256, as described in
    // https://tools.ietf.org/html/rfc7518
    PS256 JSONWebKeySignatureAlgorithm = "PS256"
    // PS384 RSASSA-PSS using SHA-384 and MGF1 with SHA-384, as described in
    // https://tools.ietf.org/html/rfc7518
    PS384 JSONWebKeySignatureAlgorithm = "PS384"
    // PS512 RSASSA-PSS using SHA-512 and MGF1 with SHA-512, as described in
    // https://tools.ietf.org/html/rfc7518
    PS512 JSONWebKeySignatureAlgorithm = "PS512"
    // RS256 RSASSA-PKCS1-v1_5 using SHA-256, as described in https://tools.ietf.org/html/rfc7518
    RS256 JSONWebKeySignatureAlgorithm = "RS256"
    // RS384 RSASSA-PKCS1-v1_5 using SHA-384, as described in https://tools.ietf.org/html/rfc7518
    RS384 JSONWebKeySignatureAlgorithm = "RS384"
    // RS512 RSASSA-PKCS1-v1_5 using SHA-512, as described in https://tools.ietf.org/html/rfc7518
    RS512 JSONWebKeySignatureAlgorithm = "RS512"
    // RSNULL Reserved
    RSNULL JSONWebKeySignatureAlgorithm = "RSNULL"
)

func PossibleJSONWebKeySignatureAlgorithmValues Uses

func PossibleJSONWebKeySignatureAlgorithmValues() []JSONWebKeySignatureAlgorithm

PossibleJSONWebKeySignatureAlgorithmValues returns an array of possible values for the JSONWebKeySignatureAlgorithm const type.

type JSONWebKeyType Uses

type JSONWebKeyType string

JSONWebKeyType enumerates the values for json web key type.

const (
    // EC Elliptic Curve.
    EC  JSONWebKeyType = "EC"
    // ECHSM Elliptic Curve with a private key which is not exportable from the HSM.
    ECHSM JSONWebKeyType = "EC-HSM"
    // Oct Octet sequence (used to represent symmetric keys)
    Oct JSONWebKeyType = "oct"
    // RSA RSA (https://tools.ietf.org/html/rfc3447)
    RSA JSONWebKeyType = "RSA"
    // RSAHSM RSA with a private key which is not exportable from the HSM.
    RSAHSM JSONWebKeyType = "RSA-HSM"
)

func PossibleJSONWebKeyTypeValues Uses

func PossibleJSONWebKeyTypeValues() []JSONWebKeyType

PossibleJSONWebKeyTypeValues returns an array of possible values for the JSONWebKeyType const type.

type KeyAttributes Uses

type KeyAttributes struct {
    // RecoveryLevel - READ-ONLY; Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval. Possible values include: 'Purgeable', 'RecoverablePurgeable', 'Recoverable', 'RecoverableProtectedSubscription'
    RecoveryLevel DeletionRecoveryLevel `json:"recoveryLevel,omitempty"`
    // Enabled - Determines whether the object is enabled.
    Enabled *bool `json:"enabled,omitempty"`
    // NotBefore - Not before date in UTC.
    NotBefore *date.UnixTime `json:"nbf,omitempty"`
    // Expires - Expiry date in UTC.
    Expires *date.UnixTime `json:"exp,omitempty"`
    // Created - READ-ONLY; Creation time in UTC.
    Created *date.UnixTime `json:"created,omitempty"`
    // Updated - READ-ONLY; Last updated time in UTC.
    Updated *date.UnixTime `json:"updated,omitempty"`
}

KeyAttributes the attributes of a key managed by the key vault service.

type KeyBundle Uses

type KeyBundle struct {
    autorest.Response `json:"-"`
    // Key - The Json web key.
    Key *JSONWebKey `json:"key,omitempty"`
    // Attributes - The key management attributes.
    Attributes *KeyAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // Managed - READ-ONLY; True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
    Managed *bool `json:"managed,omitempty"`
}

KeyBundle a KeyBundle consisting of a WebKey plus its attributes.

func (KeyBundle) MarshalJSON Uses

func (kb KeyBundle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for KeyBundle.

type KeyCreateParameters Uses

type KeyCreateParameters struct {
    // Kty - The type of key to create. For valid values, see JsonWebKeyType. Possible values include: 'EC', 'ECHSM', 'RSA', 'RSAHSM', 'Oct'
    Kty JSONWebKeyType `json:"kty,omitempty"`
    // KeySize - The key size in bits. For example: 2048, 3072, or 4096 for RSA.
    KeySize       *int32                 `json:"key_size,omitempty"`
    KeyOps        *[]JSONWebKeyOperation `json:"key_ops,omitempty"`
    KeyAttributes *KeyAttributes         `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // Curve - Elliptic curve name. For valid values, see JsonWebKeyCurveName. Possible values include: 'P256', 'P384', 'P521', 'P256K'
    Curve JSONWebKeyCurveName `json:"crv,omitempty"`
}

KeyCreateParameters the key create parameters.

func (KeyCreateParameters) MarshalJSON Uses

func (kcp KeyCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for KeyCreateParameters.

type KeyImportParameters Uses

type KeyImportParameters struct {
    // Hsm - Whether to import as a hardware key (HSM) or software key.
    Hsm *bool `json:"Hsm,omitempty"`
    // Key - The Json web key
    Key *JSONWebKey `json:"key,omitempty"`
    // KeyAttributes - The key management attributes.
    KeyAttributes *KeyAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

KeyImportParameters the key import parameters.

func (KeyImportParameters) MarshalJSON Uses

func (kip KeyImportParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for KeyImportParameters.

type KeyItem Uses

type KeyItem struct {
    // Kid - Key identifier.
    Kid *string `json:"kid,omitempty"`
    // Attributes - The key management attributes.
    Attributes *KeyAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // Managed - READ-ONLY; True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
    Managed *bool `json:"managed,omitempty"`
}

KeyItem the key item containing key metadata.

func (KeyItem) MarshalJSON Uses

func (ki KeyItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for KeyItem.

type KeyListResult Uses

type KeyListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of keys in the key vault along with a link to the next page of keys.
    Value *[]KeyItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of keys.
    NextLink *string `json:"nextLink,omitempty"`
}

KeyListResult the key list result.

func (KeyListResult) IsEmpty Uses

func (klr KeyListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type KeyListResultIterator Uses

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

KeyListResultIterator provides access to a complete listing of KeyItem values.

func NewKeyListResultIterator Uses

func NewKeyListResultIterator(page KeyListResultPage) KeyListResultIterator

Creates a new instance of the KeyListResultIterator type.

func (*KeyListResultIterator) Next Uses

func (iter *KeyListResultIterator) 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 (*KeyListResultIterator) NextWithContext Uses

func (iter *KeyListResultIterator) 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 (KeyListResultIterator) NotDone Uses

func (iter KeyListResultIterator) NotDone() bool

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

func (KeyListResultIterator) Response Uses

func (iter KeyListResultIterator) Response() KeyListResult

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

func (KeyListResultIterator) Value Uses

func (iter KeyListResultIterator) Value() KeyItem

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

type KeyListResultPage Uses

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

KeyListResultPage contains a page of KeyItem values.

func NewKeyListResultPage Uses

func NewKeyListResultPage(getNextPage func(context.Context, KeyListResult) (KeyListResult, error)) KeyListResultPage

Creates a new instance of the KeyListResultPage type.

func (*KeyListResultPage) Next Uses

func (page *KeyListResultPage) 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 (*KeyListResultPage) NextWithContext Uses

func (page *KeyListResultPage) 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 (KeyListResultPage) NotDone Uses

func (page KeyListResultPage) NotDone() bool

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

func (KeyListResultPage) Response Uses

func (page KeyListResultPage) Response() KeyListResult

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

func (KeyListResultPage) Values Uses

func (page KeyListResultPage) Values() []KeyItem

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

type KeyOperationResult Uses

type KeyOperationResult struct {
    autorest.Response `json:"-"`
    // Kid - READ-ONLY; Key identifier
    Kid *string `json:"kid,omitempty"`
    // Result - READ-ONLY; a URL-encoded base64 string
    Result *string `json:"value,omitempty"`
}

KeyOperationResult the key operation result.

type KeyOperationsParameters Uses

type KeyOperationsParameters struct {
    // Algorithm - algorithm identifier. Possible values include: 'RSAOAEP', 'RSAOAEP256', 'RSA15'
    Algorithm JSONWebKeyEncryptionAlgorithm `json:"alg,omitempty"`
    // Value - a URL-encoded base64 string
    Value *string `json:"value,omitempty"`
}

KeyOperationsParameters the key operations parameters.

type KeyProperties Uses

type KeyProperties struct {
    // Exportable - Indicates if the private key can be exported.
    Exportable *bool `json:"exportable,omitempty"`
    // KeyType - The type of key pair to be used for the certificate. Possible values include: 'EC', 'ECHSM', 'RSA', 'RSAHSM', 'Oct'
    KeyType JSONWebKeyType `json:"kty,omitempty"`
    // KeySize - The key size in bits. For example: 2048, 3072, or 4096 for RSA.
    KeySize *int32 `json:"key_size,omitempty"`
    // ReuseKey - Indicates if the same key pair will be used on certificate renewal.
    ReuseKey *bool `json:"reuse_key,omitempty"`
    // Curve - Elliptic curve name. For valid values, see JsonWebKeyCurveName. Possible values include: 'P256', 'P384', 'P521', 'P256K'
    Curve JSONWebKeyCurveName `json:"crv,omitempty"`
}

KeyProperties properties of the key pair backing a certificate.

type KeyRestoreParameters Uses

type KeyRestoreParameters struct {
    // KeyBundleBackup - The backup blob associated with a key bundle. (a URL-encoded base64 string)
    KeyBundleBackup *string `json:"value,omitempty"`
}

KeyRestoreParameters the key restore parameters.

type KeySignParameters Uses

type KeySignParameters struct {
    // Algorithm - The signing/verification algorithm identifier. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: 'PS256', 'PS384', 'PS512', 'RS256', 'RS384', 'RS512', 'RSNULL', 'ES256', 'ES384', 'ES512', 'ES256K'
    Algorithm JSONWebKeySignatureAlgorithm `json:"alg,omitempty"`
    // Value - a URL-encoded base64 string
    Value *string `json:"value,omitempty"`
}

KeySignParameters the key operations parameters.

type KeyUpdateParameters Uses

type KeyUpdateParameters struct {
    // KeyOps - Json web key operations. For more information on possible key operations, see JsonWebKeyOperation.
    KeyOps        *[]JSONWebKeyOperation `json:"key_ops,omitempty"`
    KeyAttributes *KeyAttributes         `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

KeyUpdateParameters the key update parameters.

func (KeyUpdateParameters) MarshalJSON Uses

func (kup KeyUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for KeyUpdateParameters.

type KeyUsageType Uses

type KeyUsageType string

KeyUsageType enumerates the values for key usage type.

const (
    // CRLSign ...
    CRLSign KeyUsageType = "cRLSign"
    // DataEncipherment ...
    DataEncipherment KeyUsageType = "dataEncipherment"
    // DecipherOnly ...
    DecipherOnly KeyUsageType = "decipherOnly"
    // DigitalSignature ...
    DigitalSignature KeyUsageType = "digitalSignature"
    // EncipherOnly ...
    EncipherOnly KeyUsageType = "encipherOnly"
    // KeyAgreement ...
    KeyAgreement KeyUsageType = "keyAgreement"
    // KeyCertSign ...
    KeyCertSign KeyUsageType = "keyCertSign"
    // KeyEncipherment ...
    KeyEncipherment KeyUsageType = "keyEncipherment"
    // NonRepudiation ...
    NonRepudiation KeyUsageType = "nonRepudiation"
)

func PossibleKeyUsageTypeValues Uses

func PossibleKeyUsageTypeValues() []KeyUsageType

PossibleKeyUsageTypeValues returns an array of possible values for the KeyUsageType const type.

type KeyVerifyParameters Uses

type KeyVerifyParameters struct {
    // Algorithm - The signing/verification algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: 'PS256', 'PS384', 'PS512', 'RS256', 'RS384', 'RS512', 'RSNULL', 'ES256', 'ES384', 'ES512', 'ES256K'
    Algorithm JSONWebKeySignatureAlgorithm `json:"alg,omitempty"`
    // Digest - The digest used for signing. (a URL-encoded base64 string)
    Digest *string `json:"digest,omitempty"`
    // Signature - The signature to be verified. (a URL-encoded base64 string)
    Signature *string `json:"value,omitempty"`
}

KeyVerifyParameters the key verify parameters.

type KeyVerifyResult Uses

type KeyVerifyResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; True if the signature is verified, otherwise false.
    Value *bool `json:"value,omitempty"`
}

KeyVerifyResult the key verify result.

type LifetimeAction Uses

type LifetimeAction struct {
    // Trigger - The condition that will execute the action.
    Trigger *Trigger `json:"trigger,omitempty"`
    // Action - The action that will be executed.
    Action *Action `json:"action,omitempty"`
}

LifetimeAction action and its trigger that will be performed by Key Vault over the lifetime of a certificate.

type OrganizationDetails Uses

type OrganizationDetails struct {
    // ID - Id of the organization.
    ID  *string `json:"id,omitempty"`
    // AdminDetails - Details of the organization administrator.
    AdminDetails *[]AdministratorDetails `json:"admin_details,omitempty"`
}

OrganizationDetails details of the organization of the certificate issuer.

type PendingCertificateSigningRequestResult Uses

type PendingCertificateSigningRequestResult struct {
    // Value - READ-ONLY; The pending certificate signing request as Base64 encoded string.
    Value *string `json:"value,omitempty"`
}

PendingCertificateSigningRequestResult the pending certificate signing request result.

type SasDefinitionAttributes Uses

type SasDefinitionAttributes struct {
    // Enabled - the enabled state of the object.
    Enabled *bool `json:"enabled,omitempty"`
    // Created - READ-ONLY; Creation time in UTC.
    Created *date.UnixTime `json:"created,omitempty"`
    // Updated - READ-ONLY; Last updated time in UTC.
    Updated *date.UnixTime `json:"updated,omitempty"`
    // RecoveryLevel - READ-ONLY; Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the system can purge the SAS definition, at the end of the retention interval. Possible values include: 'Purgeable', 'RecoverablePurgeable', 'Recoverable', 'RecoverableProtectedSubscription'
    RecoveryLevel DeletionRecoveryLevel `json:"recoveryLevel,omitempty"`
}

SasDefinitionAttributes the SAS definition management attributes.

type SasDefinitionBundle Uses

type SasDefinitionBundle struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; The SAS definition id.
    ID  *string `json:"id,omitempty"`
    // SecretID - READ-ONLY; Storage account SAS definition secret id.
    SecretID *string `json:"sid,omitempty"`
    // TemplateURI - READ-ONLY; The SAS definition token template signed with an arbitrary key.  Tokens created according to the SAS definition will have the same properties as the template.
    TemplateURI *string `json:"templateUri,omitempty"`
    // SasType - READ-ONLY; The type of SAS token the SAS definition will create. Possible values include: 'Account', 'Service'
    SasType SasTokenType `json:"sasType,omitempty"`
    // ValidityPeriod - READ-ONLY; The validity period of SAS tokens created according to the SAS definition.
    ValidityPeriod *string `json:"validityPeriod,omitempty"`
    // Attributes - READ-ONLY; The SAS definition attributes.
    Attributes *SasDefinitionAttributes `json:"attributes,omitempty"`
    // Tags - READ-ONLY; Application specific metadata in the form of key-value pairs
    Tags map[string]*string `json:"tags"`
}

SasDefinitionBundle a SAS definition bundle consists of key vault SAS definition details plus its attributes.

func (SasDefinitionBundle) MarshalJSON Uses

func (sdb SasDefinitionBundle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SasDefinitionBundle.

type SasDefinitionCreateParameters Uses

type SasDefinitionCreateParameters struct {
    // TemplateURI - The SAS definition token template signed with an arbitrary key.  Tokens created according to the SAS definition will have the same properties as the template.
    TemplateURI *string `json:"templateUri,omitempty"`
    // SasType - The type of SAS token the SAS definition will create. Possible values include: 'Account', 'Service'
    SasType SasTokenType `json:"sasType,omitempty"`
    // ValidityPeriod - The validity period of SAS tokens created according to the SAS definition.
    ValidityPeriod *string `json:"validityPeriod,omitempty"`
    // SasDefinitionAttributes - The attributes of the SAS definition.
    SasDefinitionAttributes *SasDefinitionAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

SasDefinitionCreateParameters the SAS definition create parameters.

func (SasDefinitionCreateParameters) MarshalJSON Uses

func (sdcp SasDefinitionCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SasDefinitionCreateParameters.

type SasDefinitionItem Uses

type SasDefinitionItem struct {
    // ID - READ-ONLY; The storage SAS identifier.
    ID  *string `json:"id,omitempty"`
    // SecretID - READ-ONLY; The storage account SAS definition secret id.
    SecretID *string `json:"sid,omitempty"`
    // Attributes - READ-ONLY; The SAS definition management attributes.
    Attributes *SasDefinitionAttributes `json:"attributes,omitempty"`
    // Tags - READ-ONLY; Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

SasDefinitionItem the SAS definition item containing storage SAS definition metadata.

func (SasDefinitionItem) MarshalJSON Uses

func (sdi SasDefinitionItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SasDefinitionItem.

type SasDefinitionListResult Uses

type SasDefinitionListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of SAS definitions along with a link to the next page of SAS definitions.
    Value *[]SasDefinitionItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of SAS definitions.
    NextLink *string `json:"nextLink,omitempty"`
}

SasDefinitionListResult the storage account SAS definition list result.

func (SasDefinitionListResult) IsEmpty Uses

func (sdlr SasDefinitionListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type SasDefinitionListResultIterator Uses

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

SasDefinitionListResultIterator provides access to a complete listing of SasDefinitionItem values.

func NewSasDefinitionListResultIterator Uses

func NewSasDefinitionListResultIterator(page SasDefinitionListResultPage) SasDefinitionListResultIterator

Creates a new instance of the SasDefinitionListResultIterator type.

func (*SasDefinitionListResultIterator) Next Uses

func (iter *SasDefinitionListResultIterator) 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 (*SasDefinitionListResultIterator) NextWithContext Uses

func (iter *SasDefinitionListResultIterator) 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 (SasDefinitionListResultIterator) NotDone Uses

func (iter SasDefinitionListResultIterator) NotDone() bool

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

func (SasDefinitionListResultIterator) Response Uses

func (iter SasDefinitionListResultIterator) Response() SasDefinitionListResult

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

func (SasDefinitionListResultIterator) Value Uses

func (iter SasDefinitionListResultIterator) Value() SasDefinitionItem

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

type SasDefinitionListResultPage Uses

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

SasDefinitionListResultPage contains a page of SasDefinitionItem values.

func NewSasDefinitionListResultPage Uses

func NewSasDefinitionListResultPage(getNextPage func(context.Context, SasDefinitionListResult) (SasDefinitionListResult, error)) SasDefinitionListResultPage

Creates a new instance of the SasDefinitionListResultPage type.

func (*SasDefinitionListResultPage) Next Uses

func (page *SasDefinitionListResultPage) 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 (*SasDefinitionListResultPage) NextWithContext Uses

func (page *SasDefinitionListResultPage) 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 (SasDefinitionListResultPage) NotDone Uses

func (page SasDefinitionListResultPage) NotDone() bool

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

func (SasDefinitionListResultPage) Response Uses

func (page SasDefinitionListResultPage) Response() SasDefinitionListResult

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

func (SasDefinitionListResultPage) Values Uses

func (page SasDefinitionListResultPage) Values() []SasDefinitionItem

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

type SasDefinitionUpdateParameters Uses

type SasDefinitionUpdateParameters struct {
    // TemplateURI - The SAS definition token template signed with an arbitrary key.  Tokens created according to the SAS definition will have the same properties as the template.
    TemplateURI *string `json:"templateUri,omitempty"`
    // SasType - The type of SAS token the SAS definition will create. Possible values include: 'Account', 'Service'
    SasType SasTokenType `json:"sasType,omitempty"`
    // ValidityPeriod - The validity period of SAS tokens created according to the SAS definition.
    ValidityPeriod *string `json:"validityPeriod,omitempty"`
    // SasDefinitionAttributes - The attributes of the SAS definition.
    SasDefinitionAttributes *SasDefinitionAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

SasDefinitionUpdateParameters the SAS definition update parameters.

func (SasDefinitionUpdateParameters) MarshalJSON Uses

func (sdup SasDefinitionUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SasDefinitionUpdateParameters.

type SasTokenType Uses

type SasTokenType string

SasTokenType enumerates the values for sas token type.

const (
    // Account ...
    Account SasTokenType = "account"
    // Service ...
    Service SasTokenType = "service"
)

func PossibleSasTokenTypeValues Uses

func PossibleSasTokenTypeValues() []SasTokenType

PossibleSasTokenTypeValues returns an array of possible values for the SasTokenType const type.

type SecretAttributes Uses

type SecretAttributes struct {
    // RecoveryLevel - READ-ONLY; Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. Possible values include: 'Purgeable', 'RecoverablePurgeable', 'Recoverable', 'RecoverableProtectedSubscription'
    RecoveryLevel DeletionRecoveryLevel `json:"recoveryLevel,omitempty"`
    // Enabled - Determines whether the object is enabled.
    Enabled *bool `json:"enabled,omitempty"`
    // NotBefore - Not before date in UTC.
    NotBefore *date.UnixTime `json:"nbf,omitempty"`
    // Expires - Expiry date in UTC.
    Expires *date.UnixTime `json:"exp,omitempty"`
    // Created - READ-ONLY; Creation time in UTC.
    Created *date.UnixTime `json:"created,omitempty"`
    // Updated - READ-ONLY; Last updated time in UTC.
    Updated *date.UnixTime `json:"updated,omitempty"`
}

SecretAttributes the secret management attributes.

type SecretBundle Uses

type SecretBundle struct {
    autorest.Response `json:"-"`
    // Value - The secret value.
    Value *string `json:"value,omitempty"`
    // ID - The secret id.
    ID  *string `json:"id,omitempty"`
    // ContentType - The content type of the secret.
    ContentType *string `json:"contentType,omitempty"`
    // Attributes - The secret management attributes.
    Attributes *SecretAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // Kid - READ-ONLY; If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.
    Kid *string `json:"kid,omitempty"`
    // Managed - READ-ONLY; True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.
    Managed *bool `json:"managed,omitempty"`
}

SecretBundle a secret consisting of a value, id and its attributes.

func (SecretBundle) MarshalJSON Uses

func (sb SecretBundle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SecretBundle.

type SecretItem Uses

type SecretItem struct {
    // ID - Secret identifier.
    ID  *string `json:"id,omitempty"`
    // Attributes - The secret management attributes.
    Attributes *SecretAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // ContentType - Type of the secret value such as a password.
    ContentType *string `json:"contentType,omitempty"`
    // Managed - READ-ONLY; True if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
    Managed *bool `json:"managed,omitempty"`
}

SecretItem the secret item containing secret metadata.

func (SecretItem) MarshalJSON Uses

func (si SecretItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SecretItem.

type SecretListResult Uses

type SecretListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of secrets in the key vault along with a link to the next page of secrets.
    Value *[]SecretItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of secrets.
    NextLink *string `json:"nextLink,omitempty"`
}

SecretListResult the secret list result.

func (SecretListResult) IsEmpty Uses

func (slr SecretListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type SecretListResultIterator Uses

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

SecretListResultIterator provides access to a complete listing of SecretItem values.

func NewSecretListResultIterator Uses

func NewSecretListResultIterator(page SecretListResultPage) SecretListResultIterator

Creates a new instance of the SecretListResultIterator type.

func (*SecretListResultIterator) Next Uses

func (iter *SecretListResultIterator) 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 (*SecretListResultIterator) NextWithContext Uses

func (iter *SecretListResultIterator) 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 (SecretListResultIterator) NotDone Uses

func (iter SecretListResultIterator) NotDone() bool

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

func (SecretListResultIterator) Response Uses

func (iter SecretListResultIterator) Response() SecretListResult

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

func (SecretListResultIterator) Value Uses

func (iter SecretListResultIterator) Value() SecretItem

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

type SecretListResultPage Uses

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

SecretListResultPage contains a page of SecretItem values.

func NewSecretListResultPage Uses

func NewSecretListResultPage(getNextPage func(context.Context, SecretListResult) (SecretListResult, error)) SecretListResultPage

Creates a new instance of the SecretListResultPage type.

func (*SecretListResultPage) Next Uses

func (page *SecretListResultPage) 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 (*SecretListResultPage) NextWithContext Uses

func (page *SecretListResultPage) 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 (SecretListResultPage) NotDone Uses

func (page SecretListResultPage) NotDone() bool

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

func (SecretListResultPage) Response Uses

func (page SecretListResultPage) Response() SecretListResult

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

func (SecretListResultPage) Values Uses

func (page SecretListResultPage) Values() []SecretItem

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

type SecretProperties Uses

type SecretProperties struct {
    // ContentType - The media type (MIME type).
    ContentType *string `json:"contentType,omitempty"`
}

SecretProperties properties of the key backing a certificate.

type SecretRestoreParameters Uses

type SecretRestoreParameters struct {
    // SecretBundleBackup - The backup blob associated with a secret bundle. (a URL-encoded base64 string)
    SecretBundleBackup *string `json:"value,omitempty"`
}

SecretRestoreParameters the secret restore parameters.

type SecretSetParameters Uses

type SecretSetParameters struct {
    // Value - The value of the secret.
    Value *string `json:"value,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
    // ContentType - Type of the secret value such as a password.
    ContentType *string `json:"contentType,omitempty"`
    // SecretAttributes - The secret management attributes.
    SecretAttributes *SecretAttributes `json:"attributes,omitempty"`
}

SecretSetParameters the secret set parameters.

func (SecretSetParameters) MarshalJSON Uses

func (ssp SecretSetParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SecretSetParameters.

type SecretUpdateParameters Uses

type SecretUpdateParameters struct {
    // ContentType - Type of the secret value such as a password.
    ContentType *string `json:"contentType,omitempty"`
    // SecretAttributes - The secret management attributes.
    SecretAttributes *SecretAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

SecretUpdateParameters the secret update parameters.

func (SecretUpdateParameters) MarshalJSON Uses

func (sup SecretUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SecretUpdateParameters.

type StorageAccountAttributes Uses

type StorageAccountAttributes struct {
    // Enabled - the enabled state of the object.
    Enabled *bool `json:"enabled,omitempty"`
    // Created - READ-ONLY; Creation time in UTC.
    Created *date.UnixTime `json:"created,omitempty"`
    // Updated - READ-ONLY; Last updated time in UTC.
    Updated *date.UnixTime `json:"updated,omitempty"`
    // RecoveryLevel - READ-ONLY; Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval. Possible values include: 'Purgeable', 'RecoverablePurgeable', 'Recoverable', 'RecoverableProtectedSubscription'
    RecoveryLevel DeletionRecoveryLevel `json:"recoveryLevel,omitempty"`
}

StorageAccountAttributes the storage account management attributes.

type StorageAccountCreateParameters Uses

type StorageAccountCreateParameters struct {
    // ResourceID - Storage account resource id.
    ResourceID *string `json:"resourceId,omitempty"`
    // ActiveKeyName - Current active storage account key name.
    ActiveKeyName *string `json:"activeKeyName,omitempty"`
    // AutoRegenerateKey - whether keyvault should manage the storage account for the user.
    AutoRegenerateKey *bool `json:"autoRegenerateKey,omitempty"`
    // RegenerationPeriod - The key regeneration time duration specified in ISO-8601 format.
    RegenerationPeriod *string `json:"regenerationPeriod,omitempty"`
    // StorageAccountAttributes - The attributes of the storage account.
    StorageAccountAttributes *StorageAccountAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

StorageAccountCreateParameters the storage account create parameters.

func (StorageAccountCreateParameters) MarshalJSON Uses

func (sacp StorageAccountCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageAccountCreateParameters.

type StorageAccountItem Uses

type StorageAccountItem struct {
    // ID - READ-ONLY; Storage identifier.
    ID  *string `json:"id,omitempty"`
    // ResourceID - READ-ONLY; Storage account resource Id.
    ResourceID *string `json:"resourceId,omitempty"`
    // Attributes - READ-ONLY; The storage account management attributes.
    Attributes *StorageAccountAttributes `json:"attributes,omitempty"`
    // Tags - READ-ONLY; Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

StorageAccountItem the storage account item containing storage account metadata.

func (StorageAccountItem) MarshalJSON Uses

func (sai StorageAccountItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageAccountItem.

type StorageAccountRegenerteKeyParameters Uses

type StorageAccountRegenerteKeyParameters struct {
    // KeyName - The storage account key name.
    KeyName *string `json:"keyName,omitempty"`
}

StorageAccountRegenerteKeyParameters the storage account key regenerate parameters.

type StorageAccountUpdateParameters Uses

type StorageAccountUpdateParameters struct {
    // ActiveKeyName - The current active storage account key name.
    ActiveKeyName *string `json:"activeKeyName,omitempty"`
    // AutoRegenerateKey - whether keyvault should manage the storage account for the user.
    AutoRegenerateKey *bool `json:"autoRegenerateKey,omitempty"`
    // RegenerationPeriod - The key regeneration time duration specified in ISO-8601 format.
    RegenerationPeriod *string `json:"regenerationPeriod,omitempty"`
    // StorageAccountAttributes - The attributes of the storage account.
    StorageAccountAttributes *StorageAccountAttributes `json:"attributes,omitempty"`
    // Tags - Application specific metadata in the form of key-value pairs.
    Tags map[string]*string `json:"tags"`
}

StorageAccountUpdateParameters the storage account update parameters.

func (StorageAccountUpdateParameters) MarshalJSON Uses

func (saup StorageAccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageAccountUpdateParameters.

type StorageBundle Uses

type StorageBundle struct {
    autorest.Response `json:"-"`
    // ID - READ-ONLY; The storage account id.
    ID  *string `json:"id,omitempty"`
    // ResourceID - READ-ONLY; The storage account resource id.
    ResourceID *string `json:"resourceId,omitempty"`
    // ActiveKeyName - READ-ONLY; The current active storage account key name.
    ActiveKeyName *string `json:"activeKeyName,omitempty"`
    // AutoRegenerateKey - READ-ONLY; whether keyvault should manage the storage account for the user.
    AutoRegenerateKey *bool `json:"autoRegenerateKey,omitempty"`
    // RegenerationPeriod - READ-ONLY; The key regeneration time duration specified in ISO-8601 format.
    RegenerationPeriod *string `json:"regenerationPeriod,omitempty"`
    // Attributes - READ-ONLY; The storage account attributes.
    Attributes *StorageAccountAttributes `json:"attributes,omitempty"`
    // Tags - READ-ONLY; Application specific metadata in the form of key-value pairs
    Tags map[string]*string `json:"tags"`
}

StorageBundle a Storage account bundle consists of key vault storage account details plus its attributes.

func (StorageBundle) MarshalJSON Uses

func (sb StorageBundle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageBundle.

type StorageListResult Uses

type StorageListResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; A response message containing a list of storage accounts in the key vault along with a link to the next page of storage accounts.
    Value *[]StorageAccountItem `json:"value,omitempty"`
    // NextLink - READ-ONLY; The URL to get the next set of storage accounts.
    NextLink *string `json:"nextLink,omitempty"`
}

StorageListResult the storage accounts list result.

func (StorageListResult) IsEmpty Uses

func (slr StorageListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type StorageListResultIterator Uses

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

StorageListResultIterator provides access to a complete listing of StorageAccountItem values.

func NewStorageListResultIterator Uses

func NewStorageListResultIterator(page StorageListResultPage) StorageListResultIterator

Creates a new instance of the StorageListResultIterator type.

func (*StorageListResultIterator) Next Uses

func (iter *StorageListResultIterator) 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 (*StorageListResultIterator) NextWithContext Uses

func (iter *StorageListResultIterator) 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 (StorageListResultIterator) NotDone Uses

func (iter StorageListResultIterator) NotDone() bool

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

func (StorageListResultIterator) Response Uses

func (iter StorageListResultIterator) Response() StorageListResult

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

func (StorageListResultIterator) Value Uses

func (iter StorageListResultIterator) Value() StorageAccountItem

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

type StorageListResultPage Uses

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

StorageListResultPage contains a page of StorageAccountItem values.

func NewStorageListResultPage Uses

func NewStorageListResultPage(getNextPage func(context.Context, StorageListResult) (StorageListResult, error)) StorageListResultPage

Creates a new instance of the StorageListResultPage type.

func (*StorageListResultPage) Next Uses

func (page *StorageListResultPage) 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 (*StorageListResultPage) NextWithContext Uses

func (page *StorageListResultPage) 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 (StorageListResultPage) NotDone Uses

func (page StorageListResultPage) NotDone() bool

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

func (StorageListResultPage) Response Uses

func (page StorageListResultPage) Response() StorageListResult

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

func (StorageListResultPage) Values Uses

func (page StorageListResultPage) Values() []StorageAccountItem

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

type StorageRestoreParameters Uses

type StorageRestoreParameters struct {
    // StorageBundleBackup - The backup blob associated with a storage account. (a URL-encoded base64 string)
    StorageBundleBackup *string `json:"value,omitempty"`
}

StorageRestoreParameters the secret restore parameters.

type SubjectAlternativeNames Uses

type SubjectAlternativeNames struct {
    // Emails - Email addresses.
    Emails *[]string `json:"emails,omitempty"`
    // DNSNames - Domain names.
    DNSNames *[]string `json:"dns_names,omitempty"`
    // Upns - User principal names.
    Upns *[]string `json:"upns,omitempty"`
}

SubjectAlternativeNames the subject alternate names of a X509 object.

type Trigger Uses

type Trigger struct {
    // LifetimePercentage - Percentage of lifetime at which to trigger. Value should be between 1 and 99.
    LifetimePercentage *int32 `json:"lifetime_percentage,omitempty"`
    // DaysBeforeExpiry - Days before expiry to attempt renewal. Value should be between 1 and validity_in_months multiplied by 27. If validity_in_months is 36, then value should be between 1 and 972 (36 * 27).
    DaysBeforeExpiry *int32 `json:"days_before_expiry,omitempty"`
}

Trigger a condition to be satisfied for an action to be executed.

type X509CertificateProperties Uses

type X509CertificateProperties struct {
    // Subject - The subject name. Should be a valid X509 distinguished Name.
    Subject *string `json:"subject,omitempty"`
    // Ekus - The enhanced key usage.
    Ekus *[]string `json:"ekus,omitempty"`
    // SubjectAlternativeNames - The subject alternative names.
    SubjectAlternativeNames *SubjectAlternativeNames `json:"sans,omitempty"`
    // KeyUsage - List of key usages.
    KeyUsage *[]KeyUsageType `json:"key_usage,omitempty"`
    // ValidityInMonths - The duration that the certificate is valid in months.
    ValidityInMonths *int32 `json:"validity_months,omitempty"`
}

X509CertificateProperties properties of the X509 component of a certificate.

Directories

PathSynopsis
keyvaultapi

Package keyvault imports 10 packages (graph) and is imported by 6 packages. Updated 2019-07-30. Refresh now. Tools for package owners.