azure-native.apimanagement.Cache
Explore with Pulumi AI
Cache details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2019-12-01-preview, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview.
Example Usage
ApiManagementCreateCache
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var cache = new AzureNative.ApiManagement.Cache("cache", new()
{
CacheId = "c1",
ConnectionString = "apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False",
Description = "Redis cache instances in West India",
ResourceGroupName = "rg1",
ResourceId = "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1",
ServiceName = "apimService1",
UseFromLocation = "default",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewCache(ctx, "cache", &apimanagement.CacheArgs{
CacheId: pulumi.String("c1"),
ConnectionString: pulumi.String("apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False"),
Description: pulumi.String("Redis cache instances in West India"),
ResourceGroupName: pulumi.String("rg1"),
ResourceId: pulumi.String("https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1"),
ServiceName: pulumi.String("apimService1"),
UseFromLocation: pulumi.String("default"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Cache;
import com.pulumi.azurenative.apimanagement.CacheArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var cache = new Cache("cache", CacheArgs.builder()
.cacheId("c1")
.connectionString("apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False")
.description("Redis cache instances in West India")
.resourceGroupName("rg1")
.resourceId("https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1")
.serviceName("apimService1")
.useFromLocation("default")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
cache = azure_native.apimanagement.Cache("cache",
cache_id="c1",
connection_string="apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False",
description="Redis cache instances in West India",
resource_group_name="rg1",
resource_id="https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1",
service_name="apimService1",
use_from_location="default")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const cache = new azure_native.apimanagement.Cache("cache", {
cacheId: "c1",
connectionString: "apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False",
description: "Redis cache instances in West India",
resourceGroupName: "rg1",
resourceId: "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1",
serviceName: "apimService1",
useFromLocation: "default",
});
resources:
cache:
type: azure-native:apimanagement:Cache
properties:
cacheId: c1
connectionString: apim.redis.cache.windows.net:6380,password=xc,ssl=True,abortConnect=False
description: Redis cache instances in West India
resourceGroupName: rg1
resourceId: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/apimservice1
serviceName: apimService1
useFromLocation: default
Create Cache Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cache(name: string, args: CacheArgs, opts?: CustomResourceOptions);
@overload
def Cache(resource_name: str,
args: CacheArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cache(resource_name: str,
opts: Optional[ResourceOptions] = None,
connection_string: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
use_from_location: Optional[str] = None,
cache_id: Optional[str] = None,
description: Optional[str] = None,
resource_id: Optional[str] = None)
func NewCache(ctx *Context, name string, args CacheArgs, opts ...ResourceOption) (*Cache, error)
public Cache(string name, CacheArgs args, CustomResourceOptions? opts = null)
type: azure-native:apimanagement:Cache
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var cacheResource = new AzureNative.ApiManagement.Cache("cacheResource", new()
{
ConnectionString = "string",
ResourceGroupName = "string",
ServiceName = "string",
UseFromLocation = "string",
CacheId = "string",
Description = "string",
ResourceId = "string",
});
example, err := apimanagement.NewCache(ctx, "cacheResource", &apimanagement.CacheArgs{
ConnectionString: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
UseFromLocation: pulumi.String("string"),
CacheId: pulumi.String("string"),
Description: pulumi.String("string"),
ResourceId: pulumi.String("string"),
})
var cacheResource = new Cache("cacheResource", CacheArgs.builder()
.connectionString("string")
.resourceGroupName("string")
.serviceName("string")
.useFromLocation("string")
.cacheId("string")
.description("string")
.resourceId("string")
.build());
cache_resource = azure_native.apimanagement.Cache("cacheResource",
connection_string="string",
resource_group_name="string",
service_name="string",
use_from_location="string",
cache_id="string",
description="string",
resource_id="string")
const cacheResource = new azure_native.apimanagement.Cache("cacheResource", {
connectionString: "string",
resourceGroupName: "string",
serviceName: "string",
useFromLocation: "string",
cacheId: "string",
description: "string",
resourceId: "string",
});
type: azure-native:apimanagement:Cache
properties:
cacheId: string
connectionString: string
description: string
resourceGroupName: string
resourceId: string
serviceName: string
useFromLocation: string
Cache Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Cache resource accepts the following input properties:
- Connection
String string - Runtime connection string to cache
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Use
From stringLocation - Location identifier to use cache from (should be either 'default' or valid Azure region identifier)
- Cache
Id string - Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).
- Description string
- Cache description
- Resource
Id string - Original uri of entity in external system cache points to
- Connection
String string - Runtime connection string to cache
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Use
From stringLocation - Location identifier to use cache from (should be either 'default' or valid Azure region identifier)
- Cache
Id string - Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).
- Description string
- Cache description
- Resource
Id string - Original uri of entity in external system cache points to
- connection
String String - Runtime connection string to cache
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- use
From StringLocation - Location identifier to use cache from (should be either 'default' or valid Azure region identifier)
- cache
Id String - Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).
- description String
- Cache description
- resource
Id String - Original uri of entity in external system cache points to
- connection
String string - Runtime connection string to cache
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- use
From stringLocation - Location identifier to use cache from (should be either 'default' or valid Azure region identifier)
- cache
Id string - Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).
- description string
- Cache description
- resource
Id string - Original uri of entity in external system cache points to
- connection_
string str - Runtime connection string to cache
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- use_
from_ strlocation - Location identifier to use cache from (should be either 'default' or valid Azure region identifier)
- cache_
id str - Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).
- description str
- Cache description
- resource_
id str - Original uri of entity in external system cache points to
- connection
String String - Runtime connection string to cache
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- use
From StringLocation - Location identifier to use cache from (should be either 'default' or valid Azure region identifier)
- cache
Id String - Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).
- description String
- Cache description
- resource
Id String - Original uri of entity in external system cache points to
Outputs
All input properties are implicitly available as output properties. Additionally, the Cache resource produces the following output properties:
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:Cache c1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/caches/{cacheId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0