Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The registries/pipelineRuns 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/pipelineRuns resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ContainerRegistry/registries/pipelineRuns@2021-12-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
forceUpdateTag: 'string'
request: {
artifacts: [
'string'
]
catalogDigest: 'string'
pipelineResourceId: 'string'
source: {
name: 'string'
type: 'string'
}
target: {
name: 'string'
type: 'string'
}
}
}
}
Property Values
Microsoft.ContainerRegistry/registries/pipelineRuns
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 5 Max length = 50 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 a pipeline run. | PipelineRunProperties |
PipelineRunProperties
| Name | Description | Value |
|---|---|---|
| forceUpdateTag | How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. | string |
| request | The request parameters for a pipeline run. | PipelineRunRequest |
PipelineRunRequest
| Name | Description | Value |
|---|---|---|
| artifacts | List of source artifacts to be transferred by the pipeline. Specify an image by repository ('hello-world'). This will use the 'latest' tag. Specify an image by tag ('hello-world:latest'). Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). |
string[] |
| catalogDigest | The digest of the tar used to transfer the artifacts. | string |
| pipelineResourceId | The resource ID of the pipeline to run. | string |
| source | The source properties of the pipeline run. | PipelineRunSourceProperties |
| target | The target properties of the pipeline run. | PipelineRunTargetProperties |
PipelineRunSourceProperties
| Name | Description | Value |
|---|---|---|
| name | The name of the source. | string |
| type | The type of the source. | 'AzureStorageBlob' |
PipelineRunTargetProperties
| Name | Description | Value |
|---|---|---|
| name | The name of the target. | string |
| type | The type of the target. | 'AzureStorageBlob' |
ARM template resource definition
The registries/pipelineRuns 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/pipelineRuns resource, add the following JSON to your template.
{
"type": "Microsoft.ContainerRegistry/registries/pipelineRuns",
"apiVersion": "2021-12-01-preview",
"name": "string",
"properties": {
"forceUpdateTag": "string",
"request": {
"artifacts": [ "string" ],
"catalogDigest": "string",
"pipelineResourceId": "string",
"source": {
"name": "string",
"type": "string"
},
"target": {
"name": "string",
"type": "string"
}
}
}
}
Property Values
Microsoft.ContainerRegistry/registries/pipelineRuns
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-12-01-preview' |
| name | The resource name | string Constraints: Min length = 5 Max length = 50 Pattern = ^[a-zA-Z0-9]*$ (required) |
| properties | The properties of a pipeline run. | PipelineRunProperties |
| type | The resource type | 'Microsoft.ContainerRegistry/registries/pipelineRuns' |
PipelineRunProperties
| Name | Description | Value |
|---|---|---|
| forceUpdateTag | How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. | string |
| request | The request parameters for a pipeline run. | PipelineRunRequest |
PipelineRunRequest
| Name | Description | Value |
|---|---|---|
| artifacts | List of source artifacts to be transferred by the pipeline. Specify an image by repository ('hello-world'). This will use the 'latest' tag. Specify an image by tag ('hello-world:latest'). Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). |
string[] |
| catalogDigest | The digest of the tar used to transfer the artifacts. | string |
| pipelineResourceId | The resource ID of the pipeline to run. | string |
| source | The source properties of the pipeline run. | PipelineRunSourceProperties |
| target | The target properties of the pipeline run. | PipelineRunTargetProperties |
PipelineRunSourceProperties
| Name | Description | Value |
|---|---|---|
| name | The name of the source. | string |
| type | The type of the source. | 'AzureStorageBlob' |
PipelineRunTargetProperties
| Name | Description | Value |
|---|---|---|
| name | The name of the target. | string |
| type | The type of the target. | 'AzureStorageBlob' |
Usage Examples
Terraform (AzAPI provider) resource definition
The registries/pipelineRuns 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/pipelineRuns resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerRegistry/registries/pipelineRuns@2021-12-01-preview"
name = "string"
body = {
properties = {
forceUpdateTag = "string"
request = {
artifacts = [
"string"
]
catalogDigest = "string"
pipelineResourceId = "string"
source = {
name = "string"
type = "string"
}
target = {
name = "string"
type = "string"
}
}
}
}
}
Property Values
Microsoft.ContainerRegistry/registries/pipelineRuns
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 5 Max length = 50 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 a pipeline run. | PipelineRunProperties |
| type | The resource type | "Microsoft.ContainerRegistry/registries/pipelineRuns@2021-12-01-preview" |
PipelineRunProperties
| Name | Description | Value |
|---|---|---|
| forceUpdateTag | How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. | string |
| request | The request parameters for a pipeline run. | PipelineRunRequest |
PipelineRunRequest
| Name | Description | Value |
|---|---|---|
| artifacts | List of source artifacts to be transferred by the pipeline. Specify an image by repository ('hello-world'). This will use the 'latest' tag. Specify an image by tag ('hello-world:latest'). Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). |
string[] |
| catalogDigest | The digest of the tar used to transfer the artifacts. | string |
| pipelineResourceId | The resource ID of the pipeline to run. | string |
| source | The source properties of the pipeline run. | PipelineRunSourceProperties |
| target | The target properties of the pipeline run. | PipelineRunTargetProperties |
PipelineRunSourceProperties
| Name | Description | Value |
|---|---|---|
| name | The name of the source. | string |
| type | The type of the source. | 'AzureStorageBlob' |
PipelineRunTargetProperties
| Name | Description | Value |
|---|---|---|
| name | The name of the target. | string |
| type | The type of the target. | 'AzureStorageBlob' |