dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2689 from shubham1172/shubham1172/add-cli-publish-metadata-docs 

Update dapr CLI publish documentation
This commit is contained in:
greenie-msft 2022-08-02 15:57:35 -07:00 committed by GitHub
parent 79c6d42ac0 fd43135f16
commit 5f8169d394
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
daprdocs/content/en/reference/cli/dapr-publish.md
View File

@ -21,19 +21,27 @@ dapr publish [flags]
### Flags
| Name | Environment Variable | Default | Description |
| ------------------------ | -------------------- | ------------------------------------------------------------ | ----------------------------------------------------- |
| `--publish-app-id`, `-i` | | The ID that represents the app from which you are publishing |
| `--pubsub`, `-p` | | The name of the pub/sub component |
| `--topic`, `-t` | | | The topic to be published to |
| `--data`, `-d` | | | The JSON serialized string (optional) |
| `--data-file`, `-f` | | | A file containing the JSON serialized data (optional) |
| `--help`, `-h` | | | Print this help message |
| Name | Environment Variable | Default | Description |
| ---------------------------- | -------------------- | ------------------------------------------------------------ | ----------------------------------------------------- |
| `--publish-app-id`, `-i` | | The ID that represents the app from which you are publishing |
| `--pubsub`, `-p` | | The name of the pub/sub component |
| `--topic`, `-t` | | | The topic to be published to |
| `--data`, `-d` | | | The JSON serialized string (optional) |
| `--data-file`, `-f` | | | A file containing the JSON serialized data (optional) |
| `--help`, `-h` | | | Print this help message |
| `--metadata`, `-m` | | | A JSON serialized publish metadata (optional) |
| `--unix-domain-socket`, `-u` | | | The path to the unix domain socket (optional) |
### Examples
```bash
# Publish to sample topic in target pubsub
# Publish to sample topic in target pubsub via a publishing app
dapr publish --publish-app-id appId --topic sample --pubsub target --data '{"key":"value"}'
# Publish to sample topic in target pubsub via a publishing app using Unix domain socket
dapr publish --enable-domain-socket --publish-app-id myapp --pubsub target --topic sample --data '{"key":"value"}'
# Publish to sample topic in target pubsub via a publishing app without cloud event
dapr publish --publish-app-id myapp --pubsub target --topic sample --data '{"key":"value"}' --metadata '{"rawPayload":"true"}'
```