package AzureFunctionsRpcMessages

Get desktop application:
View/edit binary Protocol Buffers messages

Interface exported by the server.

• rpc EventStream (stream StreamingMessage, stream StreamingMessage)

  FunctionRpc.proto:18

  message StreamingMessage

  FunctionRpc.proto:21

  • string request_id = 1

    Used to identify message between host and worker

  • oneof content

    Payload of the message

    • StartStream start_stream = 20

      Worker initiates stream

    • WorkerInitRequest worker_init_request = 17

      Host sends capabilities/init data to worker

    • WorkerInitResponse worker_init_response = 16

      Worker responds after initializing with its capabilities & status

    • WorkerHeartbeat worker_heartbeat = 15

      MESSAGE NOT USED Worker periodically sends empty heartbeat message to host

    • WorkerTerminate worker_terminate = 14

      Host sends terminate message to worker. Worker terminates if it can, otherwise host terminates after a grace period

    • WorkerStatusRequest worker_status_request = 12

      Host periodically sends status request to the worker

    • WorkerStatusResponse worker_status_response = 13

    • FileChangeEventRequest file_change_event_request = 6

      On file change event, host sends notification to worker

    • WorkerActionResponse worker_action_response = 7

      Worker requests a desired action (restart worker, reload function)

    • FunctionLoadRequest function_load_request = 8

      Host sends required metadata to worker to load function

    • FunctionLoadResponse function_load_response = 9

      Worker responds after loading with the load result

    • InvocationRequest invocation_request = 4

      Host requests a given invocation

    • InvocationResponse invocation_response = 5

      Worker responds to a given invocation

    • InvocationCancel invocation_cancel = 21

      Host sends cancel message to attempt to cancel an invocation. If an invocation is cancelled, host will receive an invocation response with status cancelled.

    • RpcLog rpc_log = 2

      Worker logs a message back to the host

    • FunctionEnvironmentReloadRequest function_environment_reload_request = 25

    • FunctionEnvironmentReloadResponse function_environment_reload_response = 26

    • CloseSharedMemoryResourcesRequest close_shared_memory_resources_request = 27

      Ask the worker to close any open shared memory resources for a given invocation

    • CloseSharedMemoryResourcesResponse close_shared_memory_resources_response = 28

    • FunctionsMetadataRequest functions_metadata_request = 29

      Worker indexing message types

    • FunctionMetadataResponse function_metadata_response = 30

    • FunctionLoadRequestCollection function_load_request_collection = 31

      Host sends required metadata to worker to load functions

    • FunctionLoadResponseCollection function_load_response_collection = 32

      Host gets the list of function load responses

    • WorkerWarmupRequest worker_warmup_request = 33

      Host sends required metadata to worker to warmup the worker

    • WorkerWarmupResponse worker_warmup_response = 34

      Worker responds after warming up with the warmup result

Used to describe a given binding on load

Used in: RpcFunctionMetadata

• string type = 2

  Type of binding (e.g. HttpTrigger)

• BindingInfo.Direction direction = 3

  Direction of the given binding

• BindingInfo.DataType data_type = 4

• map<string, string> properties = 5

  Properties for binding metadata

Indicates the type of the data for the binding

Used in: BindingInfo

• undefined = 0

• string = 1

• binary = 2

• stream = 3

Indicates whether it is an input or output binding (or a fancy inout binding)

Used in: BindingInfo

• in = 0

• out = 1

• inout = 2

Tell the out-of-proc worker to close any shared memory maps it allocated for given invocation

Used in: StreamingMessage

• repeated string map_names = 1

Response from the worker indicating which of the shared memory maps have been successfully closed and which have not been closed The key (string) is the map name and the value (bool) is true if it was closed, false if not

Used in: StreamingMessage

• map<string, bool> close_map_results = 1

Used to encapsulate collection bytes

Used in: TypedData

• repeated bytes bytes = 1

Used to encapsulate collection double

Used in: TypedData

• repeated double double = 1

Used to encapsulate collection model_binding_data

Used in: TypedData

• repeated ModelBindingData model_binding_data = 1

Used to encapsulate collection sint64

Used in: TypedData

• repeated sint64 sint64 = 1

Used to encapsulate collection string

Used in: TypedData

• repeated string string = 1

Host notifies worker of file content change

Used in: StreamingMessage

• FileChangeEventRequest.Type type = 1

  type for this event

• string full_path = 2

  full file path for the file change notification

• string name = 3

  Name of the function affected

