Sign in

Retrieves an existing worker by Id.

Retrieves an existing worker by Id.

get/routing/workers/{workerId}

Path parameters

workerIdstring required

Id of a worker.

Query parameters

api-versionstring required

The API version to use for this operation.

Response

The request has succeeded.

etagstring required

The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.

It is a string of ASCII characters placed between double quotes, like "675af34563dc-tr34".

idstring required

Id of a worker.

state'active' | 'draining' | 'inactive'

Enums for worker states.

queuesstring[]

Collection of queue(s) that this worker can receive work from.

capacityinteger

The total capacity score this worker has to manage multiple concurrent jobs.

labelsobject

A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean.

tagsobject

A set of non-identifying attributes attached to this worker. Values must be primitive values - number, string, boolean.

loadRationumber double

A value indicating the workers capacity. A value of '1' means all capacity is consumed. A value of '0' means no capacity is currently consumed.

availableForOffersboolean

A flag indicating this worker is open to receive offers or not.

maxConcurrentOffersinteger

If this is set, the worker will only receive up to this many new offers at a time.

Changes

Changed in 2 of the 5 revisions of this API.34

  • fe2019dcc5b02See the full diff
    • ○

      api operation id JobRouter_GetWorker removed and replaced with JobRouterOperations_GetWorker

      api-operation-id-removed

    • ○

      api tag Workers removed

      api-tag-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8cbeaf5a7ce332See the full diff
    • ●

      the optional response header ETag removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header Last-Modified removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header x-ms-error-code removed for the status default

      optional-response-header-removed

    • ○

      api operation id JobRouterOperations_GetWorker removed and replaced with JobRouter_GetWorker

      api-operation-id-removed

    • ○

      api tag Workers added

      api-tag-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog