/// <summary>
/// Initializes all required properties
/// </summary>
/// <param name="userId">Identifier of associated user</param>
/// <param name="type">Access key type</param>
/// <param name="label">Access key label</param>
public AccessKey(int userId, AccessKeyType type, string label)
{
if (string.IsNullOrEmpty(label))
throw new ArgumentException("Label is null or empty!", "label");
this.UserID = userId;
this.Type = (int)type;
this.Label = label;
this.GenerateKey();
this.Permissions = new List<AccessKeyPermission>();
}
internal static string ToSerializedValue(this AccessKeyType value)
{
switch (value)
{
case AccessKeyType.Primary:
return("Primary");
case AccessKeyType.Secondary:
return("Secondary");
}
return(null);
}
/// <summary>
/// Initializes all required properties
/// </summary>
/// <param name="userId">Identifier of associated user</param>
/// <param name="type">Access key type</param>
/// <param name="label">Access key label</param>
public AccessKey(int userId, AccessKeyType type, string label)
{
if (string.IsNullOrEmpty(label))
{
throw new ArgumentException("Label is null or empty!", "label");
}
this.UserID = userId;
this.Type = (int)type;
this.Label = label;
this.GenerateKey();
this.Permissions = new List <AccessKeyPermission>();
}
public AccessKeyDTO GetDTO()
{
return(new()
{
Id = Id,
CreatedAt = CreatedAt,
UpdatedAt = UpdatedAt,
Description = Description,
LastUsed = LastUsed,
LastUsedFrom = LastUsedFrom,
KeyType = KeyType
});
}
/// <summary>
/// Variant that returns also information if any key was provided
/// </summary>
public static AuthenticationResult HasAuthenticatedAccessKeyExtended(this HttpContext context,
AccessKeyType requiredAccess)
{
var key = context.AuthenticatedAccessKey();
if (key == null)
{
return(AuthenticationResult.NoUser);
}
if (key.KeyType != requiredAccess)
{
return(AuthenticationResult.NoAccess);
}
return(AuthenticationResult.Success);
}
/// <summary>
/// Regenerates the RedisEnterprise database's access keys.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='resourceGroupName'>
/// The name of the resource group. The name is case insensitive.
/// </param>
/// <param name='clusterName'>
/// The name of the RedisEnterprise cluster.
/// </param>
/// <param name='databaseName'>
/// The name of the database.
/// </param>
/// <param name='keyType'>
/// Which access key to regenerate. Possible values include: 'Primary',
/// 'Secondary'
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <AccessKeys> BeginRegenerateKeyAsync(this IDatabasesOperations operations, string resourceGroupName, string clusterName, string databaseName, AccessKeyType keyType, CancellationToken cancellationToken = default(CancellationToken))
{
using (var _result = await operations.BeginRegenerateKeyWithHttpMessagesAsync(resourceGroupName, clusterName, databaseName, keyType, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Regenerates the RedisEnterprise database's access keys.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='resourceGroupName'>
/// The name of the resource group. The name is case insensitive.
/// </param>
/// <param name='clusterName'>
/// The name of the RedisEnterprise cluster.
/// </param>
/// <param name='databaseName'>
/// The name of the database.
/// </param>
/// <param name='keyType'>
/// Which access key to regenerate. Possible values include: 'Primary',
/// 'Secondary'
/// </param>
public static AccessKeys BeginRegenerateKey(this IDatabasesOperations operations, string resourceGroupName, string clusterName, string databaseName, AccessKeyType keyType)
{
return(operations.BeginRegenerateKeyAsync(resourceGroupName, clusterName, databaseName, keyType).GetAwaiter().GetResult());
}
/// <summary>
/// Regenerates the RedisEnterprise database's access keys.
/// </summary>
/// <param name='resourceGroupName'>
/// The name of the resource group.
/// </param>
/// <param name='clusterName'>
/// The name of the RedisEnterprise cluster.
/// </param>
/// <param name='databaseName'>
/// The name of the database.
/// </param>
/// <param name='keyType'>
/// Which access key to regenerate. Possible values include: 'Primary',
/// 'Secondary'
/// </param>
/// <param name='customHeaders'>
/// Headers that will be added to request.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
/// <exception cref="ErrorResponseException">
/// Thrown when the operation returned an invalid status code
/// </exception>
/// <exception cref="SerializationException">
/// Thrown when unable to deserialize the response
/// </exception>
/// <exception cref="ValidationException">
/// Thrown when a required parameter is null
/// </exception>
/// <exception cref="System.ArgumentNullException">
/// Thrown when a required parameter is null
/// </exception>
/// <return>
/// A response object containing the response body and response headers.
/// </return>
public async Task <AzureOperationResponse <AccessKeys> > BeginRegenerateKeyWithHttpMessagesAsync(string resourceGroupName, string clusterName, string databaseName, AccessKeyType keyType, Dictionary <string, List <string> > customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (resourceGroupName == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "resourceGroupName");
}
if (clusterName == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "clusterName");
}
if (databaseName == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "databaseName");
}
if (Client.ApiVersion == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "this.Client.ApiVersion");
}
if (Client.SubscriptionId == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "this.Client.SubscriptionId");
}
RegenerateKeyParameters parameters = new RegenerateKeyParameters();
parameters.KeyType = keyType;
// Tracing
bool _shouldTrace = ServiceClientTracing.IsEnabled;
string _invocationId = null;
if (_shouldTrace)
{
_invocationId = ServiceClientTracing.NextInvocationId.ToString();
Dictionary <string, object> tracingParameters = new Dictionary <string, object>();
tracingParameters.Add("resourceGroupName", resourceGroupName);
tracingParameters.Add("clusterName", clusterName);
tracingParameters.Add("databaseName", databaseName);
tracingParameters.Add("parameters", parameters);
tracingParameters.Add("cancellationToken", cancellationToken);
ServiceClientTracing.Enter(_invocationId, this, "BeginRegenerateKey", tracingParameters);
}
// Construct URL
var _baseUrl = Client.BaseUri.AbsoluteUri;
var _url = new System.Uri(new System.Uri(_baseUrl + (_baseUrl.EndsWith("/") ? "" : "/")), "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/regenerateKey").ToString();
_url = _url.Replace("{resourceGroupName}", System.Uri.EscapeDataString(resourceGroupName));
_url = _url.Replace("{clusterName}", System.Uri.EscapeDataString(clusterName));
_url = _url.Replace("{databaseName}", System.Uri.EscapeDataString(databaseName));
_url = _url.Replace("{subscriptionId}", System.Uri.EscapeDataString(Client.SubscriptionId));
List <string> _queryParameters = new List <string>();
if (Client.ApiVersion != null)
{
_queryParameters.Add(string.Format("api-version={0}", System.Uri.EscapeDataString(Client.ApiVersion)));
}
if (_queryParameters.Count > 0)
{
_url += (_url.Contains("?") ? "&" : "?") + string.Join("&", _queryParameters);
}
// Create HTTP transport objects
var _httpRequest = new HttpRequestMessage();
HttpResponseMessage _httpResponse = null;
_httpRequest.Method = new HttpMethod("POST");
_httpRequest.RequestUri = new System.Uri(_url);
// Set Headers
if (Client.GenerateClientRequestId != null && Client.GenerateClientRequestId.Value)
{
_httpRequest.Headers.TryAddWithoutValidation("x-ms-client-request-id", System.Guid.NewGuid().ToString());
}
if (Client.AcceptLanguage != null)
{
if (_httpRequest.Headers.Contains("accept-language"))
{
_httpRequest.Headers.Remove("accept-language");
}
_httpRequest.Headers.TryAddWithoutValidation("accept-language", Client.AcceptLanguage);
}
if (customHeaders != null)
{
foreach (var _header in customHeaders)
{
if (_httpRequest.Headers.Contains(_header.Key))
{
_httpRequest.Headers.Remove(_header.Key);
}
_httpRequest.Headers.TryAddWithoutValidation(_header.Key, _header.Value);
}
}
// Serialize Request
string _requestContent = null;
if (parameters != null)
{
_requestContent = Rest.Serialization.SafeJsonConvert.SerializeObject(parameters, Client.SerializationSettings);
_httpRequest.Content = new StringContent(_requestContent, System.Text.Encoding.UTF8);
_httpRequest.Content.Headers.ContentType = System.Net.Http.Headers.MediaTypeHeaderValue.Parse("application/json; charset=utf-8");
}
// Set Credentials
if (Client.Credentials != null)
{
cancellationToken.ThrowIfCancellationRequested();
await Client.Credentials.ProcessHttpRequestAsync(_httpRequest, cancellationToken).ConfigureAwait(false);
}
// Send Request
if (_shouldTrace)
{
ServiceClientTracing.SendRequest(_invocationId, _httpRequest);
}
cancellationToken.ThrowIfCancellationRequested();
_httpResponse = await Client.HttpClient.SendAsync(_httpRequest, cancellationToken).ConfigureAwait(false);
if (_shouldTrace)
{
ServiceClientTracing.ReceiveResponse(_invocationId, _httpResponse);
}
HttpStatusCode _statusCode = _httpResponse.StatusCode;
cancellationToken.ThrowIfCancellationRequested();
string _responseContent = null;
if ((int)_statusCode != 200 && (int)_statusCode != 202)
{
var ex = new ErrorResponseException(string.Format("Operation returned an invalid status code '{0}'", _statusCode));
try
{
_responseContent = await _httpResponse.Content.ReadAsStringAsync().ConfigureAwait(false);
ErrorResponse _errorBody = Rest.Serialization.SafeJsonConvert.DeserializeObject <ErrorResponse>(_responseContent, Client.DeserializationSettings);
if (_errorBody != null)
{
ex.Body = _errorBody;
}
}
catch (JsonException)
{
// Ignore the exception
}
ex.Request = new HttpRequestMessageWrapper(_httpRequest, _requestContent);
ex.Response = new HttpResponseMessageWrapper(_httpResponse, _responseContent);
if (_shouldTrace)
{
ServiceClientTracing.Error(_invocationId, ex);
}
_httpRequest.Dispose();
if (_httpResponse != null)
{
_httpResponse.Dispose();
}
throw ex;
}
// Create Result
var _result = new AzureOperationResponse <AccessKeys>();
_result.Request = _httpRequest;
_result.Response = _httpResponse;
if (_httpResponse.Headers.Contains("x-ms-request-id"))
{
_result.RequestId = _httpResponse.Headers.GetValues("x-ms-request-id").FirstOrDefault();
}
// Deserialize Response
if ((int)_statusCode == 200)
{
_responseContent = await _httpResponse.Content.ReadAsStringAsync().ConfigureAwait(false);
try
{
_result.Body = Rest.Serialization.SafeJsonConvert.DeserializeObject <AccessKeys>(_responseContent, Client.DeserializationSettings);
}
catch (JsonException ex)
{
_httpRequest.Dispose();
if (_httpResponse != null)
{
_httpResponse.Dispose();
}
throw new SerializationException("Unable to deserialize the response.", _responseContent, ex);
}
}
if (_shouldTrace)
{
ServiceClientTracing.Exit(_invocationId, _result);
}
return(_result);
}
/// <summary>
/// Regenerates the RedisEnterprise database's access keys.
/// </summary>
/// <param name='resourceGroupName'>
/// The name of the resource group.
/// </param>
/// <param name='clusterName'>
/// The name of the RedisEnterprise cluster.
/// </param>
/// <param name='databaseName'>
/// The name of the database.
/// </param>
/// <param name='keyType'>
/// Which access key to regenerate. Possible values include: 'Primary',
/// 'Secondary'
/// </param>
/// <param name='customHeaders'>
/// The headers that will be added to request.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public async Task <AzureOperationResponse <AccessKeys> > RegenerateKeyWithHttpMessagesAsync(string resourceGroupName, string clusterName, string databaseName, AccessKeyType keyType, Dictionary <string, List <string> > customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))
{
// Send request
AzureOperationResponse <AccessKeys> _response = await BeginRegenerateKeyWithHttpMessagesAsync(resourceGroupName, clusterName, databaseName, keyType, customHeaders, cancellationToken).ConfigureAwait(false);
return(await Client.GetPostOrDeleteOperationResultAsync(_response, customHeaders, cancellationToken).ConfigureAwait(false));
}
/// <summary> /// Converts the <see cref="sourceValue" /> parameter to the <see cref="destinationType" /> parameter using <see cref="formatProvider" /// /> and <see cref="ignoreCase" /> /// </summary> /// <param name="sourceValue">the <see cref="System.Object"/> to convert from</param> /// <param name="destinationType">the <see cref="System.Type" /> to convert to</param> /// <param name="formatProvider">not used by this TypeConverter.</param> /// <param name="ignoreCase">when set to <c>true</c>, will ignore the case when converting.</param> /// <returns> /// an instance of <see cref="AccessKeyType" />, or <c>null</c> if there is no suitable conversion. /// </returns> public override object ConvertFrom(object sourceValue, global::System.Type destinationType, global::System.IFormatProvider formatProvider, bool ignoreCase) => AccessKeyType.CreateFrom(sourceValue);
public static bool HasAuthenticatedAccessKey(this HttpContext context, AccessKeyType requiredAccess)
{
return(context.HasAuthenticatedAccessKeyExtended(requiredAccess) == AuthenticationResult.Success);
}
/// <summary>
/// Initializes a new instance of the RegenerateKeyParameters class.
/// </summary>
/// <param name="keyType">Which access key to regenerate. Possible
/// values include: 'Primary', 'Secondary'</param>
public RegenerateKeyParameters(AccessKeyType keyType)
{
KeyType = keyType;
CustomInit();
}
