Share via

Microsoft.ContainerRegistry registries/importPipelines 2021-08-01-preview

  • Article

Bicep resource definition

The registries/importPipelines 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/importPipelines resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerRegistry/registries/importPipelines@2021-08-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'
    ]
    source: {
      keyVaultUri: 'string'
      type: 'string'
      uri: 'string'
    }
    trigger: {
      sourceTrigger: {
        status: 'string'
      }
    }
  }
}

Property values

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

ImportPipelineProperties

Name Description Value
options The list of all options configured for the pipeline. String array containing any of:
'ContinueOnErrors'
'DeleteSourceBlobOnSuccess'
'OverwriteBlobs'
'OverwriteTags'
source The source properties of the import pipeline. ImportPipelineSourceProperties (required)
trigger The properties that describe the trigger of the import pipeline. PipelineTriggerProperties

ImportPipelineSourceProperties

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

Microsoft.ContainerRegistry/registries/importPipelines

Name Description Value
identity The identity of the import pipeline. IdentityProperties
location The location of the import 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 import pipeline. ImportPipelineProperties

PipelineSourceTriggerProperties

Name Description Value
status The current status of the source trigger. 'Disabled'
'Enabled' (required)

PipelineTriggerProperties

Name Description Value
sourceTrigger The source trigger properties of the pipeline. PipelineSourceTriggerProperties

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/importPipelines 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/importPipelines resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerRegistry/registries/importPipelines",
  "apiVersion": "2021-08-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "options": [ "string" ],
    "source": {
      "keyVaultUri": "string",
      "type": "string",
      "uri": "string"
    },
    "trigger": {
      "sourceTrigger": {
        "status": "string"
      }
    }
  }
}

Property values

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

ImportPipelineProperties

Name Description Value
options The list of all options configured for the pipeline. String array containing any of:
'ContinueOnErrors'
'DeleteSourceBlobOnSuccess'
'OverwriteBlobs'
'OverwriteTags'
source The source properties of the import pipeline. ImportPipelineSourceProperties (required)
trigger The properties that describe the trigger of the import pipeline. PipelineTriggerProperties

ImportPipelineSourceProperties

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

Microsoft.ContainerRegistry/registries/importPipelines

Name Description Value
apiVersion The api version '2021-08-01-preview'
identity The identity of the import pipeline. IdentityProperties
location The location of the import 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 import pipeline. ImportPipelineProperties
type The resource type 'Microsoft.ContainerRegistry/registries/importPipelines'

PipelineSourceTriggerProperties

Name Description Value
status The current status of the source trigger. 'Disabled'
'Enabled' (required)

PipelineTriggerProperties

Name Description Value
sourceTrigger The source trigger properties of the pipeline. PipelineSourceTriggerProperties

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/importPipelines 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/importPipelines resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerRegistry/registries/importPipelines@2021-08-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"
      ]
      source = {
        keyVaultUri = "string"
        type = "string"
        uri = "string"
      }
      trigger = {
        sourceTrigger = {
          status = "string"
        }
      }
    }
  })
}

Property values

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

ImportPipelineProperties

Name Description Value
options The list of all options configured for the pipeline. String array containing any of:
'ContinueOnErrors'
'DeleteSourceBlobOnSuccess'
'OverwriteBlobs'
'OverwriteTags'
source The source properties of the import pipeline. ImportPipelineSourceProperties (required)
trigger The properties that describe the trigger of the import pipeline. PipelineTriggerProperties

ImportPipelineSourceProperties

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

Microsoft.ContainerRegistry/registries/importPipelines

Name Description Value
identity The identity of the import pipeline. IdentityProperties
location The location of the import 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 import pipeline. ImportPipelineProperties
type The resource type "Microsoft.ContainerRegistry/registries/importPipelines@2021-08-01-preview"

PipelineSourceTriggerProperties

Name Description Value
status The current status of the source trigger. 'Disabled'
'Enabled' (required)

PipelineTriggerProperties

Name Description Value
sourceTrigger The source trigger properties of the pipeline. PipelineSourceTriggerProperties

UserIdentityProperties

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