-
Notifications
You must be signed in to change notification settings - Fork 255
/
KubernetesExtensions.xml
208 lines (208 loc) · 21.3 KB
/
KubernetesExtensions.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
<Type Name="KubernetesExtensions" FullName="Azure.ResourceManager.Kubernetes.KubernetesExtensions">
<TypeSignature Language="C#" Value="public static class KubernetesExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit KubernetesExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.ResourceManager.Kubernetes.KubernetesExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module KubernetesExtensions" />
<TypeSignature Language="F#" Value="type KubernetesExtensions = class" />
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Kubernetes</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> A class to add extension methods to Azure.ResourceManager.Kubernetes. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetConnectedCluster">
<MemberSignature Language="C#" Value="public static Azure.Response<Azure.ResourceManager.Kubernetes.ConnectedClusterResource> GetConnectedCluster (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Response`1<class Azure.ResourceManager.Kubernetes.ConnectedClusterResource> GetConnectedCluster(class Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedCluster(Azure.ResourceManager.Resources.ResourceGroupResource,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetConnectedCluster (resourceGroupResource As ResourceGroupResource, clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ConnectedClusterResource)" />
<MemberSignature Language="F#" Value="static member GetConnectedCluster : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Kubernetes.ConnectedClusterResource>" Usage="Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedCluster (resourceGroupResource, clusterName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Kubernetes</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.ResourceManager.Kubernetes.ConnectedClusterResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="resourceGroupResource" Type="Azure.ResourceManager.Resources.ResourceGroupResource" RefType="this" />
<Parameter Name="clusterName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="resourceGroupResource"> The <see cref="T:Azure.ResourceManager.Resources.ResourceGroupResource" /> instance the method will execute against. </param>
<param name="clusterName"> The name of the Kubernetes cluster on which get is called. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}</description></item><item><term>Operation Id</term><description>ConnectedCluster_Get</description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Kubernetes.Mocking.MockableKubernetesResourceGroupResource.GetConnectedCluster(System.String,System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="resourceGroupResource" /> or <paramref name="clusterName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="clusterName" /> is an empty string, and was expected to be non-empty. </exception>
</Docs>
</Member>
<Member MemberName="GetConnectedClusterAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Kubernetes.ConnectedClusterResource>> GetConnectedClusterAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.ResourceManager.Kubernetes.ConnectedClusterResource>> GetConnectedClusterAsync(class Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedClusterAsync(Azure.ResourceManager.Resources.ResourceGroupResource,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetConnectedClusterAsync (resourceGroupResource As ResourceGroupResource, clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ConnectedClusterResource))" />
<MemberSignature Language="F#" Value="static member GetConnectedClusterAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Kubernetes.ConnectedClusterResource>>" Usage="Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedClusterAsync (resourceGroupResource, clusterName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Kubernetes</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Kubernetes.ConnectedClusterResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="resourceGroupResource" Type="Azure.ResourceManager.Resources.ResourceGroupResource" RefType="this" />
<Parameter Name="clusterName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="resourceGroupResource"> The <see cref="T:Azure.ResourceManager.Resources.ResourceGroupResource" /> instance the method will execute against. </param>
<param name="clusterName"> The name of the Kubernetes cluster on which get is called. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}</description></item><item><term>Operation Id</term><description>ConnectedCluster_Get</description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Kubernetes.Mocking.MockableKubernetesResourceGroupResource.GetConnectedClusterAsync(System.String,System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="resourceGroupResource" /> or <paramref name="clusterName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="clusterName" /> is an empty string, and was expected to be non-empty. </exception>
</Docs>
</Member>
<Member MemberName="GetConnectedClusterResource">
<MemberSignature Language="C#" Value="public static Azure.ResourceManager.Kubernetes.ConnectedClusterResource GetConnectedClusterResource (this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier id);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.ResourceManager.Kubernetes.ConnectedClusterResource GetConnectedClusterResource(class Azure.ResourceManager.ArmClient client, class Azure.Core.ResourceIdentifier id) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedClusterResource(Azure.ResourceManager.ArmClient,Azure.Core.ResourceIdentifier)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetConnectedClusterResource (client As ArmClient, id As ResourceIdentifier) As ConnectedClusterResource" />
<MemberSignature Language="F#" Value="static member GetConnectedClusterResource : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier -> Azure.ResourceManager.Kubernetes.ConnectedClusterResource" Usage="Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedClusterResource (client, id)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Kubernetes</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.ResourceManager.Kubernetes.ConnectedClusterResource</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="Azure.ResourceManager.ArmClient" RefType="this" />
<Parameter Name="id" Type="Azure.Core.ResourceIdentifier" />
</Parameters>
<Docs>
<param name="client"> The <see cref="T:Azure.ResourceManager.ArmClient" /> instance the method will execute against. </param>
<param name="id"> The resource ID of the resource to get. </param>
<summary>
Gets an object representing a <see cref="T:Azure.ResourceManager.Kubernetes.ConnectedClusterResource" /> along with the instance operations that can be performed on it but with no data.
You can use <see cref="M:Azure.ResourceManager.Kubernetes.ConnectedClusterResource.CreateResourceIdentifier(System.String,System.String,System.String)" /> to create a <see cref="T:Azure.ResourceManager.Kubernetes.ConnectedClusterResource" /><see cref="T:Azure.Core.ResourceIdentifier" /> from its components.
<item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Kubernetes.Mocking.MockableKubernetesArmClient.GetConnectedClusterResource(Azure.Core.ResourceIdentifier)" /> instead.</description></item></summary>
<returns> Returns a <see cref="T:Azure.ResourceManager.Kubernetes.ConnectedClusterResource" /> object. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="client" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetConnectedClusters">
<MemberSignature Language="C#" Value="public static Azure.ResourceManager.Kubernetes.ConnectedClusterCollection GetConnectedClusters (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.ResourceManager.Kubernetes.ConnectedClusterCollection GetConnectedClusters(class Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedClusters(Azure.ResourceManager.Resources.ResourceGroupResource)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetConnectedClusters (resourceGroupResource As ResourceGroupResource) As ConnectedClusterCollection" />
<MemberSignature Language="F#" Value="static member GetConnectedClusters : Azure.ResourceManager.Resources.ResourceGroupResource -> Azure.ResourceManager.Kubernetes.ConnectedClusterCollection" Usage="Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedClusters resourceGroupResource" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Kubernetes</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.ResourceManager.Kubernetes.ConnectedClusterCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="resourceGroupResource" Type="Azure.ResourceManager.Resources.ResourceGroupResource" RefType="this" />
</Parameters>
<Docs>
<param name="resourceGroupResource"> The <see cref="T:Azure.ResourceManager.Resources.ResourceGroupResource" /> instance the method will execute against. </param>
<summary>
Gets a collection of ConnectedClusterResources in the ResourceGroupResource.
<item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Kubernetes.Mocking.MockableKubernetesResourceGroupResource.GetConnectedClusters" /> instead.</description></item></summary>
<returns> An object representing collection of ConnectedClusterResources and their operations over a ConnectedClusterResource. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="resourceGroupResource" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetConnectedClusters">
<MemberSignature Language="C#" Value="public static Azure.Pageable<Azure.ResourceManager.Kubernetes.ConnectedClusterResource> GetConnectedClusters (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Pageable`1<class Azure.ResourceManager.Kubernetes.ConnectedClusterResource> GetConnectedClusters(class Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedClusters(Azure.ResourceManager.Resources.SubscriptionResource,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetConnectedClusters (subscriptionResource As SubscriptionResource, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ConnectedClusterResource)" />
<MemberSignature Language="F#" Value="static member GetConnectedClusters : Azure.ResourceManager.Resources.SubscriptionResource * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Kubernetes.ConnectedClusterResource>" Usage="Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedClusters (subscriptionResource, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Kubernetes</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.ResourceManager.Kubernetes.ConnectedClusterResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subscriptionResource" Type="Azure.ResourceManager.Resources.SubscriptionResource" RefType="this" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="subscriptionResource"> The <see cref="T:Azure.ResourceManager.Resources.SubscriptionResource" /> instance the method will execute against. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
API to enumerate registered connected K8s clusters under a Subscription
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/providers/Microsoft.Kubernetes/connectedClusters</description></item><item><term>Operation Id</term><description>ConnectedCluster_ListBySubscription</description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Kubernetes.Mocking.MockableKubernetesSubscriptionResource.GetConnectedClusters(System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns> A collection of <see cref="T:Azure.ResourceManager.Kubernetes.ConnectedClusterResource" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="subscriptionResource" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetConnectedClustersAsync">
<MemberSignature Language="C#" Value="public static Azure.AsyncPageable<Azure.ResourceManager.Kubernetes.ConnectedClusterResource> GetConnectedClustersAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AsyncPageable`1<class Azure.ResourceManager.Kubernetes.ConnectedClusterResource> GetConnectedClustersAsync(class Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedClustersAsync(Azure.ResourceManager.Resources.SubscriptionResource,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetConnectedClustersAsync (subscriptionResource As SubscriptionResource, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ConnectedClusterResource)" />
<MemberSignature Language="F#" Value="static member GetConnectedClustersAsync : Azure.ResourceManager.Resources.SubscriptionResource * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Kubernetes.ConnectedClusterResource>" Usage="Azure.ResourceManager.Kubernetes.KubernetesExtensions.GetConnectedClustersAsync (subscriptionResource, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Kubernetes</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.ResourceManager.Kubernetes.ConnectedClusterResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subscriptionResource" Type="Azure.ResourceManager.Resources.SubscriptionResource" RefType="this" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="subscriptionResource"> The <see cref="T:Azure.ResourceManager.Resources.SubscriptionResource" /> instance the method will execute against. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
API to enumerate registered connected K8s clusters under a Subscription
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/providers/Microsoft.Kubernetes/connectedClusters</description></item><item><term>Operation Id</term><description>ConnectedCluster_ListBySubscription</description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Kubernetes.Mocking.MockableKubernetesSubscriptionResource.GetConnectedClusters(System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns> An async collection of <see cref="T:Azure.ResourceManager.Kubernetes.ConnectedClusterResource" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="subscriptionResource" /> is null. </exception>
</Docs>
</Member>
</Members>
</Type>