Types of File change operations (See link for more info: https://msdn.microsoft.com/en-us/library/t6xf43e0(v=vs.110).aspx)

Used in: FileChangeEventRequest

• Unknown = 0

• Created = 1

• Deleted = 2

• Changed = 4

• Renamed = 8

• All = 15

Used in: StreamingMessage

• map<string, string> environment_variables = 1

  Environment variables from the current process

• string function_app_directory = 2

  Current directory of function app

Used in: StreamingMessage

• optional WorkerMetadata worker_metadata = 1

  After specialization, worker sends capabilities & metadata. Worker metadata captured for telemetry purposes

• map<string, string> capabilities = 2

  A map of worker supported features/capabilities

• optional StatusResult result = 3

  Status of the response

• FunctionEnvironmentReloadResponse.CapabilitiesUpdateStrategy capabilities_update_strategy = 4

  If no strategy is defined, the host will default to merge

Used in: FunctionEnvironmentReloadResponse

• merge = 0

  overwrites existing values and appends new ones ex. worker init: {A: foo, B: bar} + env reload: {A:foo, B: foo, C: foo} -> {A: foo, B: foo, C: foo}

• replace = 1

  existing capabilities are cleared and new capabilities are applied ex. worker init: {A: foo, B: bar} + env reload: {A:foo, C: foo} -> {A: foo, C: foo}

Load request of a single Function

Used in: FunctionLoadRequestCollection, StreamingMessage

• string function_id = 1

  unique function identifier (avoid name collisions, facilitate reload case)

• optional RpcFunctionMetadata metadata = 2

  Metadata for the request

• bool managed_dependency_enabled = 3

  A flag indicating if managed dependency is enabled or not

Host tells the worker to load a list of Functions

Used in: StreamingMessage

• repeated FunctionLoadRequest function_load_requests = 1

Worker tells host result of reload

Used in: FunctionLoadResponseCollection, StreamingMessage

• string function_id = 1

  unique function identifier

• optional StatusResult result = 2

  Result of load operation

  TODO: return type expected?

• bool is_dependency_downloaded = 3

  Result of load operation

Host gets the list of function load responses

Used in: StreamingMessage

• repeated FunctionLoadResponse function_load_responses = 1

Worker sends function metadata back to host

Used in: StreamingMessage

• repeated RpcFunctionMetadata function_metadata_results = 1

  list of function indexing responses

• optional StatusResult result = 2

  status of overall metadata request

• bool use_default_metadata_indexing = 3

  if set to true then host will perform indexing

Host tells worker it is ready to receive metadata

Used in: StreamingMessage

• string function_app_directory = 1

  base directory for function app

Host requests worker to cancel invocation

Used in: StreamingMessage

• string invocation_id = 2

  Unique id for invocation

• optional google.protobuf.Duration grace_period = 1

  PROPERTY NOT USED

Host requests worker to invoke a Function

Used in: StreamingMessage

• string invocation_id = 1

  Unique id for each invocation

• string function_id = 2

  Unique id for each Function

• repeated ParameterBinding input_data = 3

  Input bindings (include trigger)

• map<string, TypedData> trigger_metadata = 4

  binding metadata from trigger

• optional RpcTraceContext trace_context = 5

  Populates activityId, tracestate and tags from host

• optional RetryContext retry_context = 6

  Current retry context

Worker responds with status of Invocation

Used in: StreamingMessage

• string invocation_id = 1

  Unique id for invocation

• repeated ParameterBinding output_data = 2

  Output binding data

• optional StatusResult result = 3

  Status of the invocation (success/failure/canceled)

• optional TypedData return_value = 4

  data returned from Function (for $return and triggers with return support)

• map<string, string> trace_context_attributes = 5

  Enables propagation of tags from worker -> host.

Message representing Microsoft.Azure.WebJobs.ParameterBindingData Used for hydrating SDK-type bindings in out-of-proc workers

Used in: CollectionModelBindingData, TypedData

• string version = 1

  The version of the binding data content

• string source = 2

  The extension source of the binding data

• string content_type = 3

  The content type of the binding data content

• bytes content = 4

  The binding data content

Used to describe a given binding on invocation

Used in: InvocationRequest, InvocationResponse

• string name = 1

  Name for the binding

• oneof rpc_data

  • TypedData data = 2

    Data for the binding

  • RpcSharedMemory rpc_shared_memory = 3

    Metadata about the shared memory region to read data from

Host sends retry context for a function invocation

Used in: InvocationRequest

• int32 retry_count = 1

  Current retry count

• int32 max_retry_count = 2

  Max retry count

• optional RpcException exception = 3

  Exception that caused the retry

Specify which type of data is contained in the shared memory region being read

Used in: RpcSharedMemory

• unknown = 0

• string = 1

• json = 2

• bytes = 3

• stream = 4

• http = 5

• int = 6

• double = 7

• collection_bytes = 8

• collection_string = 9

• collection_double = 10

• collection_sint64 = 11

Encapsulates an Exception

Used in: RetryContext, RpcLog, StatusResult

• string source = 3

  Source of the exception

• string stack_trace = 1

  Stack trace for the exception

• string message = 2

  Textual message describing the exception

• bool is_user_exception = 4

  Worker specifies whether exception is a user exception, for purpose of application insights logging. Defaults to false.

• string type = 5

  Type of exception. If it's a user exception, the type is passed along to app insights. Otherwise, it's ignored for now.

Information on how a Function should be loaded and its bindings

Used in: FunctionLoadRequest, FunctionMetadataResponse

• string name = 4

  TODO: do we want the host's name - the language worker might do a better job of assignment than the host

• string directory = 1

  base directory for the Function

• string script_file = 2

  Script file specified

• string entry_point = 3

  Entry point specified

• map<string, BindingInfo> bindings = 6

  Bindings info

• bool is_proxy = 7

  Is set to true for proxy

• optional StatusResult status = 8

  Function indexing status

• string language = 9

  Function language

• repeated string raw_bindings = 10

  Raw binding info

• string function_id = 13

  unique function identifier (avoid name collisions, facilitate reload case)

• bool managed_dependency_enabled = 14

  A flag indicating if managed dependency is enabled or not

• optional RpcRetryOptions retry_options = 15

  The optional function execution retry strategy to use on invocation failures.

• map<string, string> properties = 16

  Properties for function metadata They're usually specific to a worker and largely passed along to the controller API for use outside the host

TODO - solidify this or remove it

Used in: TypedData

• string method = 1

• string url = 2

• map<string, string> headers = 3

• optional TypedData body = 4

• map<string, string> params = 10

• string status_code = 12

• map<string, string> query = 15

• bool enable_content_negotiation = 16

• optional TypedData rawBody = 17

• repeated RpcClaimsIdentity identities = 18

• repeated RpcHttpCookie cookies = 19

• map<string, NullableString> nullable_headers = 20

• map<string, NullableString> nullable_params = 21

• map<string, NullableString> nullable_query = 22

Http cookie type. Note that only name and value are used for Http requests

Used in: RpcHttp

• string name = 1

  Cookie name

• string value = 2

  Cookie value

• optional NullableString domain = 3

  Specifies allowed hosts to receive the cookie

• optional NullableString path = 4

  Specifies URL path that must exist in the requested URL

• optional NullableTimestamp expires = 5

  Sets the cookie to expire at a specific date instead of when the client closes. It is generally recommended that you use "Max-Age" over "Expires".

• optional NullableBool secure = 6

  Sets the cookie to only be sent with an encrypted request

• optional NullableBool http_only = 7

  Sets the cookie to be inaccessible to JavaScript's Document.cookie API

• RpcHttpCookie.SameSite same_site = 8

  Allows servers to assert that a cookie ought not to be sent along with cross-site requests

• optional NullableDouble max_age = 9

  Number of seconds until the cookie expires. A zero or negative number will expire the cookie immediately.

Enum that lets servers require that a cookie shouldn't be sent with cross-site requests

Used in: RpcHttpCookie

• None = 0

• Lax = 1

• Strict = 2

• ExplicitNone = 3

Used to send logs back to the Host

Used in: StatusResult, StreamingMessage

• string invocation_id = 1

  Unique id for invocation (if exists)

• string category = 2

  TOD: This should be an enum Category for the log (startup, load, invocation, etc.)

• RpcLog.Level level = 3

  Level for the given log message

• string message = 4

  Message for the given log

• string event_id = 5

  Id for the even associated with this log (if exists)

• optional RpcException exception = 6

  Exception (if exists)

• string properties = 7

  json serialized property bag

• RpcLog.RpcLogCategory log_category = 8

  Category of the log. Either user(default), system, or custom metric.

• map<string, TypedData> propertiesMap = 9

  strongly-typed (ish) property bag

Matching ILogger semantics https://github.com/aspnet/Logging/blob/9506ccc3f3491488fe88010ef8b9eb64594abf95/src/Microsoft.Extensions.Logging/Logger.cs Level for the Log

Used in: RpcLog, WorkerInitRequest

• Trace = 0

• Debug = 1

• Information = 2

• Warning = 3

• Error = 4

• Critical = 5

• None = 6

Category of the log. Defaults to User if not specified.

Used in: RpcLog

• User = 0

• System = 1

• CustomMetric = 2

Retry policy which the worker sends the host when the worker indexes a function.

Used in: RpcFunctionMetadata

• int32 max_retry_count = 2

  The maximum number of retries allowed per function execution. -1 means to retry indefinitely.

• optional google.protobuf.Duration delay_interval = 3

  The delay that's used between retries when you're using a fixed delay strategy.

• optional google.protobuf.Duration minimum_interval = 4

  The minimum retry delay when you're using an exponential backoff strategy

• optional google.protobuf.Duration maximum_interval = 5

  The maximum retry delay when you're using an exponential backoff strategy

• RpcRetryOptions.RetryStrategy retry_strategy = 6

The retry strategy to use. Valid values are fixed delay or exponential backoff.

Used in: RpcRetryOptions

• exponential_backoff = 0

• fixed_delay = 1

Used to provide metadata about shared memory region to read data from

Used in: ParameterBinding

• string name = 1

  Name of the shared memory map containing data

• int64 offset = 2

  Offset in the shared memory map to start reading data from

• int64 count = 3

  Number of bytes to read (starting from the offset)

• RpcDataType type = 4

  Final type to which the read data (in bytes) is to be interpreted as

Host sends ActivityId, traceStateString and Tags from host

Used in: InvocationRequest

• string trace_parent = 1

  This corresponds to Activity.Current?.Id

• string trace_state = 2

  This corresponds to Activity.Current?.TraceStateString

• map<string, string> attributes = 3

  This corresponds to Activity.Current?.Tags

• map<string, string> baggage = 4

  This is populated from OpenTelemetry.Baggage.Current

Worker sends the host information identifying itself

Used in: StreamingMessage

• string worker_id = 2

  id of the worker

Used by the host to determine success/failure/cancellation

Used in: FunctionEnvironmentReloadResponse, FunctionLoadResponse, FunctionMetadataResponse, InvocationResponse, RpcFunctionMetadata, WorkerInitResponse, WorkerWarmupResponse

• StatusResult.Status status = 4

  Status for the given result

• string result = 1

  Specific message about the result

• optional RpcException exception = 2

  Exception message (if exists) for the status

• repeated RpcLog logs = 3

  Captured logs or relevant details can use the logs property

Indicates Failure/Success/Cancelled

Used in: StatusResult

• Failure = 0

• Success = 1

• Cancelled = 2

Used to encapsulate data which could be a variety of types

Used in: InvocationRequest, InvocationResponse, ParameterBinding, RpcHttp, RpcLog

• oneof data

  • string string = 1

  • string json = 2

  • bytes bytes = 3

  • bytes stream = 4

  • RpcHttp http = 5

  • sint64 int = 6

  • double double = 7

  • CollectionBytes collection_bytes = 8

  • CollectionString collection_string = 9

  • CollectionDouble collection_double = 10

  • CollectionSInt64 collection_sint64 = 11

  • ModelBindingData model_binding_data = 12

  • CollectionModelBindingData collection_model_binding_data = 13

Indicates whether worker reloaded successfully or needs a restart

Used in: StreamingMessage

• WorkerActionResponse.Action action = 1

  action for this response

• string reason = 2

  text reason for the response

indicates whether a restart is needed, or reload successfully

Used in: WorkerActionResponse

• Restart = 0

• Reload = 1

MESSAGE NOT USED TODO: Remove from protobuf during next breaking change release

Used in: StreamingMessage

(message has no fields)

Host requests the worker to initialize itself

Used in: StreamingMessage

• string host_version = 1

  version of the host sending init request

• map<string, string> capabilities = 2

  A map of host supported features/capabilities

• map<string, RpcLog.Level> log_categories = 3

  inform worker of supported categories and their levels i.e. Worker = Verbose, Function.MyFunc = None

• string worker_directory = 4

  Full path of worker.config.json location

• string function_app_directory = 5

  base directory for function app

Worker responds with the result of initializing itself

Used in: StreamingMessage

• string worker_version = 1

  PROPERTY NOT USED TODO: Remove from protobuf during next breaking change release

• map<string, string> capabilities = 2

  A map of worker supported features/capabilities These values are used internally for host-worker interactions

• optional StatusResult result = 3

  Status of the response

• optional WorkerMetadata worker_metadata = 4

  Worker metadata captured for telemetry purposes

• map<string, string> app_capabilities = 5

  A map of application-level capabilities These features/capabilities are queried from admin endpoints in the host by third parties

Used in: FunctionEnvironmentReloadResponse, WorkerInitResponse

• string runtime_name = 1

  The runtime/stack name

• string runtime_version = 2

  The version of the runtime/stack

• string worker_version = 3

  The version of the worker

• string worker_bitness = 4

  The worker bitness/architecture

• map<string, string> custom_properties = 5

  Optional additional custom properties

Used by the host to determine worker health

Used in: StreamingMessage

(message has no fields)

Worker responds with status message TODO: Add any worker relevant status to response

Used in: StreamingMessage

(message has no fields)

Warning before killing the process after grace_period Worker self terminates ..no response on this

Used in: StreamingMessage

• optional google.protobuf.Duration grace_period = 1

Used in: StreamingMessage

• string worker_directory = 1

  Full path of worker.config.json location

Used in: StreamingMessage

• optional StatusResult result = 1