1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. AzureContainerRegistry
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

octopusdeploy.AzureContainerRegistry

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

    This resource manages Azure Container Registry feed in Octopus Deploy (alias of Docker Container Registry feed)

    Create AzureContainerRegistry Resource

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

    Constructor syntax

    new AzureContainerRegistry(name: string, args: AzureContainerRegistryArgs, opts?: CustomResourceOptions);
    @overload
    def AzureContainerRegistry(resource_name: str,
                               args: AzureContainerRegistryArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def AzureContainerRegistry(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               feed_uri: Optional[str] = None,
                               api_version: Optional[str] = None,
                               name: Optional[str] = None,
                               oidc_authentication: Optional[AzureContainerRegistryOidcAuthenticationArgs] = None,
                               password: Optional[str] = None,
                               registry_path: Optional[str] = None,
                               space_id: Optional[str] = None,
                               username: Optional[str] = None)
    func NewAzureContainerRegistry(ctx *Context, name string, args AzureContainerRegistryArgs, opts ...ResourceOption) (*AzureContainerRegistry, error)
    public AzureContainerRegistry(string name, AzureContainerRegistryArgs args, CustomResourceOptions? opts = null)
    public AzureContainerRegistry(String name, AzureContainerRegistryArgs args)
    public AzureContainerRegistry(String name, AzureContainerRegistryArgs args, CustomResourceOptions options)
    
    type: octopusdeploy:AzureContainerRegistry
    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 AzureContainerRegistryArgs
    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 AzureContainerRegistryArgs
    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 AzureContainerRegistryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AzureContainerRegistryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AzureContainerRegistryArgs
    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 azureContainerRegistryResource = new Octopusdeploy.AzureContainerRegistry("azureContainerRegistryResource", new()
    {
        FeedUri = "string",
        ApiVersion = "string",
        Name = "string",
        OidcAuthentication = new Octopusdeploy.Inputs.AzureContainerRegistryOidcAuthenticationArgs
        {
            Audience = "string",
            ClientId = "string",
            SubjectKeys = new[]
            {
                "string",
            },
            TenantId = "string",
        },
        Password = "string",
        RegistryPath = "string",
        SpaceId = "string",
        Username = "string",
    });
    
    example, err := octopusdeploy.NewAzureContainerRegistry(ctx, "azureContainerRegistryResource", &octopusdeploy.AzureContainerRegistryArgs{
    	FeedUri:    pulumi.String("string"),
    	ApiVersion: pulumi.String("string"),
    	Name:       pulumi.String("string"),
    	OidcAuthentication: &octopusdeploy.AzureContainerRegistryOidcAuthenticationArgs{
    		Audience: pulumi.String("string"),
    		ClientId: pulumi.String("string"),
    		SubjectKeys: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		TenantId: pulumi.String("string"),
    	},
    	Password:     pulumi.String("string"),
    	RegistryPath: pulumi.String("string"),
    	SpaceId:      pulumi.String("string"),
    	Username:     pulumi.String("string"),
    })
    
    var azureContainerRegistryResource = new AzureContainerRegistry("azureContainerRegistryResource", AzureContainerRegistryArgs.builder()
        .feedUri("string")
        .apiVersion("string")
        .name("string")
        .oidcAuthentication(AzureContainerRegistryOidcAuthenticationArgs.builder()
            .audience("string")
            .clientId("string")
            .subjectKeys("string")
            .tenantId("string")
            .build())
        .password("string")
        .registryPath("string")
        .spaceId("string")
        .username("string")
        .build());
    
    azure_container_registry_resource = octopusdeploy.AzureContainerRegistry("azureContainerRegistryResource",
        feed_uri="string",
        api_version="string",
        name="string",
        oidc_authentication={
            "audience": "string",
            "client_id": "string",
            "subject_keys": ["string"],
            "tenant_id": "string",
        },
        password="string",
        registry_path="string",
        space_id="string",
        username="string")
    
    const azureContainerRegistryResource = new octopusdeploy.AzureContainerRegistry("azureContainerRegistryResource", {
        feedUri: "string",
        apiVersion: "string",
        name: "string",
        oidcAuthentication: {
            audience: "string",
            clientId: "string",
            subjectKeys: ["string"],
            tenantId: "string",
        },
        password: "string",
        registryPath: "string",
        spaceId: "string",
        username: "string",
    });
    
    type: octopusdeploy:AzureContainerRegistry
    properties:
        apiVersion: string
        feedUri: string
        name: string
        oidcAuthentication:
            audience: string
            clientId: string
            subjectKeys:
                - string
            tenantId: string
        password: string
        registryPath: string
        spaceId: string
        username: string
    

    AzureContainerRegistry 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 AzureContainerRegistry resource accepts the following input properties:

    FeedUri string
    ApiVersion string
    Name string
    The name of this resource.
    OidcAuthentication AzureContainerRegistryOidcAuthentication
    Password string
    The password associated with this resource.
    RegistryPath string
    SpaceId string
    The space ID associated with this Azure container registry feed.
    Username string
    The username associated with this resource.
    FeedUri string
    ApiVersion string
    Name string
    The name of this resource.
    OidcAuthentication AzureContainerRegistryOidcAuthenticationArgs
    Password string
    The password associated with this resource.
    RegistryPath string
    SpaceId string
    The space ID associated with this Azure container registry feed.
    Username string
    The username associated with this resource.
    feedUri String
    apiVersion String
    name String
    The name of this resource.
    oidcAuthentication AzureContainerRegistryOidcAuthentication
    password String
    The password associated with this resource.
    registryPath String
    spaceId String
    The space ID associated with this Azure container registry feed.
    username String
    The username associated with this resource.
    feedUri string
    apiVersion string
    name string
    The name of this resource.
    oidcAuthentication AzureContainerRegistryOidcAuthentication
    password string
    The password associated with this resource.
    registryPath string
    spaceId string
    The space ID associated with this Azure container registry feed.
    username string
    The username associated with this resource.
    feed_uri str
    api_version str
    name str
    The name of this resource.
    oidc_authentication AzureContainerRegistryOidcAuthenticationArgs
    password str
    The password associated with this resource.
    registry_path str
    space_id str
    The space ID associated with this Azure container registry feed.
    username str
    The username associated with this resource.
    feedUri String
    apiVersion String
    name String
    The name of this resource.
    oidcAuthentication Property Map
    password String
    The password associated with this resource.
    registryPath String
    spaceId String
    The space ID associated with this Azure container registry feed.
    username String
    The username associated with this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AzureContainerRegistry Resource

    Get an existing AzureContainerRegistry resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AzureContainerRegistryState, opts?: CustomResourceOptions): AzureContainerRegistry
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_version: Optional[str] = None,
            feed_uri: Optional[str] = None,
            name: Optional[str] = None,
            oidc_authentication: Optional[AzureContainerRegistryOidcAuthenticationArgs] = None,
            password: Optional[str] = None,
            registry_path: Optional[str] = None,
            space_id: Optional[str] = None,
            username: Optional[str] = None) -> AzureContainerRegistry
    func GetAzureContainerRegistry(ctx *Context, name string, id IDInput, state *AzureContainerRegistryState, opts ...ResourceOption) (*AzureContainerRegistry, error)
    public static AzureContainerRegistry Get(string name, Input<string> id, AzureContainerRegistryState? state, CustomResourceOptions? opts = null)
    public static AzureContainerRegistry get(String name, Output<String> id, AzureContainerRegistryState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:AzureContainerRegistry    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiVersion string
    FeedUri string
    Name string
    The name of this resource.
    OidcAuthentication AzureContainerRegistryOidcAuthentication
    Password string
    The password associated with this resource.
    RegistryPath string
    SpaceId string
    The space ID associated with this Azure container registry feed.
    Username string
    The username associated with this resource.
    ApiVersion string
    FeedUri string
    Name string
    The name of this resource.
    OidcAuthentication AzureContainerRegistryOidcAuthenticationArgs
    Password string
    The password associated with this resource.
    RegistryPath string
    SpaceId string
    The space ID associated with this Azure container registry feed.
    Username string
    The username associated with this resource.
    apiVersion String
    feedUri String
    name String
    The name of this resource.
    oidcAuthentication AzureContainerRegistryOidcAuthentication
    password String
    The password associated with this resource.
    registryPath String
    spaceId String
    The space ID associated with this Azure container registry feed.
    username String
    The username associated with this resource.
    apiVersion string
    feedUri string
    name string
    The name of this resource.
    oidcAuthentication AzureContainerRegistryOidcAuthentication
    password string
    The password associated with this resource.
    registryPath string
    spaceId string
    The space ID associated with this Azure container registry feed.
    username string
    The username associated with this resource.
    api_version str
    feed_uri str
    name str
    The name of this resource.
    oidc_authentication AzureContainerRegistryOidcAuthenticationArgs
    password str
    The password associated with this resource.
    registry_path str
    space_id str
    The space ID associated with this Azure container registry feed.
    username str
    The username associated with this resource.
    apiVersion String
    feedUri String
    name String
    The name of this resource.
    oidcAuthentication Property Map
    password String
    The password associated with this resource.
    registryPath String
    spaceId String
    The space ID associated with this Azure container registry feed.
    username String
    The username associated with this resource.

    Supporting Types

    AzureContainerRegistryOidcAuthentication, AzureContainerRegistryOidcAuthenticationArgs

    Audience string
    Audience representing the intended recipient of the OIDC token
    ClientId string
    Unique identifier representing the application requesting authentication
    SubjectKeys List<string>
    Keys to include in a deployment or runbook. Valid options are space, feed.
    TenantId string
    Unique identifier representing the Azure AD instance hosting the authenticating application
    Audience string
    Audience representing the intended recipient of the OIDC token
    ClientId string
    Unique identifier representing the application requesting authentication
    SubjectKeys []string
    Keys to include in a deployment or runbook. Valid options are space, feed.
    TenantId string
    Unique identifier representing the Azure AD instance hosting the authenticating application
    audience String
    Audience representing the intended recipient of the OIDC token
    clientId String
    Unique identifier representing the application requesting authentication
    subjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, feed.
    tenantId String
    Unique identifier representing the Azure AD instance hosting the authenticating application
    audience string
    Audience representing the intended recipient of the OIDC token
    clientId string
    Unique identifier representing the application requesting authentication
    subjectKeys string[]
    Keys to include in a deployment or runbook. Valid options are space, feed.
    tenantId string
    Unique identifier representing the Azure AD instance hosting the authenticating application
    audience str
    Audience representing the intended recipient of the OIDC token
    client_id str
    Unique identifier representing the application requesting authentication
    subject_keys Sequence[str]
    Keys to include in a deployment or runbook. Valid options are space, feed.
    tenant_id str
    Unique identifier representing the Azure AD instance hosting the authenticating application
    audience String
    Audience representing the intended recipient of the OIDC token
    clientId String
    Unique identifier representing the application requesting authentication
    subjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, feed.
    tenantId String
    Unique identifier representing the Azure AD instance hosting the authenticating application

    Import

    $ pulumi import octopusdeploy:index/azureContainerRegistry:AzureContainerRegistry [options] octopusdeploy_azure_container_registry.<name> <feed-id>
    

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

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs