IGatewayOperations.RegenerateKeyWithHttpMessagesAsync Method

Definition

Regenerates specified gateway key invalidating any tokens created with it.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> RegenerateKeyWithHttpMessagesAsync (string resourceGroupName, string serviceName, string gatewayId, Microsoft.Azure.Management.ApiManagement.Models.GatewayKeyRegenerationRequestContract parameters, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member RegenerateKeyWithHttpMessagesAsync : string * string * string * Microsoft.Azure.Management.ApiManagement.Models.GatewayKeyRegenerationRequestContract * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function RegenerateKeyWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, gatewayId As String, parameters As GatewayKeyRegenerationRequestContract, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName
System.String

The name of the resource group.

serviceName
System.String

The name of the API Management service.

gatewayId
System.String

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

The headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<AzureOperationResponse>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to