Pipeline client 6.0 added to support template parameters for pipelines runs

azure-devops/azext_devops/dev/common/services.py

@@ -190,6 +190,11 @@ def get_new_pipeline_client(organization=None):
     return connection.get_client(VSTS_MODULE + 'v5_1.build.build_client.BuildClient')
 
 
+def get_new_pipeline_client_v60(organization=None):
+    connection = get_connection(organization)
+    return connection.get_client(VSTS_MODULE + 'v6_0.pipelines.pipelines_client.PipelinesClient')
+
+
 def get_new_task_agent_client(organization=None):
     connection = get_connection(organization)
     return connection.get_client(VSTS_MODULE + 'v5_1.task_agent.task_agent_client.TaskAgentClient')

azure-devops/azext_devops/dev/pipelines/arguments.py

@@ -68,6 +68,7 @@ def load_build_arguments(self, _):
 
     with self.argument_context('pipelines run') as context:
         context.argument('id', type=int)
+        context.argument('parameters', nargs='*')
         context.argument('variables', nargs='*')
 
     with self.argument_context('pipelines list') as context:

azure-devops/azext_devops/dev/pipelines/pipeline.py

@@ -8,13 +8,17 @@
 from knack.util import CLIError
 from azext_devops.dev.common.services import (get_build_client,
                                               get_git_client,
-                                              resolve_instance_and_project)
+                                              resolve_instance_and_project,
+                                              get_new_pipeline_client_v60)
 from azext_devops.dev.common.uri import uri_quote
 from azext_devops.dev.common.uuid import is_uuid
 from azext_devops.dev.common.git import resolve_git_ref_heads
 from azext_devops.devops_sdk.v5_0.build.models import Build, DefinitionReference
+from azext_devops.devops_sdk.v6_0.pipelines.models import (RunPipelineParameters,
+                                                           RunResourcesParameters,
+                                                           RepositoryResourceParameters)
 from .build_definition import get_definition_id_from_name, fix_path_for_api
-from .pipeline_run import _open_pipeline_run
+from .pipeline_run import _open_pipeline_run, _open_pipeline_run6_0
 
 logger = get_logger(__name__)
 
