Share via

Microsoft.ContainerRegistry registries/exportPipelines 2023-01-01-preview

  • Article

Bicep resource definition

The registries/exportPipelines resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerRegistry/registries/exportPipelines resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerRegistry/registries/exportPipelines@2023-01-01-preview' = {
  name: 'string'
  location: 'string'
  parent: resourceSymbolicName
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    options: [
      'string'
    ]
    target: {
      keyVaultUri: 'string'
      type: 'string'
      uri: 'string'
    }
  }
}

Property values

registries/exportPipelines

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location The location of the export pipeline. string
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: registries
identity The identity of the export pipeline. IdentityProperties
properties The properties of the export pipeline. ExportPipelineProperties

IdentityProperties

Name Description Value
principalId The principal ID of resource identity. string
tenantId The tenant ID of resource. string
type The identity type. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities The list of user identities associated with the resource. The user identity
dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 object

ExportPipelineProperties

Name Description Value
options The list of all options configured for the pipeline. String array containing any of:
'ContinueOnErrors'
'DeleteSourceBlobOnSuccess'
'OverwriteBlobs'
'OverwriteTags'
target The target properties of the export pipeline. ExportPipelineTargetProperties (required)

ExportPipelineTargetProperties

Name Description Value
keyVaultUri They key vault secret uri to obtain the target storage SAS token. string (required)
type The type of target for the export pipeline. string
uri The target uri of the export pipeline.
When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName"
When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName"
 string

ARM template resource definition

The registries/exportPipelines resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerRegistry/registries/exportPipelines resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerRegistry/registries/exportPipelines",
  "apiVersion": "2023-01-01-preview",
  "name": "string",
  "location": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "options": [ "string" ],
    "target": {
      "keyVaultUri": "string",
      "type": "string",
      "uri": "string"
    }
  }
}

Property values

registries/exportPipelines

Name Description Value
type The resource type 'Microsoft.ContainerRegistry/registries/exportPipelines'
apiVersion The resource api version '2023-01-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location The location of the export pipeline. string
identity The identity of the export pipeline. IdentityProperties
properties The properties of the export pipeline. ExportPipelineProperties

IdentityProperties

Name Description Value
principalId The principal ID of resource identity. string
tenantId The tenant ID of resource. string
type The identity type. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities The list of user identities associated with the resource. The user identity
dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 object

ExportPipelineProperties

Name Description Value
options The list of all options configured for the pipeline. String array containing any of:
'ContinueOnErrors'
'DeleteSourceBlobOnSuccess'
'OverwriteBlobs'
'OverwriteTags'
target The target properties of the export pipeline. ExportPipelineTargetProperties (required)

ExportPipelineTargetProperties

Name Description Value
keyVaultUri They key vault secret uri to obtain the target storage SAS token. string (required)
type The type of target for the export pipeline. string
uri The target uri of the export pipeline.
When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName"
When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName"
 string

Terraform (AzAPI provider) resource definition

The registries/exportPipelines resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerRegistry/registries/exportPipelines resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerRegistry/registries/exportPipelines@2023-01-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      options = [
        "string"
      ]
      target = {
        keyVaultUri = "string"
        type = "string"
        uri = "string"
      }
    }
  })
}

Property values

registries/exportPipelines

Name Description Value
type The resource type "Microsoft.ContainerRegistry/registries/exportPipelines@2023-01-01-preview"
name The resource name string (required)
location The location of the export pipeline. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: registries
identity The identity of the export pipeline. IdentityProperties
properties The properties of the export pipeline. ExportPipelineProperties

IdentityProperties

Name Description Value
type The identity type. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids The list of user identities associated with the resource. The user identity
dictionary key references will be ARM resource ids in the form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 Array of user identity IDs.

ExportPipelineProperties

Name Description Value
options The list of all options configured for the pipeline. String array containing any of:
"ContinueOnErrors"
"DeleteSourceBlobOnSuccess"
"OverwriteBlobs"
"OverwriteTags"
target The target properties of the export pipeline. ExportPipelineTargetProperties (required)

ExportPipelineTargetProperties

Name Description Value
keyVaultUri They key vault secret uri to obtain the target storage SAS token. string (required)
type The type of target for the export pipeline. string
uri The target uri of the export pipeline.
When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName"
When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName"
 string