Azure Active Directory Client.
Deletes existing diagnostic setting for AadIam.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the diagnostic setting. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
ErrorResponse
|
Error response. |
error
|
ErrorDefinition |
The error details. |
|||||||||||||||||||||||||||||
Properties
|
Gets the active diagnostic setting for AadIam.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the diagnostic setting. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
ErrorResponse
|
Error response. |
error
|
ErrorDefinition |
The error details. |
|||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DiagnosticSettingsResource
|
object |
The diagnostic setting resource. |
type
|
string Read-only |
Azure resource type |
||||||||||||||||||||||||||||||||||||||
name
|
string Read-only |
Azure resource name |
||||||||||||||||||||||||||||||||||||||
id
|
string Read-only |
Azure resource Id |
||||||||||||||||||||||||||||||||||||||
properties
|
DiagnosticSettings |
Properties of a Diagnostic Settings Resource. |
||||||||||||||||||||||||||||||||||||||
Properties
|
A proxy only azure resource object.
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Azure resource type |
name
|
string Read-only |
Azure resource name |
id
|
string Read-only |
Azure resource Id |
Creates or updates diagnostic settings for AadIam.
Name | Data Type | Description |
---|---|---|
name
|
string |
The name of the diagnostic setting. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
DiagnosticSettingsResource
|
object |
The diagnostic setting resource. |
type
|
string Read-only |
Azure resource type |
||||||||||||||||||||||||||||||||||||||
name
|
string Read-only |
Azure resource name |
||||||||||||||||||||||||||||||||||||||
id
|
string Read-only |
Azure resource Id |
||||||||||||||||||||||||||||||||||||||
properties
|
DiagnosticSettings |
Properties of a Diagnostic Settings Resource. |
||||||||||||||||||||||||||||||||||||||
Properties
|
A proxy only azure resource object.
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Azure resource type |
name
|
string Read-only |
Azure resource name |
id
|
string Read-only |
Azure resource Id |
Name | Data Type | Description |
---|---|---|
ErrorResponse
|
Error response. |
error
|
ErrorDefinition |
The error details. |
|||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DiagnosticSettingsResource
|
object |
The diagnostic setting resource. |
type
|
string Read-only |
Azure resource type |
||||||||||||||||||||||||||||||||||||||
name
|
string Read-only |
Azure resource name |
||||||||||||||||||||||||||||||||||||||
id
|
string Read-only |
Azure resource Id |
||||||||||||||||||||||||||||||||||||||
properties
|
DiagnosticSettings |
Properties of a Diagnostic Settings Resource. |
||||||||||||||||||||||||||||||||||||||
Properties
|
A proxy only azure resource object.
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Azure resource type |
name
|
string Read-only |
Azure resource name |
id
|
string Read-only |
Azure resource Id |
Gets the active diagnostic settings list for AadIam.
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
ErrorResponse
|
Error response. |
error
|
ErrorDefinition |
The error details. |
|||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DiagnosticSettingsResourceCollection
|
Represents a collection of alert rule resources. |
value
|
array [DiagnosticSettingsResource] |
The collection of diagnostic settings resources. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
ProxyOnlyResource
A proxy only azure resource object. Properties
|
Lists the diagnostic settings categories for AadIam.
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
ErrorResponse
|
Error response. |
error
|
ErrorDefinition |
The error details. |
|||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DiagnosticSettingsCategoryResourceCollection
|
Represents a collection of diagnostic setting category resources. |
value
|
array [DiagnosticSettingsCategoryResource] |
The collection of diagnostic settings category resources. |
||||||||||||||||||||||||||||||||||||||
Properties
Extends
ProxyOnlyResource
A proxy only azure resource object. Properties
|
Operation to return the list of available operations.
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Client Api Version. |
Name | Data Type | Description |
---|---|---|
ErrorResponse
|
Error response. |
error
|
ErrorDefinition |
The error details. |
|||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
OperationsDiscoveryCollection
|
object |
Collection of ClientDiscovery details. |
value
|
array [OperationsDiscovery] |
The ClientDiscovery details. |
|||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The diagnostic settings.
Name | Data Type | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
workspaceId
|
string |
The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 |
||||||||||||||||||||||||||
storageAccountId
|
string |
The resource ID of the storage account to which you would like to send Diagnostic Logs. |
||||||||||||||||||||||||||
serviceBusRuleId
|
string |
The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. |
||||||||||||||||||||||||||
logs
|
array [LogSettings] |
The list of logs settings. |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
eventHubName
|
string |
The name of the event hub. If none is specified, the default event hub will be selected. |
||||||||||||||||||||||||||
eventHubAuthorizationRuleId
|
string |
The resource Id for the event hub authorization rule. |
The diagnostic settings Category.
Name | Data Type | Description |
---|---|---|
categoryType
|
string Allowed values: - Logs |
The type of the diagnostic settings category. |
The diagnostic settings category resource.
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
type
|
string Read-only |
Azure resource type |
|||||||
name
|
string Read-only |
Azure resource name |
|||||||
id
|
string Read-only |
Azure resource Id |
|||||||
properties
|
DiagnosticSettingsCategory |
The properties of a Diagnostic Settings Category. |
|||||||
Properties
|
A proxy only azure resource object.
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Azure resource type |
name
|
string Read-only |
Azure resource name |
id
|
string Read-only |
Azure resource Id |
Represents a collection of diagnostic setting category resources.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [DiagnosticSettingsCategoryResource] |
The collection of diagnostic settings category resources. |
||||||||||||||||||||||||||||||||||||||
Properties
Extends
ProxyOnlyResource
A proxy only azure resource object. Properties
|
The diagnostic setting resource.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
string Read-only |
Azure resource type |
|||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string Read-only |
Azure resource name |
|||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string Read-only |
Azure resource Id |
|||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
DiagnosticSettings |
Properties of a Diagnostic Settings Resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
A proxy only azure resource object.
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Azure resource type |
name
|
string Read-only |
Azure resource name |
id
|
string Read-only |
Azure resource Id |
Represents a collection of alert rule resources.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [DiagnosticSettingsResource] |
The collection of diagnostic settings resources. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
ProxyOnlyResource
A proxy only azure resource object. Properties
|
Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.
Name | Data Type | Description |
---|---|---|
resource
|
string |
The resource. The localized friendly form of the resource related to this action/operation – it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should not reuse their parent’s display.resource field). e.g. "Virtual Machines" or "Scheduler Job Collections", or "Virtual Machine VM Sizes" or "Scheduler Jobs" |
publisher
|
string |
The publisher. The localized friendly form of the resource publisher name. |
provider
|
string |
The provider. The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with "Microsoft" for 1st party services. e.g. "Microsoft Monitoring Insights" or "Microsoft Compute." |
operation
|
string |
The operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName' |
description
|
string |
The description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views. Prescriptive guidance for namespaces: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespaces: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources' |
Error definition.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
message
|
string Read-only |
Description of the error. |
|||||||||||||||||||||||||||||||||||||||||||||
details
|
array [ErrorDefinition] |
Internal error details. |
|||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||
code
|
string Read-only |
Service specific error code which serves as the substatus for the HTTP error code. |
Error response.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
|
ErrorDefinition |
The error details. |
|||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
retentionPolicy
|
RetentionPolicy |
The retention policy for this log. |
||||||||||
Properties
|
||||||||||||
enabled
|
boolean |
A value indicating whether this log is enabled. |
||||||||||
category
|
string Allowed values: - AuditLogs - SignInLogs |
Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. |
Operations discovery class.
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
properties
|
OperationsDiscoveryProperties |
Properties. Reserved for future use. |
|||||||||||||||||||
|
|||||||||||||||||||||
origin
|
string |
Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is "user,system" |
|||||||||||||||||||
name
|
string |
Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: Microsoft.Compute/virtualMachine/capture/action Microsoft.Compute/virtualMachine/restart/action Microsoft.Compute/virtualMachine/write Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. |
|||||||||||||||||||
display
|
Display |
Object type |
|||||||||||||||||||
Properties
|
Collection of ClientDiscovery details.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [OperationsDiscovery] |
The ClientDiscovery details. |
|||||||||||||||||||||||||||||||||||||||||||||
Properties
|
ClientDiscovery properties.
Name | Data Type | Description |
---|---|---|
OperationsDiscoveryProperties
|
object |
ClientDiscovery properties. |
A proxy only azure resource object.
Name | Data Type | Description |
---|---|---|
type
|
string Read-only |
Azure resource type |
name
|
string Read-only |
Azure resource name |
id
|
string Read-only |
Azure resource Id |
Specifies the retention policy for the log.
Name | Data Type | Description |
---|---|---|
enabled
|
boolean |
A value indicating whether the retention policy is enabled. |
days
|
integer Minimum: 0 |
The number of days for the retention in days. A value of 0 will retain the events indefinitely. |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Azure Active Directory OAuth2 Flow
Flow:implicit
https://login.microsoftonline.com/common/oauth2/authorize
user_impersonation
: impersonate your user accountMs-code-generation-settings |
|
Origin - Format | swagger |
Origin - Url | https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/stable/2017-04-01/azureactivedirectory.json |
Origin - Version | 2.0 |
Provider Name | azure.com |
Service Name | azureactivedirectory |
API Version | 2017-04-01 |