IGatewayOperations.RegenerateKeyWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.ApiManagement

Assembly:

Microsoft.Azure.Management.ApiManagement.dll

Package:

Microsoft.Azure.Management.ApiManagement v8.0.0-preview

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

String

The name of the resource group.

serviceName

String

The name of the API Management service.

gatewayId

String

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

parameters

GatewayKeyRegenerationRequestContract

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null