export_pipelines

Creates, updates, deletes, gets or lists an export_pipelines resource.

Overview

Name	export_pipelines
Type	Resource
Id	azure.container_registry.export_pipelines

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the private link resource.
identity	object	The identity of the export pipeline.
location	string	The location of the export pipeline.
options	array	The list of all options configured for the pipeline.
provisioningState	string	The provisioning state of the pipeline at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
target	object	The target properties of the export pipeline. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the private link resource.
identity	object	The identity of the export pipeline.
location	string	The location of the export pipeline.
options	array	The list of all options configured for the pipeline.
provisioningState	string	The provisioning state of the pipeline at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
target	object	The target properties of the export pipeline. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, registry_name, export_pipeline_name, subscription_id		Gets the properties of the export pipeline.
list	select	resource_group_name, registry_name, subscription_id		Lists all export pipelines for the specified container registry.
create	insert	resource_group_name, registry_name, export_pipeline_name, subscription_id		Creates an export pipeline for a container registry with the specified parameters.
delete	delete	resource_group_name, registry_name, export_pipeline_name, subscription_id		Deletes an export pipeline from a container registry.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
export_pipeline_name	string	The name of the export pipeline. Required.
registry_name	string	The name of the container registry. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the properties of the export pipeline.

SELECT
id,
name,
identity,
location,
options,
provisioningState,
systemData,
target,
type
FROM azure.container_registry.export_pipelines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND export_pipeline_name = '{{ export_pipeline_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all export pipelines for the specified container registry.

SELECT
id,
name,
identity,
location,
options,
provisioningState,
systemData,
target,
type
FROM azure.container_registry.export_pipelines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates an export pipeline for a container registry with the specified parameters.

INSERT INTO azure.container_registry.export_pipelines (
properties,
location,
identity,
resource_group_name,
registry_name,
export_pipeline_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ registry_name }}',
'{{ export_pipeline_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: export_pipelines
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the export_pipelines resource.
  - name: registry_name
    value: "{{ registry_name }}"
    description: Required parameter for the export_pipelines resource.
  - name: export_pipeline_name
    value: "{{ export_pipeline_name }}"
    description: Required parameter for the export_pipelines resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the export_pipelines resource.
  - name: properties
    description: |
      The properties of the export pipeline.
    value:
      target:
        type: "{{ type }}"
        uri: "{{ uri }}"
        keyVaultUri: "{{ keyVaultUri }}"
        storageAccessMode: "{{ storageAccessMode }}"
      options:
        - "{{ options }}"
      provisioningState: "{{ provisioningState }}"
  - name: location
    value: "{{ location }}"
    description: |
      The location of the export pipeline.
  - name: identity
    description: |
      The identity of the export pipeline.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

DELETE examples

delete

Deletes an export pipeline from a container registry.

DELETE FROM azure.container_registry.export_pipelines
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND export_pipeline_name = '{{ export_pipeline_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;