SnapshotResource 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 Snapshot along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a SnapshotResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetSnapshots method.
public class SnapshotResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.SnapshotData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.SnapshotData>type SnapshotResource = class
inherit ArmResource
interface IJsonModel<SnapshotData>
interface IPersistableModel<SnapshotData>Public Class SnapshotResource
Inherits ArmResource
Implements IJsonModel(Of SnapshotData), IPersistableModel(Of SnapshotData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| SnapshotResource() |
Initializes a new instance of SnapshotResource 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 a snapshot.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes a snapshot.
|
| Get(CancellationToken) |
Gets information about a snapshot.
|
| GetAsync(CancellationToken) |
Gets information about a snapshot.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| 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) |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| GrantAccess(WaitUntil, GrantAccessData, CancellationToken) |
Grants access to a snapshot.
|
| GrantAccessAsync(WaitUntil, GrantAccessData, CancellationToken) |
Grants access to a snapshot.
|
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource. |
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource. |
| RevokeAccess(WaitUntil, CancellationToken) |
Revokes access to a snapshot.
|
| RevokeAccessAsync(WaitUntil, CancellationToken) |
Revokes access to a snapshot.
|
| 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(WaitUntil, SnapshotPatch, CancellationToken) |
Updates (patches) a snapshot.
|
| UpdateAsync(WaitUntil, SnapshotPatch, CancellationToken) |
Updates (patches) a snapshot.
|
| UpdateImmutabilityPolicy(WaitUntil, ImmutabilityPolicyContent, CancellationToken) |
Updates the immutability policy of a snapshot. Sets or extends an unlocked immutability policy with the specified duration and type. If the snapshot already has a locked policy, the request will be rejected. Use updateImmutabilityPolicyLock to lock an immutability policy.
|
| UpdateImmutabilityPolicyAsync(WaitUntil, ImmutabilityPolicyContent, CancellationToken) |
Updates the immutability policy of a snapshot. Sets or extends an unlocked immutability policy with the specified duration and type. If the snapshot already has a locked policy, the request will be rejected. Use updateImmutabilityPolicyLock to lock an immutability policy.
|
| UpdateImmutabilityPolicyLock(WaitUntil, ImmutabilityPolicyLockContent, CancellationToken) |
Locks the immutability policy of a snapshot. Once locked, the policy cannot be reduced or removed until the lock period expires.
|
| UpdateImmutabilityPolicyLockAsync(WaitUntil, ImmutabilityPolicyLockContent, CancellationToken) |
Locks the immutability policy of a snapshot. Once locked, the policy cannot be reduced or removed until the lock period expires.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<SnapshotData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<SnapshotData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<SnapshotData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<SnapshotData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<SnapshotData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
