-
Notifications
You must be signed in to change notification settings - Fork 256
/
IQuotaByPeriodKeysOperations.xml
151 lines (151 loc) · 12.1 KB
/
IQuotaByPeriodKeysOperations.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
<Type Name="IQuotaByPeriodKeysOperations" FullName="Microsoft.Azure.Management.ApiManagement.IQuotaByPeriodKeysOperations">
<TypeSignature Language="C#" Value="public interface IQuotaByPeriodKeysOperations" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IQuotaByPeriodKeysOperations" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.ApiManagement.IQuotaByPeriodKeysOperations" />
<TypeSignature Language="VB.NET" Value="Public Interface IQuotaByPeriodKeysOperations" />
<TypeSignature Language="F#" Value="type IQuotaByPeriodKeysOperations = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ApiManagement</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
QuotaByPeriodKeysOperations operations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterContract>> GetWithHttpMessagesAsync (string resourceGroupName, string serviceName, string quotaCounterKey, string quotaPeriodKey, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.Azure.AzureOperationResponse`1<class Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterContract>> GetWithHttpMessagesAsync(string resourceGroupName, string serviceName, string quotaCounterKey, string quotaPeriodKey, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ApiManagement.IQuotaByPeriodKeysOperations.GetWithHttpMessagesAsync(System.String,System.String,System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, quotaCounterKey As String, quotaPeriodKey As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of QuotaCounterContract))" />
<MemberSignature Language="F#" Value="abstract member GetWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterContract>>" Usage="iQuotaByPeriodKeysOperations.GetWithHttpMessagesAsync (resourceGroupName, serviceName, quotaCounterKey, quotaPeriodKey, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ApiManagement</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterContract>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="resourceGroupName" Type="System.String" />
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="quotaCounterKey" Type="System.String" />
<Parameter Name="quotaPeriodKey" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="resourceGroupName">
The name of the resource group.
</param>
<param name="serviceName">
The name of the API Management service.
</param>
<param name="quotaCounterKey">
Quota counter key identifier.This is the result of expression
defined in counter-key attribute of the quota-by-key policy.For
Example, if you specify counter-key="boo" in the policy, then it’s
accessible by "boo" counter key. But if it’s defined as
counter-key="@("b"+"a")" then it will be accessible by "ba" key
</param>
<param name="quotaPeriodKey">
Quota period key identifier.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Gets the value of the quota counter associated with the counter-key
in the policy for the specific period in service instance.
<see href="https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies" /></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.Management.ApiManagement.Models.ErrorResponseException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
</Docs>
</Member>
<Member MemberName="UpdateWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterContract>> UpdateWithHttpMessagesAsync (string resourceGroupName, string serviceName, string quotaCounterKey, string quotaPeriodKey, Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterValueUpdateContract parameters, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.Azure.AzureOperationResponse`1<class Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterContract>> UpdateWithHttpMessagesAsync(string resourceGroupName, string serviceName, string quotaCounterKey, string quotaPeriodKey, class Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterValueUpdateContract parameters, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ApiManagement.IQuotaByPeriodKeysOperations.UpdateWithHttpMessagesAsync(System.String,System.String,System.String,System.String,Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterValueUpdateContract,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function UpdateWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, quotaCounterKey As String, quotaPeriodKey As String, parameters As QuotaCounterValueUpdateContract, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of QuotaCounterContract))" />
<MemberSignature Language="F#" Value="abstract member UpdateWithHttpMessagesAsync : string * string * string * string * Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterValueUpdateContract * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterContract>>" Usage="iQuotaByPeriodKeysOperations.UpdateWithHttpMessagesAsync (resourceGroupName, serviceName, quotaCounterKey, quotaPeriodKey, parameters, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ApiManagement</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterContract>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="resourceGroupName" Type="System.String" />
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="quotaCounterKey" Type="System.String" />
<Parameter Name="quotaPeriodKey" Type="System.String" />
<Parameter Name="parameters" Type="Microsoft.Azure.Management.ApiManagement.Models.QuotaCounterValueUpdateContract" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="resourceGroupName">
The name of the resource group.
</param>
<param name="serviceName">
The name of the API Management service.
</param>
<param name="quotaCounterKey">
Quota counter key identifier.This is the result of expression
defined in counter-key attribute of the quota-by-key policy.For
Example, if you specify counter-key="boo" in the policy, then it’s
accessible by "boo" counter key. But if it’s defined as
counter-key="@("b"+"a")" then it will be accessible by "ba" key
</param>
<param name="quotaPeriodKey">
Quota period key identifier.
</param>
<param name="parameters">
The value of the Quota counter to be applied on the specified
period.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Updates an existing quota counter value in the specified service
instance.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.Management.ApiManagement.Models.ErrorResponseException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
</Docs>
</Member>
</Members>
</Type>