Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. containerregistry
  5. CacheRule
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.containerregistry.CacheRule

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    An object that represents a cache rule for a container registry. Azure REST API version: 2023-01-01-preview.

    Other available API versions: 2023-06-01-preview, 2023-07-01, 2023-08-01-preview, 2023-11-01-preview.

    Example Usage

    CacheRuleCreate

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var cacheRule = new AzureNative.ContainerRegistry.CacheRule("cacheRule", new()
    {
        CacheRuleName = "myCacheRule",
        CredentialSetResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
        RegistryName = "myRegistry",
        ResourceGroupName = "myResourceGroup",
        SourceRepository = "docker.io/library/hello-world",
        TargetRepository = "cached-docker-hub/hello-world",
    });

});

    package main

import (
	containerregistry "github.com/pulumi/pulumi-azure-native-sdk/containerregistry/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := containerregistry.NewCacheRule(ctx, "cacheRule", &containerregistry.CacheRuleArgs{
			CacheRuleName:           pulumi.String("myCacheRule"),
			CredentialSetResourceId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet"),
			RegistryName:            pulumi.String("myRegistry"),
			ResourceGroupName:       pulumi.String("myResourceGroup"),
			SourceRepository:        pulumi.String("docker.io/library/hello-world"),
			TargetRepository:        pulumi.String("cached-docker-hub/hello-world"),
		})
		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.containerregistry.CacheRule;
