AdministrationService Web Service

AdministrationService

Click here for a complete list of operations.

QueryBuildAgentsByUri

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /_tfs_resources/Build/V4.0/AdministrationService.asmx HTTP/1.1
Host: dev.pikacom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schemas.microsoft.com/TeamFoundation/2010/Build/QueryBuildAgentsByUri"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QueryBuildAgentsByUri xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <agentUris>
        <string>string</string>
        <string>string</string>
      </agentUris>
      <propertyNameFilters>
        <string>string</string>
        <string>string</string>
      </propertyNameFilters>
    </QueryBuildAgentsByUri>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QueryBuildAgentsByUriResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <QueryBuildAgentsByUriResult>
        <Agents>
          <BuildAgent Uri="string" ServiceHostUri="string" ControllerUri="string" Name="string" BuildDirectory="string" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime" ReservedForBuild="string">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildAgent>
          <BuildAgent Uri="string" ServiceHostUri="string" ControllerUri="string" Name="string" BuildDirectory="string" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime" ReservedForBuild="string">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildAgent>
        </Agents>
        <Controllers>
          <BuildController Uri="string" ServiceHostUri="string" Name="string" CustomAssemblyPath="string" MaxConcurrentBuilds="int" QueueCount="int" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildController>
          <BuildController Uri="string" ServiceHostUri="string" Name="string" CustomAssemblyPath="string" MaxConcurrentBuilds="int" QueueCount="int" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildController>
        </Controllers>
        <ServiceHosts>
          <BuildServiceHost BaseUrl="string" IsVirtual="boolean" MessageQueueUrl="string" Name="string" RequireClientCertificates="boolean" Status="Online or Offline" StatusChangedOn="dateTime" AcquiredOn="dateTime" ConnectedOn="dateTime" Uri="string" />
          <BuildServiceHost BaseUrl="string" IsVirtual="boolean" MessageQueueUrl="string" Name="string" RequireClientCertificates="boolean" Status="Online or Offline" StatusChangedOn="dateTime" AcquiredOn="dateTime" ConnectedOn="dateTime" Uri="string" />
        </ServiceHosts>
      </QueryBuildAgentsByUriResult>
    </QueryBuildAgentsByUriResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /_tfs_resources/Build/V4.0/AdministrationService.asmx HTTP/1.1
Host: dev.pikacom.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryBuildAgentsByUri xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <agentUris>
        <string>string</string>
        <string>string</string>
      </agentUris>
      <propertyNameFilters>
        <string>string</string>
        <string>string</string>
      </propertyNameFilters>
    </QueryBuildAgentsByUri>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryBuildAgentsByUriResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <QueryBuildAgentsByUriResult>
        <Agents>
          <BuildAgent Uri="string" ServiceHostUri="string" ControllerUri="string" Name="string" BuildDirectory="string" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime" ReservedForBuild="string">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildAgent>
          <BuildAgent Uri="string" ServiceHostUri="string" ControllerUri="string" Name="string" BuildDirectory="string" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime" ReservedForBuild="string">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildAgent>
        </Agents>
        <Controllers>
          <BuildController Uri="string" ServiceHostUri="string" Name="string" CustomAssemblyPath="string" MaxConcurrentBuilds="int" QueueCount="int" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildController>
          <BuildController Uri="string" ServiceHostUri="string" Name="string" CustomAssemblyPath="string" MaxConcurrentBuilds="int" QueueCount="int" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildController>
        </Controllers>
        <ServiceHosts>
          <BuildServiceHost BaseUrl="string" IsVirtual="boolean" MessageQueueUrl="string" Name="string" RequireClientCertificates="boolean" Status="Online or Offline" StatusChangedOn="dateTime" AcquiredOn="dateTime" ConnectedOn="dateTime" Uri="string" />
          <BuildServiceHost BaseUrl="string" IsVirtual="boolean" MessageQueueUrl="string" Name="string" RequireClientCertificates="boolean" Status="Online or Offline" StatusChangedOn="dateTime" AcquiredOn="dateTime" ConnectedOn="dateTime" Uri="string" />
        </ServiceHosts>
      </QueryBuildAgentsByUriResult>
    </QueryBuildAgentsByUriResponse>
  </soap12:Body>
</soap12:Envelope>