microsoft.aadiam (preview:2017-04-01)

2025/10/23 • 6 new, 6 deleted methods

Operations_List (new)
Description :  Operation to return the list of available operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/microsoft.aadiam/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ClientDiscovery details. ,
Required: False ,
}
[
{
name:
{
Description: 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. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation applies to data-plane. Set the value to true for data-plane operations and false for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Object type ,
Required: False ,
}
{
publisher:
{
Description: The publisher. The localized friendly form of the resource publisher name. ,
Required: False ,
}
string ,
provider:
{
Description: 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." ,
Required: False ,
}
string ,
resource:
{
Description: 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" ,
Required: False ,
}
string ,
operation:
{
Description: 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' ,
Required: False ,
}
string ,
description:
{
Description: 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' ,
Required: False ,
}
string ,
}
,
origin:
{
Description: 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" ,
Required: False ,
}
string ,
properties:
{
Description: Properties. Reserved for future use. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_List (new)
Description :  Gets the active diagnostic settings list for AadIam.
Reference :  Link ¶

⚼ Request

GET:  /providers/microsoft.aadiam/diagnosticSettings
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The collection of diagnostic settings resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a Diagnostic Settings Resource. ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource ID of the storage account to which you would like to send Diagnostic Logs. ,
Required: False ,
}
string ,
serviceBusRuleId:
{
Description: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. ,
Required: False ,
}
string ,
workspaceId:
{
Description: 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 ,
Required: False ,
}
string ,
eventHubAuthorizationRuleId:
{
Description: The resource Id for the event hub authorization rule. ,
Required: False ,
}
string ,
eventHubName:
{
Description: The name of the event hub. If none is specified, the default event hub will be selected. ,
Required: False ,
}
string ,
logs:
{
Description: The list of logs settings. ,
Required: False ,
}
[
{
category:
{
Description: 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. ,
Enum:
{
AuditLogs: No description available. ,
SignInLogs: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: A value indicating whether this log is enabled. ,
Required: True ,
}
boolean ,
retentionPolicy:
{
Description: The retention policy for this log. ,
Required: False ,
}
{
enabled:
{
Description: A value indicating whether the retention policy is enabled. ,
Required: True ,
}
boolean ,
days:
{
Description: The number of days for the retention in days. A value of 0 will retain the events indefinitely. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
]
,
}
DiagnosticSettings_Get (new)
Description :  Gets the active diagnostic setting for AadIam.
Reference :  Link ¶

⚼ Request

GET:  /providers/microsoft.aadiam/diagnosticSettings/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
name:
{
Description: The name of the diagnostic setting. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a Diagnostic Settings Resource. ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource ID of the storage account to which you would like to send Diagnostic Logs. ,
Required: False ,
}
string ,
serviceBusRuleId:
{
Description: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. ,
Required: False ,
}
string ,
workspaceId:
{
Description: 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 ,
Required: False ,
}
string ,
eventHubAuthorizationRuleId:
{
Description: The resource Id for the event hub authorization rule. ,
Required: False ,
}
string ,
eventHubName:
{
Description: The name of the event hub. If none is specified, the default event hub will be selected. ,
Required: False ,
}
string ,
logs:
{
Description: The list of logs settings. ,
Required: False ,
}
[
{
category:
{
Description: 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. ,
Enum:
{
AuditLogs: No description available. ,
SignInLogs: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: A value indicating whether this log is enabled. ,
Required: True ,
}
boolean ,
retentionPolicy:
{
Description: The retention policy for this log. ,
Required: False ,
}
{
enabled:
{
Description: A value indicating whether the retention policy is enabled. ,
Required: True ,
}
boolean ,
days:
{
Description: The number of days for the retention in days. A value of 0 will retain the events indefinitely. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
DiagnosticSettings_CreateOrUpdate (new)
Description :  Creates or updates diagnostic settings for AadIam.
Reference :  Link ¶

⚼ Request

PUT:  /providers/microsoft.aadiam/diagnosticSettings/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of a Diagnostic Settings Resource. ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource ID of the storage account to which you would like to send Diagnostic Logs. ,
Required: False ,
}
string ,
serviceBusRuleId:
{
Description: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. ,
Required: False ,
}
string ,
workspaceId:
{
Description: 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 ,
Required: False ,
}
string ,
eventHubAuthorizationRuleId:
{
Description: The resource Id for the event hub authorization rule. ,
Required: False ,
}
string ,
eventHubName:
{
Description: The name of the event hub. If none is specified, the default event hub will be selected. ,
Required: False ,
}
string ,
logs:
{
Description: The list of logs settings. ,
Required: False ,
}
[
{
category:
{
Description: 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. ,
Enum:
{
AuditLogs: No description available. ,
SignInLogs: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: A value indicating whether this log is enabled. ,
Required: True ,
}
boolean ,
retentionPolicy:
{
Description: The retention policy for this log. ,
Required: False ,
}
{
enabled:
{
Description: A value indicating whether the retention policy is enabled. ,
Required: True ,
}
boolean ,
days:
{
Description: The number of days for the retention in days. A value of 0 will retain the events indefinitely. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the diagnostic setting. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a Diagnostic Settings Resource. ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource ID of the storage account to which you would like to send Diagnostic Logs. ,
Required: False ,
}
string ,
serviceBusRuleId:
{
Description: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. ,
Required: False ,
}
string ,
workspaceId:
{
Description: 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 ,
Required: False ,
}
string ,
eventHubAuthorizationRuleId:
{
Description: The resource Id for the event hub authorization rule. ,
Required: False ,
}
string ,
eventHubName:
{
Description: The name of the event hub. If none is specified, the default event hub will be selected. ,
Required: False ,
}
string ,
logs:
{
Description: The list of logs settings. ,
Required: False ,
}
[
{
category:
{
Description: 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. ,
Enum:
{
AuditLogs: No description available. ,
SignInLogs: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: A value indicating whether this log is enabled. ,
Required: True ,
}
boolean ,
retentionPolicy:
{
Description: The retention policy for this log. ,
Required: False ,
}
{
enabled:
{
Description: A value indicating whether the retention policy is enabled. ,
Required: True ,
}
boolean ,
days:
{
Description: The number of days for the retention in days. A value of 0 will retain the events indefinitely. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_Delete (new)
Description :  Deletes existing diagnostic setting for AadIam.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/microsoft.aadiam/diagnosticSettings/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
name:
{
Description: The name of the diagnostic setting. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
DiagnosticSettingsCategory_List (new)
Description :  Lists the diagnostic settings categories for AadIam.
Reference :  Link ¶

⚼ Request

GET:  /providers/microsoft.aadiam/diagnosticSettingsCategories
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The collection of diagnostic settings category resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a Diagnostic Settings Category. ,
Required: False ,
}
{
categoryType:
{
Description: The type of the diagnostic settings category. ,
Enum:
{
Logs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
Operations_List (removed)
Description :  Operation to return the list of available operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/microsoft.aadiam/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ClientDiscovery details. ,
Required: False ,
}
[
{
name:
{
Description: 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. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation applies to data-plane. Set the value to true for data-plane operations and false for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Object type ,
Required: False ,
}
{
publisher:
{
Description: The publisher. The localized friendly form of the resource publisher name. ,
Required: False ,
}
string ,
provider:
{
Description: 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." ,
Required: False ,
}
string ,
resource:
{
Description: 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" ,
Required: False ,
}
string ,
operation:
{
Description: 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' ,
Required: False ,
}
string ,
description:
{
Description: 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' ,
Required: False ,
}
string ,
}
,
origin:
{
Description: 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" ,
Required: False ,
}
string ,
properties:
{
Description: Properties. Reserved for future use. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_List (removed)
Description :  Gets the active diagnostic settings list for AadIam.
Reference :  Link ¶

⚼ Request

GET:  /providers/microsoft.aadiam/diagnosticSettings
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The collection of diagnostic settings resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a Diagnostic Settings Resource. ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource ID of the storage account to which you would like to send Diagnostic Logs. ,
Required: False ,
}
string ,
serviceBusRuleId:
{
Description: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. ,
Required: False ,
}
string ,
workspaceId:
{
Description: 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 ,
Required: False ,
}
string ,
eventHubAuthorizationRuleId:
{
Description: The resource Id for the event hub authorization rule. ,
Required: False ,
}
string ,
eventHubName:
{
Description: The name of the event hub. If none is specified, the default event hub will be selected. ,
Required: False ,
}
string ,
logs:
{
Description: The list of logs settings. ,
Required: False ,
}
[
{
category:
{
Description: 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. ,
Enum:
{
AuditLogs: No description available. ,
SignInLogs: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: A value indicating whether this log is enabled. ,
Required: True ,
}
boolean ,
retentionPolicy:
{
Description: The retention policy for this log. ,
Required: False ,
}
{
enabled:
{
Description: A value indicating whether the retention policy is enabled. ,
Required: True ,
}
boolean ,
days:
{
Description: The number of days for the retention in days. A value of 0 will retain the events indefinitely. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
]
,
}
DiagnosticSettings_Get (removed)
Description :  Gets the active diagnostic setting for AadIam.
Reference :  Link ¶

⚼ Request

GET:  /providers/microsoft.aadiam/diagnosticSettings/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
name:
{
Description: The name of the diagnostic setting. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a Diagnostic Settings Resource. ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource ID of the storage account to which you would like to send Diagnostic Logs. ,
Required: False ,
}
string ,
serviceBusRuleId:
{
Description: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. ,
Required: False ,
}
string ,
workspaceId:
{
Description: 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 ,
Required: False ,
}
string ,
eventHubAuthorizationRuleId:
{
Description: The resource Id for the event hub authorization rule. ,
Required: False ,
}
string ,
eventHubName:
{
Description: The name of the event hub. If none is specified, the default event hub will be selected. ,
Required: False ,
}
string ,
logs:
{
Description: The list of logs settings. ,
Required: False ,
}
[
{
category:
{
Description: 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. ,
Enum:
{
AuditLogs: No description available. ,
SignInLogs: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: A value indicating whether this log is enabled. ,
Required: True ,
}
boolean ,
retentionPolicy:
{
Description: The retention policy for this log. ,
Required: False ,
}
{
enabled:
{
Description: A value indicating whether the retention policy is enabled. ,
Required: True ,
}
boolean ,
days:
{
Description: The number of days for the retention in days. A value of 0 will retain the events indefinitely. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
DiagnosticSettings_CreateOrUpdate (removed)
Description :  Creates or updates diagnostic settings for AadIam.
Reference :  Link ¶

⚼ Request

PUT:  /providers/microsoft.aadiam/diagnosticSettings/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of a Diagnostic Settings Resource. ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource ID of the storage account to which you would like to send Diagnostic Logs. ,
Required: False ,
}
string ,
serviceBusRuleId:
{
Description: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. ,
Required: False ,
}
string ,
workspaceId:
{
Description: 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 ,
Required: False ,
}
string ,
eventHubAuthorizationRuleId:
{
Description: The resource Id for the event hub authorization rule. ,
Required: False ,
}
string ,
eventHubName:
{
Description: The name of the event hub. If none is specified, the default event hub will be selected. ,
Required: False ,
}
string ,
logs:
{
Description: The list of logs settings. ,
Required: False ,
}
[
{
category:
{
Description: 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. ,
Enum:
{
AuditLogs: No description available. ,
SignInLogs: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: A value indicating whether this log is enabled. ,
Required: True ,
}
boolean ,
retentionPolicy:
{
Description: The retention policy for this log. ,
Required: False ,
}
{
enabled:
{
Description: A value indicating whether the retention policy is enabled. ,
Required: True ,
}
boolean ,
days:
{
Description: The number of days for the retention in days. A value of 0 will retain the events indefinitely. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
name:
{
Description: The name of the diagnostic setting. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a Diagnostic Settings Resource. ,
Required: False ,
}
{
storageAccountId:
{
Description: The resource ID of the storage account to which you would like to send Diagnostic Logs. ,
Required: False ,
}
string ,
serviceBusRuleId:
{
Description: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility. ,
Required: False ,
}
string ,
workspaceId:
{
Description: 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 ,
Required: False ,
}
string ,
eventHubAuthorizationRuleId:
{
Description: The resource Id for the event hub authorization rule. ,
Required: False ,
}
string ,
eventHubName:
{
Description: The name of the event hub. If none is specified, the default event hub will be selected. ,
Required: False ,
}
string ,
logs:
{
Description: The list of logs settings. ,
Required: False ,
}
[
{
category:
{
Description: 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. ,
Enum:
{
AuditLogs: No description available. ,
SignInLogs: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: A value indicating whether this log is enabled. ,
Required: True ,
}
boolean ,
retentionPolicy:
{
Description: The retention policy for this log. ,
Required: False ,
}
{
enabled:
{
Description: A value indicating whether the retention policy is enabled. ,
Required: True ,
}
boolean ,
days:
{
Description: The number of days for the retention in days. A value of 0 will retain the events indefinitely. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
DiagnosticSettings_Delete (removed)
Description :  Deletes existing diagnostic setting for AadIam.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/microsoft.aadiam/diagnosticSettings/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
name:
{
Description: The name of the diagnostic setting. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
DiagnosticSettingsCategory_List (removed)
Description :  Lists the diagnostic settings categories for AadIam.
Reference :  Link ¶

⚼ Request

GET:  /providers/microsoft.aadiam/diagnosticSettingsCategories
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The collection of diagnostic settings category resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a Diagnostic Settings Category. ,
Required: False ,
}
{
categoryType:
{
Description: The type of the diagnostic settings category. ,
Enum:
{
Logs: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}