Update-AzApiManagementCache
updates a cache in Api Management service.
Syntax
ExpandedParameter (Default)
Update-AzApiManagementCache
-Context <PsApiManagementContext>
-CacheId <String>
[-ConnectionString <String>]
[-AzureRedisResourceId <String>]
[-Description <String>]
[-UseFromLocation <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzApiManagementCache
-InputObject <PsApiManagementCache>
[-ConnectionString <String>]
[-AzureRedisResourceId <String>]
[-Description <String>]
[-UseFromLocation <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceId
Update-AzApiManagementCache
-ResourceId <String>
[-ConnectionString <String>]
[-AzureRedisResourceId <String>]
[-Description <String>]
[-UseFromLocation <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The cmdlet Update-AzApiManagementCache updates a cache in the ApiManagement service.
Examples
Example 1 : Updates the Description of the Cache in centralus
$context=New-AzApiManagementContext -ResourceGroupName Api-Default-Central-US -ServiceName contoso
Update-AzApiManagementCache -Context $context -CacheId centralus -Description "Team new cache" -PassThru
CacheId : centralus
Description : Team new cache
ConnectionString : {{5cc19889e6ed3b0524c3f7d3}}
AzureRedisResourceId :
Id : /subscriptions/subid/resourceGroups/Api-Default-Central-US/providers/M
icrosoft.ApiManagement/service/contoso/caches/centralus
ResourceGroupName : Api-Default-Central-US
ServiceName : contoso
Updates the description of the Cache in Central US.
Parameters
-AzureRedisResourceId
Arm ResourceId of the Azure Redis Cache instance.
This parameter is optional.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-CacheId
Identifier of new cache.
This parameter is required.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ExpandedParameter
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConnectionString
Redis Connection String.
This parameter is optional.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Context
Instance of PsApiManagementContext.
This parameter is required.
Parameter properties
Parameter sets
ExpandedParameter
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Description
Cache Description.
This parameter is optional.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
Instance of PsApiManagementCache.
This parameter is required.
ByInputObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCache type representing the modified cache will be written to output.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
Arm ResourceId of Cache.
This parameter is required.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-UseFromLocation
Cache UseFromLocation. This parameter is optional, default value 'default'.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