@@ -96,8 +100,25 @@ def pipeline_show(id=None, name=None, open=False, organization=None, project=Non
     return build_definition
 
 
+def set_param_variable(variables, as_dict=False, argument='variables'):
+    param_variables = None
+    if variables is not None and variables:
+        param_variables = {}
+        for variable in variables:
+            separator_pos = variable.find('=')
+            if separator_pos >= 0:
+                if as_dict:
+                    param_variables[variable[:separator_pos]] = {"value": variable[separator_pos + 1:]}
+                else:
+                    param_variables[variable[:separator_pos]] = variable[separator_pos + 1:]
+            else:
+                raise ValueError(
+                    f'The --{argument} argument should consist of space separated "name=value" pairs.')
+    return param_variables
+
+
 def pipeline_run(id=None, branch=None, commit_id=None, name=None, open=False, variables=None,  # pylint: disable=redefined-builtin
-                 folder_path=None, organization=None, project=None, detect=None):
+                 folder_path=None, organization=None, project=None, detect=None, parameters=None):
     """ Queue (run) a pipeline.
     :param id: ID of the pipeline to queue. Required if --name is not supplied.
     :type id: int
@@ -110,6 +131,8 @@ def pipeline_run(id=None, branch=None, commit_id=None, name=None, open=False, va
     :type folder_path: str
     :param variables: Space separated "name=value" pairs for the variables you would like to set.
     :type variables: [str]
+    :param parameters: Space separated "name=value" pairs for the parameters you would like to set.
+    :type parameters: [str]
     :param commit_id: Commit-id on which the pipeline run is to be queued.
     :type commit_id: str
     :param open: Open the pipeline results page in your web browser.
@@ -123,20 +146,36 @@ def pipeline_run(id=None, branch=None, commit_id=None, name=None, open=False, va
         raise ValueError('Either the --id argument or the --name argument ' +
                          'must be supplied for this command.')
     client = get_build_client(organization)
+
     if id is None:
         id = get_definition_id_from_name(name, client, project, folder_path)
+
+    if parameters:
+        logger.debug('Using "pipelines client v6_0" to include parameters in run')
+        client = get_new_pipeline_client_v60(organization)
+
+        repositories = {"self": RepositoryResourceParameters(ref_name=branch, version=commit_id)}
+        resources = RunResourcesParameters(repositories=repositories)
+        template_parameters = set_param_variable(parameters, argument='parameters')
+
+        param_variables = set_param_variable(variables, as_dict=True)
+        run_parameters = RunPipelineParameters(
+            resources=resources, variables=param_variables, template_parameters=template_parameters)
+
+        queued_pipeline = client.run_pipeline(run_parameters=run_parameters, project=project, pipeline_id=id)
+        if open:
+            _open_pipeline_run6_0(queued_pipeline, project, organization)
+        return queued_pipeline
+
     definition_reference = DefinitionReference(id=id)
     branch = resolve_git_ref_heads(branch)
     build = Build(definition=definition_reference, source_branch=branch, source_version=commit_id)
-    if variables is not None and variables:
-        build.parameters = {}
-        for variable in variables:
-            separator_pos = variable.find('=')
-            if separator_pos >= 0:
-                build.parameters[variable[:separator_pos]] = variable[separator_pos + 1:]
-            else:
-                raise ValueError('The --variables argument should consist of space separated "name=value" pairs.')
+
+    param_variables = set_param_variable(variables)
+    build.parameters = param_variables
+
     queued_build = client.queue_build(build=build, project=project)
+
     if open:
         _open_pipeline_run(queued_build, organization)
     return queued_build

azure-devops/azext_devops/dev/pipelines/pipeline_run.py

@@ -152,3 +152,16 @@ def _open_pipeline_run(run, organization):
         + uri_quote(str(run.id))
     logger.debug('Opening web page: %s', url)
     open_new(url=url)
+
+
+def _open_pipeline_run6_0(run, project, organization):
+    """Open the build results page in your web browser.
+    :param :class:`<Run> <azure.devops.v6_0.pipelines.models.Run>`
+    :param str project:
+    :param str organization:
+    """
+    from webbrowser import open_new
+    from azext_devops.dev.common.uri import uri_quote
+    url = f"{organization.rstrip('/')}/{uri_quote(project)}/_build/results?buildid={uri_quote(str(run.id))}"
+    logger.debug('Opening web page: %s', url)
+    open_new(url=url)

azure-devops/azext_devops/devops_sdk/v6_0/__init__.py

@@ -0,0 +1,7 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+# Generated file, DO NOT EDIT
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------------------------

azure-devops/azext_devops/devops_sdk/v6_0/accounts/__init__.py

@@ -0,0 +1,17 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+# Generated file, DO NOT EDIT
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------------------------
+
+from .models import *
+from .accounts_client import AccountsClient
+
+__all__ = [
+    'Account',
+    'AccountCreateInfoInternal',
+    'AccountPreferencesInternal',
+    'AccountsClient'
+]

azure-devops/azext_devops/devops_sdk/v6_0/accounts/accounts_client.py

@@ -0,0 +1,48 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+# Generated file, DO NOT EDIT
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------------------------
+
+from msrest import Serializer, Deserializer
+from ...client import Client
+from . import models
+
+
+class AccountsClient(Client):
+    """Accounts
+    :param str base_url: Service URL
+    :param Authentication creds: Authenticated credentials.
+    """
+
+    def __init__(self, base_url=None, creds=None):
+        super(AccountsClient, self).__init__(base_url, creds)
+        client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)}
+        self._serialize = Serializer(client_models)
+        self._deserialize = Deserializer(client_models)
+
+    resource_area_identifier = '0d55247a-1c47-4462-9b1f-5e2125590ee6'
+
+    def get_accounts(self, owner_id=None, member_id=None, properties=None):
+        """GetAccounts.
+        [Preview API] Get a list of accounts for a specific owner or a specific member. One of the following parameters is required: ownerId, memberId.
+        :param str owner_id: ID for the owner of the accounts.
+        :param str member_id: ID for a member of the accounts.
+        :param str properties:
+        :rtype: [Account]
+        """
+        query_parameters = {}
+        if owner_id is not None:
+            query_parameters['ownerId'] = self._serialize.query('owner_id', owner_id, 'str')
+        if member_id is not None:
+            query_parameters['memberId'] = self._serialize.query('member_id', member_id, 'str')
+        if properties is not None:
+            query_parameters['properties'] = self._serialize.query('properties', properties, 'str')
+        response = self._send(http_method='GET',
+                              location_id='229a6a53-b428-4ffb-a835-e8f36b5b4b1e',
+                              version='6.0-preview.1',
+                              query_parameters=query_parameters)
+        return self._deserialize('[Account]', self._unwrap_collection(response))
+

azure-devops/azext_devops/devops_sdk/v6_0/accounts/models.py

@@ -0,0 +1,149 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+# Generated file, DO NOT EDIT
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------------------------
+
+from msrest.serialization import Model
+
+
+class Account(Model):
+    """
+    :param account_id: Identifier for an Account
+    :type account_id: str
+    :param account_name: Name for an account
+    :type account_name: str
+    :param account_owner: Owner of account
+    :type account_owner: str
+    :param account_status: Current account status
+    :type account_status: object
+    :param account_type: Type of account: Personal, Organization
+    :type account_type: object
+    :param account_uri: Uri for an account
+    :type account_uri: str
+    :param created_by: Who created the account
+    :type created_by: str
+    :param created_date: Date account was created
+    :type created_date: datetime
+    :param has_moved:
+    :type has_moved: bool
+    :param last_updated_by: Identity of last person to update the account
+    :type last_updated_by: str
+    :param last_updated_date: Date account was last updated
+    :type last_updated_date: datetime
+    :param namespace_id: Namespace for an account
+    :type namespace_id: str
+    :param new_collection_id:
+    :type new_collection_id: str
+    :param organization_name: Organization that created the account
+    :type organization_name: str
+    :param properties: Extended properties
+    :type properties: :class:`object <azure.devops.v6_0.accounts.models.object>`
+    :param status_reason: Reason for current status
+    :type status_reason: str
+    """
+
+    _attribute_map = {
+        'account_id': {'key': 'accountId', 'type': 'str'},
+        'account_name': {'key': 'accountName', 'type': 'str'},
+        'account_owner': {'key': 'accountOwner', 'type': 'str'},
+        'account_status': {'key': 'accountStatus', 'type': 'object'},
+        'account_type': {'key': 'accountType', 'type': 'object'},
+        'account_uri': {'key': 'accountUri', 'type': 'str'},
+        'created_by': {'key': 'createdBy', 'type': 'str'},
+        'created_date': {'key': 'createdDate', 'type': 'iso-8601'},
+        'has_moved': {'key': 'hasMoved', 'type': 'bool'},
+        'last_updated_by': {'key': 'lastUpdatedBy', 'type': 'str'},
+        'last_updated_date': {'key': 'lastUpdatedDate', 'type': 'iso-8601'},
+        'namespace_id': {'key': 'namespaceId', 'type': 'str'},
+        'new_collection_id': {'key': 'newCollectionId', 'type': 'str'},
+        'organization_name': {'key': 'organizationName', 'type': 'str'},
+        'properties': {'key': 'properties', 'type': 'object'},
+        'status_reason': {'key': 'statusReason', 'type': 'str'}
+    }
+
+    def __init__(self, account_id=None, account_name=None, account_owner=None, account_status=None, account_type=None, account_uri=None, created_by=None, created_date=None, has_moved=None, last_updated_by=None, last_updated_date=None, namespace_id=None, new_collection_id=None, organization_name=None, properties=None, status_reason=None):
+        super(Account, self).__init__()
+        self.account_id = account_id
+        self.account_name = account_name
+        self.account_owner = account_owner
+        self.account_status = account_status
+        self.account_type = account_type
+        self.account_uri = account_uri
+        self.created_by = created_by
+        self.created_date = created_date
+        self.has_moved = has_moved
+        self.last_updated_by = last_updated_by
+        self.last_updated_date = last_updated_date
+        self.namespace_id = namespace_id
+        self.new_collection_id = new_collection_id
+        self.organization_name = organization_name
+        self.properties = properties
+        self.status_reason = status_reason
+
+
+class AccountCreateInfoInternal(Model):
+    """
+    :param account_name:
+    :type account_name: str
+    :param creator:
+    :type creator: str
+    :param organization:
+    :type organization: str
+    :param preferences:
+    :type preferences: :class:`AccountPreferencesInternal <azure.devops.v6_0.accounts.models.AccountPreferencesInternal>`
+    :param properties:
+    :type properties: :class:`object <azure.devops.v6_0.accounts.models.object>`
+    :param service_definitions:
+    :type service_definitions: list of { key: str; value: str }
+    """
+
+    _attribute_map = {
+        'account_name': {'key': 'accountName', 'type': 'str'},
+        'creator': {'key': 'creator', 'type': 'str'},
+        'organization': {'key': 'organization', 'type': 'str'},
+        'preferences': {'key': 'preferences', 'type': 'AccountPreferencesInternal'},
+        'properties': {'key': 'properties', 'type': 'object'},
+        'service_definitions': {'key': 'serviceDefinitions', 'type': '[{ key: str; value: str }]'}
+    }
+
+    def __init__(self, account_name=None, creator=None, organization=None, preferences=None, properties=None, service_definitions=None):
+        super(AccountCreateInfoInternal, self).__init__()
+        self.account_name = account_name
+        self.creator = creator
+        self.organization = organization
+        self.preferences = preferences
+        self.properties = properties
+        self.service_definitions = service_definitions
+
+
+class AccountPreferencesInternal(Model):
+    """
+    :param culture:
+    :type culture: object
+    :param language:
+    :type language: object
+    :param time_zone:
+    :type time_zone: object
+    """
+
+    _attribute_map = {
+        'culture': {'key': 'culture', 'type': 'object'},
+        'language': {'key': 'language', 'type': 'object'},
+        'time_zone': {'key': 'timeZone', 'type': 'object'}
+    }
+
+    def __init__(self, culture=None, language=None, time_zone=None):
+        super(AccountPreferencesInternal, self).__init__()
+        self.culture = culture
+        self.language = language
+        self.time_zone = time_zone
+
+
+__all__ = [
+    'Account',
+    'AccountCreateInfoInternal',
+    'AccountPreferencesInternal',
+]

azure-devops/azext_devops/devops_sdk/v6_0/audit/__init__.py

@@ -0,0 +1,19 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+# Generated file, DO NOT EDIT
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------------------------
+
+from .models import *
+from .audit_client import AuditClient
+
+__all__ = [
+    'AuditActionInfo',
+    'AuditLogEntry',
+    'AuditLogQueryResult',
+    'AuditStream',
+    'DecoratedAuditLogEntry',
+    'AuditClient'
+]