-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
SelfHelpExtensions.cs
204 lines (192 loc) · 13.3 KB
/
SelfHelpExtensions.cs
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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// <auto-generated/>
#nullable disable
using System;
using System.Threading;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.ResourceManager;
using Azure.ResourceManager.SelfHelp.Models;
namespace Azure.ResourceManager.SelfHelp
{
/// <summary> A class to add extension methods to Azure.ResourceManager.SelfHelp. </summary>
public static partial class SelfHelpExtensions
{
private static ArmResourceExtensionClient GetArmResourceExtensionClient(ArmResource resource)
{
return resource.GetCachedClient(client =>
{
return new ArmResourceExtensionClient(client, resource.Id);
});
}
private static ArmResourceExtensionClient GetArmResourceExtensionClient(ArmClient client, ResourceIdentifier scope)
{
return client.GetResourceClient(() =>
{
return new ArmResourceExtensionClient(client, scope);
});
}
#region SelfHelpDiagnosticResource
/// <summary>
/// Gets an object representing a <see cref="SelfHelpDiagnosticResource" /> along with the instance operations that can be performed on it but with no data.
/// You can use <see cref="SelfHelpDiagnosticResource.CreateResourceIdentifier" /> to create a <see cref="SelfHelpDiagnosticResource" /> <see cref="ResourceIdentifier" /> from its components.
/// </summary>
/// <param name="client"> The <see cref="ArmClient" /> instance the method will execute against. </param>
/// <param name="id"> The resource ID of the resource to get. </param>
/// <returns> Returns a <see cref="SelfHelpDiagnosticResource" /> object. </returns>
public static SelfHelpDiagnosticResource GetSelfHelpDiagnosticResource(this ArmClient client, ResourceIdentifier id)
{
return client.GetResourceClient(() =>
{
SelfHelpDiagnosticResource.ValidateResourceId(id);
return new SelfHelpDiagnosticResource(client, id);
}
);
}
#endregion
/// <summary> Gets a collection of SelfHelpDiagnosticResources in the ArmResource. </summary>
/// <param name="client"> The <see cref="ArmClient" /> instance the method will execute against. </param>
/// <param name="scope"> The scope that the resource will apply against. </param>
/// <returns> An object representing collection of SelfHelpDiagnosticResources and their operations over a SelfHelpDiagnosticResource. </returns>
public static SelfHelpDiagnosticCollection GetSelfHelpDiagnostics(this ArmClient client, ResourceIdentifier scope)
{
return GetArmResourceExtensionClient(client, scope).GetSelfHelpDiagnostics();
}
/// <summary>
/// Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
/// <list type="bullet">
/// <item>
/// <term>Request Path</term>
/// <description>/{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}</description>
/// </item>
/// <item>
/// <term>Operation Id</term>
/// <description>Diagnostics_Get</description>
/// </item>
/// </list>
/// </summary>
/// <param name="client"> The <see cref="ArmClient" /> instance the method will execute against. </param>
/// <param name="scope"> The scope that the resource will apply against. </param>
/// <param name="diagnosticsResourceName"> Unique resource name for insight resources. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="ArgumentException"> <paramref name="diagnosticsResourceName"/> is an empty string, and was expected to be non-empty. </exception>
/// <exception cref="ArgumentNullException"> <paramref name="diagnosticsResourceName"/> is null. </exception>
[ForwardsClientCalls]
public static async Task<Response<SelfHelpDiagnosticResource>> GetSelfHelpDiagnosticAsync(this ArmClient client, ResourceIdentifier scope, string diagnosticsResourceName, CancellationToken cancellationToken = default)
{
return await client.GetSelfHelpDiagnostics(scope).GetAsync(diagnosticsResourceName, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
/// <list type="bullet">
/// <item>
/// <term>Request Path</term>
/// <description>/{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}</description>
/// </item>
/// <item>
/// <term>Operation Id</term>
/// <description>Diagnostics_Get</description>
/// </item>
/// </list>
/// </summary>
/// <param name="client"> The <see cref="ArmClient" /> instance the method will execute against. </param>
/// <param name="scope"> The scope that the resource will apply against. </param>
/// <param name="diagnosticsResourceName"> Unique resource name for insight resources. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
/// <exception cref="ArgumentException"> <paramref name="diagnosticsResourceName"/> is an empty string, and was expected to be non-empty. </exception>
/// <exception cref="ArgumentNullException"> <paramref name="diagnosticsResourceName"/> is null. </exception>
[ForwardsClientCalls]
public static Response<SelfHelpDiagnosticResource> GetSelfHelpDiagnostic(this ArmClient client, ResourceIdentifier scope, string diagnosticsResourceName, CancellationToken cancellationToken = default)
{
return client.GetSelfHelpDiagnostics(scope).Get(diagnosticsResourceName, cancellationToken);
}
/// <summary>
/// This API is used to check the uniqueness of a resource name used for a diagnostic check.
/// <list type="bullet">
/// <item>
/// <term>Request Path</term>
/// <description>/{scope}/providers/Microsoft.Help/checkNameAvailability</description>
/// </item>
/// <item>
/// <term>Operation Id</term>
/// <description>Diagnostics_CheckNameAvailability</description>
/// </item>
/// </list>
/// </summary>
/// <param name="client"> The <see cref="ArmClient" /> instance the method will execute against. </param>
/// <param name="scope"> The scope that the resource will apply against. </param>
/// <param name="content"> The required parameters for availability check. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
public static async Task<Response<SelfHelpNameAvailabilityResult>> CheckSelfHelpNameAvailabilityAsync(this ArmClient client, ResourceIdentifier scope, SelfHelpNameAvailabilityContent content = null, CancellationToken cancellationToken = default)
{
return await GetArmResourceExtensionClient(client, scope).CheckSelfHelpNameAvailabilityAsync(content, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// This API is used to check the uniqueness of a resource name used for a diagnostic check.
/// <list type="bullet">
/// <item>
/// <term>Request Path</term>
/// <description>/{scope}/providers/Microsoft.Help/checkNameAvailability</description>
/// </item>
/// <item>
/// <term>Operation Id</term>
/// <description>Diagnostics_CheckNameAvailability</description>
/// </item>
/// </list>
/// </summary>
/// <param name="client"> The <see cref="ArmClient" /> instance the method will execute against. </param>
/// <param name="scope"> The scope that the resource will apply against. </param>
/// <param name="content"> The required parameters for availability check. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
public static Response<SelfHelpNameAvailabilityResult> CheckSelfHelpNameAvailability(this ArmClient client, ResourceIdentifier scope, SelfHelpNameAvailabilityContent content = null, CancellationToken cancellationToken = default)
{
return GetArmResourceExtensionClient(client, scope).CheckSelfHelpNameAvailability(content, cancellationToken);
}
/// <summary>
/// Solutions Discovery is the initial point of entry within Help API, which helps you identify the relevant solutions for your Azure issue.<br/><br/> You can discover solutions using resourceUri OR resourceUri + problemClassificationId.<br/><br/>We will do our best in returning relevant diagnostics for your Azure issue.<br/><br/> Get the problemClassificationId(s) using this [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).<br/><br/> <b>Note: </b> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API.
/// <list type="bullet">
/// <item>
/// <term>Request Path</term>
/// <description>/{scope}/providers/Microsoft.Help/discoverySolutions</description>
/// </item>
/// <item>
/// <term>Operation Id</term>
/// <description>DiscoverySolution_List</description>
/// </item>
/// </list>
/// </summary>
/// <param name="client"> The <see cref="ArmClient" /> instance the method will execute against. </param>
/// <param name="scope"> The scope that the resource will apply against. </param>
/// <param name="filter"> Can be used to filter solutionIds by 'ProblemClassificationId'. The filter supports only 'and' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' and ProblemClassificationId eq '0a9673c2-7af6-4e19-90d3-4ee2461076d9'. </param>
/// <param name="skiptoken"> Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
public static AsyncPageable<SelfHelpSolutionMetadata> GetSelfHelpDiscoverySolutionsAsync(this ArmClient client, ResourceIdentifier scope, string filter = null, string skiptoken = null, CancellationToken cancellationToken = default)
{
return GetArmResourceExtensionClient(client, scope).GetSelfHelpDiscoverySolutionsAsync(filter, skiptoken, cancellationToken);
}
/// <summary>
/// Solutions Discovery is the initial point of entry within Help API, which helps you identify the relevant solutions for your Azure issue.<br/><br/> You can discover solutions using resourceUri OR resourceUri + problemClassificationId.<br/><br/>We will do our best in returning relevant diagnostics for your Azure issue.<br/><br/> Get the problemClassificationId(s) using this [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).<br/><br/> <b>Note: </b> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via ‘additionalParameters’ as an input to Diagnostics API.
/// <list type="bullet">
/// <item>
/// <term>Request Path</term>
/// <description>/{scope}/providers/Microsoft.Help/discoverySolutions</description>
/// </item>
/// <item>
/// <term>Operation Id</term>
/// <description>DiscoverySolution_List</description>
/// </item>
/// </list>
/// </summary>
/// <param name="client"> The <see cref="ArmClient" /> instance the method will execute against. </param>
/// <param name="scope"> The scope that the resource will apply against. </param>
/// <param name="filter"> Can be used to filter solutionIds by 'ProblemClassificationId'. The filter supports only 'and' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' and ProblemClassificationId eq '0a9673c2-7af6-4e19-90d3-4ee2461076d9'. </param>
/// <param name="skiptoken"> Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. </param>
/// <param name="cancellationToken"> The cancellation token to use. </param>
public static Pageable<SelfHelpSolutionMetadata> GetSelfHelpDiscoverySolutions(this ArmClient client, ResourceIdentifier scope, string filter = null, string skiptoken = null, CancellationToken cancellationToken = default)
{
return GetArmResourceExtensionClient(client, scope).GetSelfHelpDiscoverySolutions(filter, skiptoken, cancellationToken);
}
}
}