-
Notifications
You must be signed in to change notification settings - Fork 256
/
BackupJobResource.xml
241 lines (241 loc) · 18 KB
/
BackupJobResource.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<Type Name="BackupJobResource" FullName="Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource">
<TypeSignature Language="C#" Value="public class BackupJobResource : Azure.ResourceManager.ArmResource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit BackupJobResource extends Azure.ResourceManager.ArmResource" />
<TypeSignature Language="DocId" Value="T:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource" />
<TypeSignature Language="VB.NET" Value="Public Class BackupJobResource
Inherits ArmResource" />
<TypeSignature Language="F#" Value="type BackupJobResource = class
 inherit ArmResource" />
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.RecoveryServicesBackup</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.1.1.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.ResourceManager.ArmResource</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A Class representing a BackupJob along with the instance operations that can be performed on it.
If you have a <see cref="T:Azure.Core.ResourceIdentifier" /> you can construct a <see cref="T:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource" />
from an instance of <see cref="T:Azure.ResourceManager.ArmClient" /> using the GetBackupJobResource method.
Otherwise you can get one from its parent resource <see cref="T:Azure.ResourceManager.Resources.ResourceGroupResource" /> using the GetBackupJob method.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected BackupJobResource ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.RecoveryServicesBackup</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of the <see cref="T:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource" /> class for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateResourceIdentifier">
<MemberSignature Language="C#" Value="public static Azure.Core.ResourceIdentifier CreateResourceIdentifier (string subscriptionId, string resourceGroupName, string vaultName, string jobName);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Core.ResourceIdentifier CreateResourceIdentifier(string subscriptionId, string resourceGroupName, string vaultName, string jobName) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.CreateResourceIdentifier(System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateResourceIdentifier (subscriptionId As String, resourceGroupName As String, vaultName As String, jobName As String) As ResourceIdentifier" />
<MemberSignature Language="F#" Value="static member CreateResourceIdentifier : string * string * string * string -> Azure.Core.ResourceIdentifier" Usage="Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.CreateResourceIdentifier (subscriptionId, resourceGroupName, vaultName, jobName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.RecoveryServicesBackup</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.ResourceIdentifier</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subscriptionId" Type="System.String" />
<Parameter Name="resourceGroupName" Type="System.String" />
<Parameter Name="vaultName" Type="System.String" />
<Parameter Name="jobName" Type="System.String" />
</Parameters>
<Docs>
<param name="subscriptionId"> The subscriptionId. </param>
<param name="resourceGroupName"> The resourceGroupName. </param>
<param name="vaultName"> The vaultName. </param>
<param name="jobName"> The jobName. </param>
<summary> Generate the resource identifier of a <see cref="T:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource" /> instance. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Data">
<MemberSignature Language="C#" Value="public virtual Azure.ResourceManager.RecoveryServicesBackup.BackupJobData Data { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.ResourceManager.RecoveryServicesBackup.BackupJobData Data" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.Data" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Data As BackupJobData" />
<MemberSignature Language="F#" Value="member this.Data : Azure.ResourceManager.RecoveryServicesBackup.BackupJobData" Usage="Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.Data" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.RecoveryServicesBackup</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.ResourceManager.RecoveryServicesBackup.BackupJobData</ReturnType>
</ReturnValue>
<Docs>
<summary> Gets the data representing this Feature. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException"> Throws if there is no data loaded in the current instance. </exception>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource> Get (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource> Get(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.Get(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Get (Optional cancellationToken As CancellationToken = Nothing) As Response(Of BackupJobResource)" />
<MemberSignature Language="F#" Value="abstract member Get : System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource>
override this.Get : System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource>" Usage="backupJobResource.Get cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.RecoveryServicesBackup</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Gets extended information associated with the job.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}</description></item><item><term>Operation Id</term><description>JobDetails_Get</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource>> GetAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource>> GetAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.GetAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BackupJobResource))" />
<MemberSignature Language="F#" Value="abstract member GetAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource>>
override this.GetAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource>>" Usage="backupJobResource.GetAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.RecoveryServicesBackup</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Gets extended information associated with the job.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}</description></item><item><term>Operation Id</term><description>JobDetails_Get</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasData">
<MemberSignature Language="C#" Value="public virtual bool HasData { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasData" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.HasData" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property HasData As Boolean" />
<MemberSignature Language="F#" Value="member this.HasData : bool" Usage="Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.HasData" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.RecoveryServicesBackup</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary> Gets whether or not the current instance has data. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResourceType">
<MemberSignature Language="C#" Value="public static readonly Azure.Core.ResourceType ResourceType;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly valuetype Azure.Core.ResourceType ResourceType" />
<MemberSignature Language="DocId" Value="F:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.ResourceType" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly ResourceType As ResourceType " />
<MemberSignature Language="F#" Value=" staticval mutable ResourceType : Azure.Core.ResourceType" Usage="Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.ResourceType" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.RecoveryServicesBackup</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.ResourceType</ReturnType>
</ReturnValue>
<Docs>
<summary> Gets the resource type for the operations. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TriggerJobCancellation">
<MemberSignature Language="C#" Value="public virtual Azure.Response TriggerJobCancellation (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response TriggerJobCancellation(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.TriggerJobCancellation(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function TriggerJobCancellation (Optional cancellationToken As CancellationToken = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member TriggerJobCancellation : System.Threading.CancellationToken -> Azure.Response
override this.TriggerJobCancellation : System.Threading.CancellationToken -> Azure.Response" Usage="backupJobResource.TriggerJobCancellation cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.RecoveryServicesBackup</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call
GetCancelOperationResult API.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/cancel</description></item><item><term>Operation Id</term><description>JobCancellations_Trigger</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TriggerJobCancellationAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> TriggerJobCancellationAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> TriggerJobCancellationAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.RecoveryServicesBackup.BackupJobResource.TriggerJobCancellationAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function TriggerJobCancellationAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member TriggerJobCancellationAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.TriggerJobCancellationAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="backupJobResource.TriggerJobCancellationAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.RecoveryServicesBackup</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call
GetCancelOperationResult API.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/cancel</description></item><item><term>Operation Id</term><description>JobCancellations_Trigger</description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>