Streams - Update Status
Update existing Audit Stream status
PUT https://auditservice.dev.azure.com/{organization}/_apis/audit/streams/{streamId}?status={status}&api-version=7.0-preview.1
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
stream
|
path | True |
integer int32 |
Id of stream entry to be updated |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.0-preview.1' to use this version of the api. |
status
|
query | True |
Status of the stream |
Responses
Name | Type | Description |
---|---|---|
200 OK |
successful operation |
Security
accessToken
Personal access token. Use any value for the user name and the token as the password.
Type:
basic
Examples
Update a stream status
Sample Request
PUT https://auditservice.dev.azure.com/{organization}/_apis/audit/streams/{streamId}?api-version=7.0-preview.1
Sample Response
{
"id": 1,
"consumerType": "Splunk",
"displayName": "https://input-prd-p-instance.cloud.splunk.com:8088",
"consumerInputs": {
"SplunkUrl": "https://input-prd-p-instance.cloud.splunk.com:8088",
"SplunkEventCollectorToken": "************************"
},
"status": 2,
"statusReason": null,
"updatedTime": "/Date(1565715592526)/"
}
Definitions
Name | Description |
---|---|
Audit |
This class represents an audit stream |
Audit |
Status of the stream, Enabled, Disabled |
AuditStream
This class represents an audit stream
Name | Type | Description |
---|---|---|
consumerInputs |
object |
Inputs used to communicate with external service. Inputs could be url, a connection string, a token, etc. |
consumerType |
string |
Type of the consumer, i.e. splunk, azureEventHub, etc. |
createdTime |
string |
The time when the stream was created |
displayName |
string |
Used to identify individual streams |
id |
integer |
Unique stream identifier |
status |
Status of the stream, Enabled, Disabled |
|
statusReason |
string |
Reason for the current stream status, i.e. Disabled by the system, Invalid credentials, etc. |
updatedTime |
string |
The time when the stream was last updated |
AuditStreamStatus
Status of the stream, Enabled, Disabled
Name | Type | Description |
---|---|---|
backfilling |
string |
The stream is delivering old events |
deleted |
string |
The stream has been marked for deletion |
disabledBySystem |
string |
The stream has been disabled by the system |
disabledByUser |
string |
The stream has been disabled by a user |
enabled |
string |
The stream is enabled and can deliver events |
unknown |
string |
The state has not been set, The stream is new |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for