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

• Latest
• 2024-11-01-preview
• 2023-11-01-preview
• 2023-08-01-preview
• 2023-06-01-preview
• 2023-01-01-preview
• 2022-02-01-preview
• 2021-12-01-preview
• 2021-08-01-preview
• 2021-06-01-preview
• 2020-11-01-preview
• 2019-12-01-preview

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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' = {
  parent: resourceSymbolicName
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: [
      'string'
    ]
    target: {
      keyVaultUri: 'string'
      type: 'string'
      uri: 'string'
    }
  }
}

Property values

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

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}'.	IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Name	Description	Value

Microsoft.ContainerRegistry/registries/exportPipelines

Name	Description	Value
identity	The identity of the export pipeline.	IdentityProperties
location	The location of the export pipeline.	string
name	The resource name	string Constraints: Min length = 5 Max length = 5 Pattern = ^[a-zA-Z0-9]*$ (required)
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
properties	The properties of the export pipeline.	ExportPipelineProperties

UserIdentityProperties

Name	Description	Value
clientId	The client id of user assigned identity.	string
principalId	The principal id of user assigned identity.	string

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "options": [ "string" ],
    "target": {
      "keyVaultUri": "string",
      "type": "string",
      "uri": "string"
    }
  }
}

Property values

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

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}'.	IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Name	Description	Value

Microsoft.ContainerRegistry/registries/exportPipelines

Name	Description	Value
apiVersion	The api version	'2023-01-01-preview'
identity	The identity of the export pipeline.	IdentityProperties
location	The location of the export pipeline.	string
name	The resource name	string Constraints: Min length = 5 Max length = 5 Pattern = ^[a-zA-Z0-9]*$ (required)
properties	The properties of the export pipeline.	ExportPipelineProperties
type	The resource type	'Microsoft.ContainerRegistry/registries/exportPipelines'

UserIdentityProperties

Name	Description	Value
clientId	The client id of user assigned identity.	string
principalId	The principal id of user assigned identity.	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"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  body = jsonencode({
    properties = {
      options = [
        "string"
      ]
      target = {
        keyVaultUri = "string"
        type = "string"
        uri = "string"
      }
    }
  })
}

Property values

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

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}'.	IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Name	Description	Value

Microsoft.ContainerRegistry/registries/exportPipelines

Name	Description	Value
identity	The identity of the export pipeline.	IdentityProperties
location	The location of the export pipeline.	string
name	The resource name	string Constraints: Min length = 5 Max length = 5 Pattern = ^[a-zA-Z0-9]*$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: registries
properties	The properties of the export pipeline.	ExportPipelineProperties
type	The resource type	"Microsoft.ContainerRegistry/registries/exportPipelines@2023-01-01-preview"

UserIdentityProperties

Name	Description	Value
clientId	The client id of user assigned identity.	string
principalId	The principal id of user assigned identity.	string