KeyVaultResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A class representing a KeyVault along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a KeyVaultResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetKeyVaults method.
public class KeyVaultResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.KeyVault.KeyVaultData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.KeyVault.KeyVaultData>public class KeyVaultResource : Azure.ResourceManager.ArmResourcetype KeyVaultResource = class
inherit ArmResource
interface IJsonModel<KeyVaultData>
interface IPersistableModel<KeyVaultData>type KeyVaultResource = class
inherit ArmResourcePublic Class KeyVaultResource
Inherits ArmResource
Implements IJsonModel(Of KeyVaultData), IPersistableModel(Of KeyVaultData)Public Class KeyVaultResource
Inherits ArmResource- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| KeyVaultResource() |
Initializes a new instance of KeyVaultResource for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
| Data |
Gets the data representing this Feature. |
| Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
| Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
| HasData |
Gets whether or not the current instance has data. |
| Id |
Gets the resource identifier. (Inherited from ArmResource) |
| Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
| Name | Description |
|---|---|
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource. |
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource. |
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier for this resource. |
| Delete(WaitUntil, CancellationToken) |
Deletes the specified Azure key vault.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes the specified Azure key vault.
|
| Get(CancellationToken) |
Gets the specified Azure key vault.
|
| GetAsync(CancellationToken) |
Gets the specified Azure key vault.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetKeyVaultPrivateEndpointConnection(String, CancellationToken) |
Gets the specified private endpoint connection associated with the key vault. |
| GetKeyVaultPrivateEndpointConnectionAsync(String, CancellationToken) |
Gets the specified private endpoint connection associated with the key vault. |
| GetKeyVaultPrivateEndpointConnections() |
Gets a collection of KeyVaultPrivateEndpointConnections in the KeyVaultResource. |
| GetKeyVaultSecret(String, CancellationToken) |
Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. |
| GetKeyVaultSecretAsync(String, CancellationToken) |
Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. |
| GetKeyVaultSecrets() |
Gets a collection of KeyVaultSecrets in the KeyVaultResource. |
| GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
| GetPrivateLinkResources(CancellationToken) |
Gets the private link resources supported for the key vault.
|
| GetPrivateLinkResourcesAsync(CancellationToken) |
Gets the private link resources supported for the key vault.
|
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource. |
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource. |
| SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(KeyVaultPatch, CancellationToken) |
Update a key vault in the specified subscription.
|
| UpdateAccessPolicy(AccessPolicyUpdateKind, KeyVaultAccessPolicyParameters, CancellationToken) |
Update access policies in a key vault in the specified subscription.
|
| UpdateAccessPolicyAsync(AccessPolicyUpdateKind, KeyVaultAccessPolicyParameters, CancellationToken) |
Update access policies in a key vault in the specified subscription.
|
| UpdateAsync(KeyVaultPatch, CancellationToken) |
Update a key vault in the specified subscription.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<KeyVaultData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<KeyVaultData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<KeyVaultData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<KeyVaultData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<KeyVaultData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
