public override void ExecuteCmdlet()
{
// In case of piped parent object "RedisCacheAttributes" fetch ResourceGroupName and Name from it
if (ParameterSetName.Equals(InputObjectParameterSet))
{
FetchResourceGroupNameAndNameFromInputObject();
}
else if (ParameterSetName.Equals(ResourceIdParameterSet))
{
FetchResourceGroupNameAndNameFromResourceId();
}
Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
ResourceGroupName = CacheClient.GetResourceGroupNameIfNotProvided(ResourceGroupName, Name);
ConfirmAction(
string.Format(Resources.CreatingFirewallRule, Name),
Name,
() =>
{
RedisFirewallRule redisFirewallRule = CacheClient.SetFirewallRule(
resourceGroupName: ResourceGroupName,
cacheName: Name,
ruleName: RuleName,
startIP: StartIP,
endIP: EndIP);
if (redisFirewallRule == null)
{
throw new CloudException(string.Format(Resources.FirewallRuleCreationFailed));
}
WriteObject(new PSRedisFirewallRule(ResourceGroupName, Name, redisFirewallRule));
}
);
}
internal PSRedisFirewallRule(string resourceGroupName, string cacheName, RedisFirewallRule redisFirewallRule)
{
ResourceGroupName = resourceGroupName;
Name = cacheName;
FirewallRuleId = redisFirewallRule.Id;
RuleName = NormalizeFirewallRuleName(redisFirewallRule.Name);
Type = redisFirewallRule.Type;
StartIP = redisFirewallRule.StartIP;
EndIP = redisFirewallRule.EndIP;
}
public override void ExecuteCmdlet()
{
Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
ResourceGroupName = CacheClient.GetResourceGroupNameIfNotProvided(ResourceGroupName, Name);
if (!string.IsNullOrEmpty(RuleName))
{
RedisFirewallRule redisFirewallRule = CacheClient.GetFirewallRule(
resourceGroupName: ResourceGroupName,
cacheName: Name,
ruleName: RuleName);
if (redisFirewallRule == null)
{
throw new CloudException(string.Format(Resources.FirewallRuleNotFound, Name, RuleName));
}
WriteObject(new PSRedisFirewallRule(ResourceGroupName, Name, redisFirewallRule));
}
else
{
IPage <RedisFirewallRule> response = CacheClient.ListFirewallRules(ResourceGroupName, Name);
List <PSRedisFirewallRule> list = new List <PSRedisFirewallRule>();
foreach (RedisFirewallRule redisFirewallRule in response)
{
list.Add(new PSRedisFirewallRule(ResourceGroupName, Name, redisFirewallRule));
}
while (!string.IsNullOrEmpty(response.NextPageLink))
{
response = CacheClient.ListFirewallRules(response.NextPageLink);
foreach (RedisFirewallRule redisFirewallRule in response)
{
list.Add(new PSRedisFirewallRule(ResourceGroupName, Name, redisFirewallRule));
}
}
WriteObject(list, true);
}
}
public void FirewallFunctionalTest()
{
using (var context = MockContext.Start(this.GetType()))
{
var _redisCacheManagementHelper = new RedisCacheManagementHelper(this, context);
_redisCacheManagementHelper.TryRegisterSubscriptionForResource();
var resourceGroupName = TestUtilities.GenerateName("RedisFirewall");
var redisCacheName = TestUtilities.GenerateName("RedisFirewall");
var _client = RedisCacheManagementTestUtilities.GetRedisManagementClient(this, context);
_redisCacheManagementHelper.TryCreateResourceGroup(resourceGroupName, RedisCacheManagementHelper.Location);
_client.Redis.Create(resourceGroupName, redisCacheName,
parameters: new RedisCreateParameters
{
Location = RedisCacheManagementHelper.Location,
Sku = new Sku()
{
Name = SkuName.Premium,
Family = SkuFamily.P,
Capacity = 1
}
});
// First try to get cache and verify that it is premium cache
RedisResource response = _client.Redis.Get(resourceGroupName, redisCacheName);
Assert.Contains(redisCacheName, response.Id);
Assert.Equal(redisCacheName, response.Name);
Assert.Equal(ProvisioningState.Succeeded, response.ProvisioningState, ignoreCase: true);
Assert.Equal(SkuName.Premium, response.Sku.Name);
Assert.Equal(SkuFamily.P, response.Sku.Family);
// Set firewall rule for 10.0.0.0 to 10.0.0.32
RedisFirewallRule ruleOne = _client.FirewallRules.CreateOrUpdate(resourceGroupName, redisCacheName, "RuleOne", new RedisFirewallRuleCreateParameters
{
StartIP = "10.0.0.0",
EndIP = "10.0.0.32"
});
Assert.Equal("10.0.0.0", ruleOne.StartIP);
Assert.Equal("10.0.0.32", ruleOne.EndIP);
// Set firewall rule for 10.0.0.64 to 10.0.0.128
RedisFirewallRule ruleTwo = _client.FirewallRules.CreateOrUpdate(resourceGroupName, redisCacheName, "RuleTwo", new RedisFirewallRuleCreateParameters
{
StartIP = "10.0.0.64",
EndIP = "10.0.0.128"
});
Assert.Equal("10.0.0.64", ruleTwo.StartIP);
Assert.Equal("10.0.0.128", ruleTwo.EndIP);
// Get test
ruleOne = _client.FirewallRules.Get(resourceGroupName, redisCacheName, "RuleOne");
Assert.Equal("10.0.0.0", ruleOne.StartIP);
Assert.Equal("10.0.0.32", ruleOne.EndIP);
ruleTwo = _client.FirewallRules.Get(resourceGroupName, redisCacheName, "RuleTwo");
Assert.Equal("10.0.0.64", ruleTwo.StartIP);
Assert.Equal("10.0.0.128", ruleTwo.EndIP);
// List test
IPage <RedisFirewallRule> rules = _client.FirewallRules.List(resourceGroupName, redisCacheName);
Assert.Equal(2, rules.Count());
// Delete
_client.FirewallRules.Delete(resourceGroupName, redisCacheName, "RuleTwo");
if (Utility.IsLiveTest())
{
Thread.Sleep(6000);
}
rules = _client.FirewallRules.List(resourceGroupName, redisCacheName);
Assert.Single(rules);
Assert.Equal("10.0.0.0", rules.First().StartIP);
Assert.Equal("10.0.0.32", rules.First().EndIP);
}
}
/// <summary>
/// Create or update a redis cache firewall rule
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='resourceGroupName'>
/// The name of the resource group.
/// </param>
/// <param name='cacheName'>
/// The name of the Redis cache.
/// </param>
/// <param name='ruleName'>
/// The name of the firewall rule.
/// </param>
/// <param name='parameters'>
/// Parameters supplied to the create or update redis firewall rule operation.
/// </param>
public static RedisFirewallRule CreateOrUpdate(this IFirewallRulesOperations operations, string resourceGroupName, string cacheName, string ruleName, RedisFirewallRule parameters)
{
return(operations.CreateOrUpdateAsync(resourceGroupName, cacheName, ruleName, parameters).GetAwaiter().GetResult());
}
/// <summary>
/// Create or update a redis cache firewall rule
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='resourceGroupName'>
/// The name of the resource group.
/// </param>
/// <param name='cacheName'>
/// The name of the Redis cache.
/// </param>
/// <param name='ruleName'>
/// The name of the firewall rule.
/// </param>
/// <param name='parameters'>
/// Parameters supplied to the create or update redis firewall rule operation.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <RedisFirewallRule> CreateOrUpdateAsync(this IFirewallRulesOperations operations, string resourceGroupName, string cacheName, string ruleName, RedisFirewallRule parameters, CancellationToken cancellationToken = default(CancellationToken))
{
using (var _result = await operations.CreateOrUpdateWithHttpMessagesAsync(resourceGroupName, cacheName, ruleName, parameters, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Create or update a redis cache firewall rule
/// </summary>
/// <param name='resourceGroupName'>
/// The name of the resource group.
/// </param>
/// <param name='cacheName'>
/// The name of the Redis cache.
/// </param>
/// <param name='ruleName'>
/// The name of the firewall rule.
/// </param>
/// <param name='parameters'>
/// Parameters supplied to the create or update redis firewall rule operation.
/// </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 <RedisFirewallRule> > CreateOrUpdateWithHttpMessagesAsync(string resourceGroupName, string cacheName, string ruleName, RedisFirewallRule parameters, Dictionary <string, List <string> > customHeaders = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (resourceGroupName == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "resourceGroupName");
}
if (cacheName == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "cacheName");
}
if (ruleName == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "ruleName");
}
if (parameters == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "parameters");
}
if (parameters != null)
{
parameters.Validate();
}
if (Client.ApiVersion == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "this.Client.ApiVersion");
}
if (Client.SubscriptionId == null)
{
throw new ValidationException(ValidationRules.CannotBeNull, "this.Client.SubscriptionId");
}
// 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("cacheName", cacheName);
tracingParameters.Add("ruleName", ruleName);
tracingParameters.Add("parameters", parameters);
tracingParameters.Add("cancellationToken", cancellationToken);
ServiceClientTracing.Enter(_invocationId, this, "CreateOrUpdate", 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/redis/{cacheName}/firewallRules/{ruleName}").ToString();
_url = _url.Replace("{resourceGroupName}", System.Uri.EscapeDataString(resourceGroupName));
_url = _url.Replace("{cacheName}", System.Uri.EscapeDataString(cacheName));
_url = _url.Replace("{ruleName}", System.Uri.EscapeDataString(ruleName));
_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("PUT");
_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 != 201)
{
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 <RedisFirewallRule>();
_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 <RedisFirewallRule>(_responseContent, Client.DeserializationSettings);
}
catch (JsonException ex)
{
_httpRequest.Dispose();
if (_httpResponse != null)
{
_httpResponse.Dispose();
}
throw new SerializationException("Unable to deserialize the response.", _responseContent, ex);
}
}
// Deserialize Response
if ((int)_statusCode == 201)
{
_responseContent = await _httpResponse.Content.ReadAsStringAsync().ConfigureAwait(false);
try
{
_result.Body = Rest.Serialization.SafeJsonConvert.DeserializeObject <RedisFirewallRule>(_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);
}