import com.pulumi.azurenative.containerregistry.CacheRuleArgs;
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 cacheRule = new CacheRule("cacheRule", CacheRuleArgs.builder()
            .cacheRuleName("myCacheRule")
            .credentialSetResourceId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet")
            .registryName("myRegistry")
            .resourceGroupName("myResourceGroup")
            .sourceRepository("docker.io/library/hello-world")
            .targetRepository("cached-docker-hub/hello-world")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

cache_rule = azure_native.containerregistry.CacheRule("cacheRule",
    cache_rule_name="myCacheRule",
    credential_set_resource_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
    registry_name="myRegistry",
    resource_group_name="myResourceGroup",
    source_repository="docker.io/library/hello-world",
    target_repository="cached-docker-hub/hello-world")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const cacheRule = new azure_native.containerregistry.CacheRule("cacheRule", {
    cacheRuleName: "myCacheRule",
    credentialSetResourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
    registryName: "myRegistry",
    resourceGroupName: "myResourceGroup",
    sourceRepository: "docker.io/library/hello-world",
    targetRepository: "cached-docker-hub/hello-world",
});

    resources:
  cacheRule:
    type: azure-native:containerregistry:CacheRule
    properties:
      cacheRuleName: myCacheRule
      credentialSetResourceId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet
      registryName: myRegistry
      resourceGroupName: myResourceGroup
      sourceRepository: docker.io/library/hello-world
      targetRepository: cached-docker-hub/hello-world

    Create CacheRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CacheRule(name: string, args: CacheRuleArgs, opts?: CustomResourceOptions);
    @overload
def CacheRule(resource_name: str,
              args: CacheRuleArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def CacheRule(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              registry_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              cache_rule_name: Optional[str] = None,
              credential_set_resource_id: Optional[str] = None,
              source_repository: Optional[str] = None,
              target_repository: Optional[str] = None)
    func NewCacheRule(ctx *Context, name string, args CacheRuleArgs, opts ...ResourceOption) (*CacheRule, error)
    public CacheRule(string name, CacheRuleArgs args, CustomResourceOptions? opts = null)
    public CacheRule(String name, CacheRuleArgs args)
public CacheRule(String name, CacheRuleArgs args, CustomResourceOptions options)

    type: azure-native:containerregistry:CacheRule
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 CacheRuleArgs
    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 CacheRuleArgs
    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 CacheRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CacheRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CacheRuleArgs
    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 cacheRuleResource = new AzureNative.ContainerRegistry.CacheRule("cacheRuleResource", new()
{
    RegistryName = "string",
    ResourceGroupName = "string",
    CacheRuleName = "string",
    CredentialSetResourceId = "string",
    SourceRepository = "string",
    TargetRepository = "string",
});

    example, err := containerregistry.NewCacheRule(ctx, "cacheRuleResource", &containerregistry.CacheRuleArgs{
	RegistryName:            pulumi.String("string"),
	ResourceGroupName:       pulumi.String("string"),
	CacheRuleName:           pulumi.String("string"),
	CredentialSetResourceId: pulumi.String("string"),
	SourceRepository:        pulumi.String("string"),
	TargetRepository:        pulumi.String("string"),
})

    var cacheRuleResource = new CacheRule("cacheRuleResource", CacheRuleArgs.builder()
    .registryName("string")
    .resourceGroupName("string")
    .cacheRuleName("string")
    .credentialSetResourceId("string")
    .sourceRepository("string")
    .targetRepository("string")
    .build());

    cache_rule_resource = azure_native.containerregistry.CacheRule("cacheRuleResource",
    registry_name="string",
    resource_group_name="string",
    cache_rule_name="string",
    credential_set_resource_id="string",
    source_repository="string",
    target_repository="string")

    const cacheRuleResource = new azure_native.containerregistry.CacheRule("cacheRuleResource", {
    registryName: "string",
    resourceGroupName: "string",
    cacheRuleName: "string",
    credentialSetResourceId: "string",
    sourceRepository: "string",
    targetRepository: "string",
});

    type: azure-native:containerregistry:CacheRule
properties:
    cacheRuleName: string
    credentialSetResourceId: string
    registryName: string
    resourceGroupName: string
    sourceRepository: string
    targetRepository: string

    CacheRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CacheRule resource accepts the following input properties:

    RegistryName string
    The name of the container registry.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    CacheRuleName string
    The name of the cache rule.
    CredentialSetResourceId string
    The ARM resource ID of the credential store which is associated with the cache rule.
    SourceRepository string
    Source repository pulled from upstream.
    TargetRepository string
    Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}
    RegistryName string
    The name of the container registry.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    CacheRuleName string
    The name of the cache rule.
    CredentialSetResourceId string
    The ARM resource ID of the credential store which is associated with the cache rule.
    SourceRepository string
    Source repository pulled from upstream.
    TargetRepository string
    Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}
    registryName String
    The name of the container registry.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    cacheRuleName String
    The name of the cache rule.
    credentialSetResourceId String
    The ARM resource ID of the credential store which is associated with the cache rule.
    sourceRepository String
    Source repository pulled from upstream.
    targetRepository String
    Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}
    registryName string
    The name of the container registry.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    cacheRuleName string
    The name of the cache rule.
    credentialSetResourceId string
    The ARM resource ID of the credential store which is associated with the cache rule.
    sourceRepository string
    Source repository pulled from upstream.
    targetRepository string
    Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}
    registry_name str
    The name of the container registry.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    cache_rule_name str
    The name of the cache rule.
    credential_set_resource_id str
    The ARM resource ID of the credential store which is associated with the cache rule.
    source_repository str
    Source repository pulled from upstream.
    target_repository str
    Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}
    registryName String
    The name of the container registry.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    cacheRuleName String
    The name of the cache rule.
    credentialSetResourceId String
    The ARM resource ID of the credential store which is associated with the cache rule.
    sourceRepository String
    Source repository pulled from upstream.
    targetRepository String
    Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CacheRule resource produces the following output properties:

    CreationDate string
    The creation date of the cache rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource.
    ProvisioningState string
    Provisioning state of the resource.
    SystemData Pulumi.AzureNative.ContainerRegistry.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource.
    CreationDate string
    The creation date of the cache rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource.
    ProvisioningState string
    Provisioning state of the resource.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource.
    creationDate String
    The creation date of the cache rule.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource.
    provisioningState String
    Provisioning state of the resource.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource.
    creationDate string
    The creation date of the cache rule.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource.
    provisioningState string
    Provisioning state of the resource.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource.
    creation_date str
    The creation date of the cache rule.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource.
    provisioning_state str
    Provisioning state of the resource.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource.
    creationDate String
    The creation date of the cache rule.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource.
    provisioningState String
    Provisioning state of the resource.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource.

    Supporting Types

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource modification (UTC).
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource modification (UTC).
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource modification (UTC).
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource modification (UTC).
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource modification (UTC).
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource modification (UTC).
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:containerregistry:CacheRule myCacheRule /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native