azure.mgmt.security.operations module¶
-
class
azure.mgmt.security.operations.
AdaptiveApplicationControlsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AdaptiveApplicationControlsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01”.
-
delete
(group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete an application control VM/server group.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets an application control VM/server group.
- Parameters
- Returns
AppWhitelistingGroup or ClientRawResponse if raw=true
- Return type
AppWhitelistingGroup or ClientRawResponse
- Raises
CloudError
-
list
(include_path_recommendations=None, summary=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of application control VM/server groups for the subscription.
- Parameters
include_path_recommendations (bool) – Include the policy rules
summary (bool) – Return output in a summarized form
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AppWhitelistingGroups or ClientRawResponse if raw=true
- Return type
AppWhitelistingGroups or ClientRawResponse
- Raises
CloudError
-
put
(group_name, body, custom_headers=None, raw=False, **operation_config)[source]¶ Update an application control VM/server group.
- Parameters
group_name (str) – Name of an application control VM/server group
body (AppWhitelistingGroup) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AppWhitelistingGroup or ClientRawResponse if raw=true
- Return type
AppWhitelistingGroup or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
AdaptiveNetworkHardeningsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AdaptiveNetworkHardeningsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01”.
adaptive_network_hardening_enforce_action – Enforces the given rules on the NSG(s) listed in the request. Constant value: “enforce”.
-
enforce
(resource_group_name, resource_namespace, resource_type, resource_name, adaptive_network_hardening_resource_name, rules, network_security_groups, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Enforces the given rules on the NSG(s) listed in the request.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
resource_namespace (str) – The Namespace of the resource.
resource_type (str) – The type of the resource.
resource_name (str) – Name of the resource.
adaptive_network_hardening_resource_name (str) – The name of the Adaptive Network Hardening resource.
network_security_groups (list[str]) – The Azure resource IDs of the effective network security groups that will be updated with the created security rules from the Adaptive Network Hardening rules
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, resource_namespace, resource_type, resource_name, adaptive_network_hardening_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a single Adaptive Network Hardening resource.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
resource_namespace (str) – The Namespace of the resource.
resource_type (str) – The type of the resource.
resource_name (str) – Name of the resource.
adaptive_network_hardening_resource_name (str) – The name of the Adaptive Network Hardening resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AdaptiveNetworkHardening or ClientRawResponse if raw=true
- Return type
AdaptiveNetworkHardening or ClientRawResponse
- Raises
CloudError
-
list_by_extended_resource
(resource_group_name, resource_namespace, resource_type, resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of Adaptive Network Hardenings resources in scope of an extended resource.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
resource_namespace (str) – The Namespace of the resource.
resource_type (str) – The type of the resource.
resource_name (str) – Name of the resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of AdaptiveNetworkHardening
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
AdvancedThreatProtectionOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AdvancedThreatProtectionOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-01-01”.
setting_name – Advanced Threat Protection setting name. Constant value: “current”.
-
create
(resource_id, is_enabled=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates the Advanced Threat Protection settings on a specified resource.
- Parameters
resource_id (str) – The identifier of the resource.
is_enabled (bool) – Indicates whether Advanced Threat Protection is enabled.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AdvancedThreatProtectionSetting or ClientRawResponse if raw=true
- Return type
AdvancedThreatProtectionSetting or ClientRawResponse
- Raises
CloudError
-
get
(resource_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the Advanced Threat Protection settings for the specified resource.
- Parameters
- Returns
AdvancedThreatProtectionSetting or ClientRawResponse if raw=true
- Return type
AdvancedThreatProtectionSetting or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
AlertsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AlertsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-01-01”.
-
get_resource_group_level_alerts
(alert_name, resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get an alert that is associated a resource group or a resource in a resource group.
- Parameters
alert_name (str) – Name of the alert object
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Alert or ClientRawResponse if raw=true
- Return type
Alert or ClientRawResponse
- Raises
CloudError
-
get_subscription_level_alert
(alert_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get an alert that is associated with a subscription.
- Parameters
- Returns
Alert or ClientRawResponse if raw=true
- Return type
Alert or ClientRawResponse
- Raises
CloudError
-
list
(filter=None, select=None, expand=None, auto_dismiss_rule_name=None, custom_headers=None, raw=False, **operation_config)[source]¶ List all the alerts that are associated with the subscription.
- Parameters
filter (str) – OData filter. Optional.
select (str) – OData select. Optional.
expand (str) – OData expand. Optional.
auto_dismiss_rule_name (str) – The name of an existing auto dismiss rule. Use it to simulate the rule on existing alerts and get the alerts that would have been dismissed if the rule was enabled when the alert was created
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Alert
- Return type
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, filter=None, select=None, expand=None, auto_dismiss_rule_name=None, custom_headers=None, raw=False, **operation_config)[source]¶ List all the alerts that are associated with the resource group.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
filter (str) – OData filter. Optional.
select (str) – OData select. Optional.
expand (str) – OData expand. Optional.
auto_dismiss_rule_name (str) – The name of an existing auto dismiss rule. Use it to simulate the rule on existing alerts and get the alerts that would have been dismissed if the rule was enabled when the alert was created
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Alert
- Return type
- Raises
CloudError
-
list_resource_group_level_alerts_by_region
(resource_group_name, filter=None, select=None, expand=None, auto_dismiss_rule_name=None, custom_headers=None, raw=False, **operation_config)[source]¶ List all the alerts that are associated with the resource group that are stored in a specific location.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
filter (str) – OData filter. Optional.
select (str) – OData select. Optional.
expand (str) – OData expand. Optional.
auto_dismiss_rule_name (str) – The name of an existing auto dismiss rule. Use it to simulate the rule on existing alerts and get the alerts that would have been dismissed if the rule was enabled when the alert was created
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Alert
- Return type
- Raises
CloudError
-
list_subscription_level_alerts_by_region
(filter=None, select=None, expand=None, auto_dismiss_rule_name=None, custom_headers=None, raw=False, **operation_config)[source]¶ List all the alerts that are associated with the subscription that are stored in a specific location.
- Parameters
filter (str) – OData filter. Optional.
select (str) – OData select. Optional.
expand (str) – OData expand. Optional.
auto_dismiss_rule_name (str) – The name of an existing auto dismiss rule. Use it to simulate the rule on existing alerts and get the alerts that would have been dismissed if the rule was enabled when the alert was created
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Alert
- Return type
- Raises
CloudError
-
update_resource_group_level_alert_state_to_dismiss
(alert_name, resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Update the alert’s state.
- Parameters
alert_name (str) – Name of the alert object
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
update_resource_group_level_alert_state_to_reactivate
(alert_name, resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Update the alert’s state.
- Parameters
alert_name (str) – Name of the alert object
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
update_subscription_level_alert_state_to_dismiss
(alert_name, custom_headers=None, raw=False, **operation_config)[source]¶ Update the alert’s state.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
update_subscription_level_alert_state_to_reactivate
(alert_name, custom_headers=None, raw=False, **operation_config)[source]¶ Update the alert’s state.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
AlertsSuppressionRulesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AlertsSuppressionRulesOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-01-01-preview”.
-
delete
(alerts_suppression_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete dismiss alert rule for this subscription.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(alerts_suppression_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get dismiss rule, with name: {alertsSuppressionRuleName}, for the given subscription.
- Parameters
- Returns
AlertsSuppressionRule or ClientRawResponse if raw=true
- Return type
AlertsSuppressionRule or ClientRawResponse
- Raises
CloudError
-
list
(alert_type=None, custom_headers=None, raw=False, **operation_config)[source]¶ List of all the dismiss rules for the given subscription.
- Parameters
- Returns
An iterator like instance of AlertsSuppressionRule
- Return type
- Raises
CloudError
-
update
(alerts_suppression_rule_name, alerts_suppression_rule, custom_headers=None, raw=False, **operation_config)[source]¶ Update existing rule or create new rule if it doesn’t exist.
- Parameters
alerts_suppression_rule_name (str) – The unique name of the suppression alert rule
alerts_suppression_rule (AlertsSuppressionRule) – Suppression rule object
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AlertsSuppressionRule or ClientRawResponse if raw=true
- Return type
AlertsSuppressionRule or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
AllowedConnectionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AllowedConnectionsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01”.
-
get
(resource_group_name, connection_type, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of all possible traffic between resources for the subscription and location, based on connection type.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
connection_type (str or ConnectionType) – The type of allowed connections (Internal, External). Possible values include: ‘Internal’, ‘External’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AllowedConnectionsResource or ClientRawResponse if raw=true
- Return type
AllowedConnectionsResource or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of all possible traffic between resources for the subscription.
- Parameters
- Returns
An iterator like instance of AllowedConnectionsResource
- Return type
- Raises
CloudError
-
list_by_home_region
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets the list of all possible traffic between resources for the subscription and location.
- Parameters
- Returns
An iterator like instance of AllowedConnectionsResource
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
AssessmentsMetadataOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AssessmentsMetadataOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01”.
-
create_in_subscription
(assessment_metadata_name, assessment_metadata, custom_headers=None, raw=False, **operation_config)[source]¶ Create metadata information on an assessment type in a specific subscription.
- Parameters
assessment_metadata_name (str) – The Assessment Key - Unique key for the assessment type
assessment_metadata (SecurityAssessmentMetadata) – AssessmentMetadata object
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SecurityAssessmentMetadata or ClientRawResponse if raw=true
- Return type
SecurityAssessmentMetadata or ClientRawResponse
- Raises
CloudError
-
delete_in_subscription
(assessment_metadata_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete metadata information on an assessment type in a specific subscription, will cause the deletion of all the assessments of that type in that subscription.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(assessment_metadata_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get metadata information on an assessment type.
- Parameters
- Returns
SecurityAssessmentMetadata or ClientRawResponse if raw=true
- Return type
SecurityAssessmentMetadata or ClientRawResponse
- Raises
CloudError
-
get_in_subscription
(assessment_metadata_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get metadata information on an assessment type in a specific subscription.
- Parameters
- Returns
SecurityAssessmentMetadata or ClientRawResponse if raw=true
- Return type
SecurityAssessmentMetadata or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Get metadata information on all assessment types.
- Parameters
- Returns
An iterator like instance of SecurityAssessmentMetadata
- Return type
- Raises
CloudError
-
list_by_subscription
(custom_headers=None, raw=False, **operation_config)[source]¶ Get metadata information on all assessment types in a specific subscription.
- Parameters
- Returns
An iterator like instance of SecurityAssessmentMetadata
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
AssessmentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AssessmentsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01”.
-
create_or_update
(resource_id, assessment_name, assessment, custom_headers=None, raw=False, **operation_config)[source]¶ Create a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result.
- Parameters
resource_id (str) – The identifier of the resource.
assessment_name (str) – The Assessment Key - Unique key for the assessment type
assessment (SecurityAssessment) – Calculated assessment on a pre-defined assessment metadata
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SecurityAssessment or ClientRawResponse if raw=true
- Return type
SecurityAssessment or ClientRawResponse
- Raises
CloudError
-
delete
(resource_id, assessment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result.
- Parameters
resource_id (str) – The identifier of the resource.
assessment_name (str) – The Assessment Key - Unique key for the assessment type
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_id, assessment_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get a security assessment on your scanned resource.
- Parameters
resource_id (str) – The identifier of the resource.
assessment_name (str) – The Assessment Key - Unique key for the assessment type
expand (str or ExpandEnum) – OData expand. Optional. Possible values include: ‘links’, ‘metadata’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SecurityAssessment or ClientRawResponse if raw=true
- Return type
SecurityAssessment or ClientRawResponse
- Raises
CloudError
-
list
(scope, custom_headers=None, raw=False, **operation_config)[source]¶ Get security assessments on all your scanned resources inside a scope.
- Parameters
scope (str) – Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SecurityAssessment
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
AutoProvisioningSettingsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AutoProvisioningSettingsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2017-08-01-preview”.
-
create
(setting_name, auto_provision, custom_headers=None, raw=False, **operation_config)[source]¶ Details of a specific setting.
- Parameters
setting_name (str) – Auto provisioning setting key
auto_provision (str or AutoProvision) – Describes what kind of security agent provisioning action to take. Possible values include: ‘On’, ‘Off’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AutoProvisioningSetting or ClientRawResponse if raw=true
- Return type
AutoProvisioningSetting or ClientRawResponse
- Raises
CloudError
-
get
(setting_name, custom_headers=None, raw=False, **operation_config)[source]¶ Details of a specific setting.
- Parameters
- Returns
AutoProvisioningSetting or ClientRawResponse if raw=true
- Return type
AutoProvisioningSetting or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Exposes the auto provisioning settings of the subscriptions.
- Parameters
- Returns
An iterator like instance of AutoProvisioningSetting
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
AutomationsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
AutomationsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-01-01-preview”.
-
create_or_update
(resource_group_name, automation_name, automation, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a security automation. If a security automation is already created and a subsequent request is issued for the same automation id, then it will be updated.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
automation_name (str) – The security automation name.
automation (Automation) – The security automation resource
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Automation or ClientRawResponse if raw=true
- Return type
Automation or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, automation_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a security automation.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
automation_name (str) – The security automation name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, automation_name, custom_headers=None, raw=False, **operation_config)[source]¶ Retrieves information about the model of a security automation.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
automation_name (str) – The security automation name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Automation or ClientRawResponse if raw=true
- Return type
Automation or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the security automations in the specified subscription. Use the ‘nextLink’ property in the response to get the next page of security automations for the specified subscription.
- Parameters
- Returns
An iterator like instance of Automation
- Return type
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the security automations in the specified resource group. Use the ‘nextLink’ property in the response to get the next page of security automations for the specified resource group.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Automation
- Return type
- Raises
CloudError
-
validate
(resource_group_name, automation_name, automation, custom_headers=None, raw=False, **operation_config)[source]¶ Validates the security automation model before create or update. Any validation errors are returned to the client.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
automation_name (str) – The security automation name.
automation (Automation) – The security automation resource
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AutomationValidationStatus or ClientRawResponse if raw=true
- Return type
AutomationValidationStatus or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
ComplianceResultsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ComplianceResultsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2017-08-01”.
-
get
(resource_id, compliance_result_name, custom_headers=None, raw=False, **operation_config)[source]¶ Security Compliance Result.
- Parameters
resource_id (str) – The identifier of the resource.
compliance_result_name (str) – name of the desired assessment compliance result
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ComplianceResult or ClientRawResponse if raw=true
- Return type
ComplianceResult or ClientRawResponse
- Raises
CloudError
-
list
(scope, custom_headers=None, raw=False, **operation_config)[source]¶ Security compliance results in the subscription.
- Parameters
scope (str) – Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ComplianceResult
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
CompliancesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
CompliancesOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2017-08-01-preview”.
-
get
(scope, compliance_name, custom_headers=None, raw=False, **operation_config)[source]¶ Details of a specific Compliance.
- Parameters
scope (str) – Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
compliance_name (str) – name of the Compliance
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Compliance or ClientRawResponse if raw=true
- Return type
Compliance or ClientRawResponse
- Raises
CloudError
-
list
(scope, custom_headers=None, raw=False, **operation_config)[source]¶ The Compliance scores of the specific management group.
- Parameters
scope (str) – Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Compliance
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
DeviceSecurityGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DeviceSecurityGroupsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-08-01”.
-
create_or_update
(resource_id, device_security_group_name, device_security_group, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to creates or updates the device security group on a specified IoT Hub resource.
- Parameters
resource_id (str) – The identifier of the resource.
device_security_group_name (str) – The name of the device security group. Note that the name of the device security group is case insensitive.
device_security_group (DeviceSecurityGroup) – Security group object.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DeviceSecurityGroup or ClientRawResponse if raw=true
- Return type
DeviceSecurityGroup or ClientRawResponse
- Raises
CloudError
-
delete
(resource_id, device_security_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ User this method to deletes the device security group.
- Parameters
resource_id (str) – The identifier of the resource.
device_security_group_name (str) – The name of the device security group. Note that the name of the device security group is case insensitive.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_id, device_security_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to get the device security group for the specified IoT Hub resource.
- Parameters
resource_id (str) – The identifier of the resource.
device_security_group_name (str) – The name of the device security group. Note that the name of the device security group is case insensitive.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DeviceSecurityGroup or ClientRawResponse if raw=true
- Return type
DeviceSecurityGroup or ClientRawResponse
- Raises
CloudError
-
list
(resource_id, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method get the list of device security groups for the specified IoT Hub resource.
- Parameters
- Returns
An iterator like instance of DeviceSecurityGroup
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
DiscoveredSecuritySolutionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DiscoveredSecuritySolutionsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01”.
-
get
(resource_group_name, discovered_security_solution_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a specific discovered Security Solution.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
discovered_security_solution_name (str) – Name of a discovered security solution.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DiscoveredSecuritySolution or ClientRawResponse if raw=true
- Return type
DiscoveredSecuritySolution or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of discovered Security Solutions for the subscription.
- Parameters
- Returns
An iterator like instance of DiscoveredSecuritySolution
- Return type
- Raises
CloudError
-
list_by_home_region
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of discovered Security Solutions for the subscription and location.
- Parameters
- Returns
An iterator like instance of DiscoveredSecuritySolution
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
ExternalSecuritySolutionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ExternalSecuritySolutionsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01”.
-
get
(resource_group_name, external_security_solutions_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a specific external Security Solution.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
external_security_solutions_name (str) – Name of an external security solution.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ExternalSecuritySolution or ClientRawResponse if raw=true
- Return type
ExternalSecuritySolution or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of external security solutions for the subscription.
- Parameters
- Returns
An iterator like instance of ExternalSecuritySolution
- Return type
- Raises
CloudError
-
list_by_home_region
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of external Security Solutions for the subscription and location.
- Parameters
- Returns
An iterator like instance of ExternalSecuritySolution
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
InformationProtectionPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
InformationProtectionPoliciesOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2017-08-01-preview”.
-
create_or_update
(scope, information_protection_policy_name, labels=None, information_types=None, custom_headers=None, raw=False, **operation_config)[source]¶ Details of the information protection policy.
- Parameters
scope (str) – Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
information_protection_policy_name (str) – Name of the information protection policy. Possible values include: ‘effective’, ‘custom’
labels (dict[str, SensitivityLabel]) – Dictionary of sensitivity labels.
information_types (dict[str, InformationType]) – The sensitivity information types.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
InformationProtectionPolicy or ClientRawResponse if raw=true
- Return type
InformationProtectionPolicy or ClientRawResponse
- Raises
CloudError
-
get
(scope, information_protection_policy_name, custom_headers=None, raw=False, **operation_config)[source]¶ Details of the information protection policy.
- Parameters
scope (str) – Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
information_protection_policy_name (str) – Name of the information protection policy. Possible values include: ‘effective’, ‘custom’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
InformationProtectionPolicy or ClientRawResponse if raw=true
- Return type
InformationProtectionPolicy or ClientRawResponse
- Raises
CloudError
-
list
(scope, custom_headers=None, raw=False, **operation_config)[source]¶ Information protection policies of a specific management group.
- Parameters
scope (str) – Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of InformationProtectionPolicy
- Return type
InformationProtectionPolicyPaged[InformationProtectionPolicy]
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
IotSecuritySolutionAnalyticsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
IotSecuritySolutionAnalyticsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-08-01”.
-
get
(resource_group_name, solution_name, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to get IoT Security Analytics metrics.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IoTSecuritySolutionAnalyticsModel or ClientRawResponse if raw=true
- Return type
IoTSecuritySolutionAnalyticsModel or ClientRawResponse
- Raises
CloudError
-
list
(resource_group_name, solution_name, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to get IoT security Analytics metrics in an array.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IoTSecuritySolutionAnalyticsModelList or ClientRawResponse if raw=true
- Return type
IoTSecuritySolutionAnalyticsModelList or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
IotSecuritySolutionOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
IotSecuritySolutionOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-08-01”.
-
create_or_update
(resource_group_name, solution_name, iot_security_solution_data, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to create or update yours IoT Security solution.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
iot_security_solution_data (IoTSecuritySolutionModel) – The security solution data
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IoTSecuritySolutionModel or ClientRawResponse if raw=true
- Return type
IoTSecuritySolutionModel or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, solution_name, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to delete yours IoT Security solution.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, solution_name, custom_headers=None, raw=False, **operation_config)[source]¶ User this method to get details of a specific IoT Security solution based on solution name.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IoTSecuritySolutionModel or ClientRawResponse if raw=true
- Return type
IoTSecuritySolutionModel or ClientRawResponse
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to get the list IoT Security solutions organized by resource group.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
filter (str) – Filter the IoT Security solution with OData syntax. Supports filtering by iotHubs.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of IoTSecuritySolutionModel
- Return type
- Raises
CloudError
-
list_by_subscription
(filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to get the list of IoT Security solutions by subscription.
- Parameters
- Returns
An iterator like instance of IoTSecuritySolutionModel
- Return type
- Raises
CloudError
-
update
(resource_group_name, solution_name, update_iot_security_solution_data, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to update existing IoT Security solution tags or user defined resources. To update other fields use the CreateOrUpdate method.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
update_iot_security_solution_data (UpdateIotSecuritySolutionData) – The security solution data
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IoTSecuritySolutionModel or ClientRawResponse if raw=true
- Return type
IoTSecuritySolutionModel or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
IotSecuritySolutionsAnalyticsAggregatedAlertOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
IotSecuritySolutionsAnalyticsAggregatedAlertOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-08-01”.
-
dismiss
(resource_group_name, solution_name, aggregated_alert_name, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to dismiss an aggregated IoT Security Solution Alert.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
aggregated_alert_name (str) – Identifier of the aggregated alert.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, solution_name, aggregated_alert_name, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to get a single the aggregated alert of yours IoT Security solution. This aggregation is performed by alert name.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
aggregated_alert_name (str) – Identifier of the aggregated alert.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IoTSecurityAggregatedAlert or ClientRawResponse if raw=true
- Return type
IoTSecurityAggregatedAlert or ClientRawResponse
- Raises
CloudError
-
list
(resource_group_name, solution_name, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to get the aggregated alert list of yours IoT Security solution.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
top (int) – Number of results to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of IoTSecurityAggregatedAlert
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
IotSecuritySolutionsAnalyticsRecommendationOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
IotSecuritySolutionsAnalyticsRecommendationOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-08-01”.
-
get
(resource_group_name, solution_name, aggregated_recommendation_name, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to get the aggregated security analytics recommendation of yours IoT Security solution. This aggregation is performed by recommendation name.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
aggregated_recommendation_name (str) – Name of the recommendation aggregated for this query.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IoTSecurityAggregatedRecommendation or ClientRawResponse if raw=true
- Return type
IoTSecurityAggregatedRecommendation or ClientRawResponse
- Raises
CloudError
-
list
(resource_group_name, solution_name, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Use this method to get the list of aggregated security analytics recommendations of yours IoT Security solution.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
solution_name (str) – The name of the IoT Security solution.
top (int) – Number of results to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of IoTSecurityAggregatedRecommendation
- Return type
IoTSecurityAggregatedRecommendationPaged[IoTSecurityAggregatedRecommendation]
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
JitNetworkAccessPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JitNetworkAccessPoliciesOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01”.
jit_network_access_policy_initiate_type – Type of the action to do on the Just-in-Time access policy. Constant value: “initiate”.
-
create_or_update
(resource_group_name, jit_network_access_policy_name, body, custom_headers=None, raw=False, **operation_config)[source]¶ Create a policy for protecting resources using Just-in-Time access control.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
jit_network_access_policy_name (str) – Name of a Just-in-Time access configuration policy.
body (JitNetworkAccessPolicy) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JitNetworkAccessPolicy or ClientRawResponse if raw=true
- Return type
JitNetworkAccessPolicy or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, jit_network_access_policy_name, custom_headers=None, raw=False, **operation_config)[source]¶ Delete a Just-in-Time access control policy.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
jit_network_access_policy_name (str) – Name of a Just-in-Time access configuration policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, jit_network_access_policy_name, custom_headers=None, raw=False, **operation_config)[source]¶ Policies for protecting resources using Just-in-Time access control for the subscription, location.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
jit_network_access_policy_name (str) – Name of a Just-in-Time access configuration policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JitNetworkAccessPolicy or ClientRawResponse if raw=true
- Return type
JitNetworkAccessPolicy or ClientRawResponse
- Raises
CloudError
-
initiate
(resource_group_name, jit_network_access_policy_name, virtual_machines, justification=None, custom_headers=None, raw=False, **operation_config)[source]¶ Initiate a JIT access from a specific Just-in-Time policy configuration.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
jit_network_access_policy_name (str) – Name of a Just-in-Time access configuration policy.
virtual_machines (list[JitNetworkAccessPolicyInitiateVirtualMachine]) – A list of virtual machines & ports to open access for
justification (str) – The justification for making the initiate request
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JitNetworkAccessRequest or ClientRawResponse if raw=true
- Return type
JitNetworkAccessRequest or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Policies for protecting resources using Just-in-Time access control.
- Parameters
- Returns
An iterator like instance of JitNetworkAccessPolicy
- Return type
- Raises
CloudError
-
list_by_region
(custom_headers=None, raw=False, **operation_config)[source]¶ Policies for protecting resources using Just-in-Time access control for the subscription, location.
- Parameters
- Returns
An iterator like instance of JitNetworkAccessPolicy
- Return type
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Policies for protecting resources using Just-in-Time access control for the subscription, location.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JitNetworkAccessPolicy
- Return type
- Raises
CloudError
-
list_by_resource_group_and_region
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Policies for protecting resources using Just-in-Time access control for the subscription, location.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JitNetworkAccessPolicy
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
LocationsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
LocationsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2015-06-01-preview”.
-
get
(custom_headers=None, raw=False, **operation_config)[source]¶ Details of a specific location.
- Parameters
- Returns
AscLocation or ClientRawResponse if raw=true
- Return type
AscLocation or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ The location of the responsible ASC of the specific subscription (home region). For each subscription there is only one responsible location. The location in the response should be used to read or write other resources in ASC according to their ID.
- Parameters
- Returns
An iterator like instance of AscLocation
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2015-06-01-preview”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Exposes all available operations for discovery purposes.
- Parameters
- Returns
An iterator like instance of Operation
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
PricingsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PricingsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2018-06-01”.
-
get
(pricing_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a provided Security Center pricing configuration in the subscription.
- Parameters
- Returns
Pricing or ClientRawResponse if raw=true
- Return type
Pricing or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists Security Center pricing configurations in the subscription.
- Parameters
- Returns
PricingList or ClientRawResponse if raw=true
- Return type
PricingList or ClientRawResponse
- Raises
CloudError
-
update
(pricing_name, pricing_tier, custom_headers=None, raw=False, **operation_config)[source]¶ Updates a provided Security Center pricing configuration in the subscription.
- Parameters
pricing_name (str) – name of the pricing configuration
pricing_tier (str or PricingTier) – The pricing tier value. Azure Security Center is provided in two pricing tiers: free and standard, with the standard tier available with a trial period. The standard tier offers advanced security capabilities, while the free tier offers basic security features. Possible values include: ‘Free’, ‘Standard’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Pricing or ClientRawResponse if raw=true
- Return type
Pricing or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
RegulatoryComplianceAssessmentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
RegulatoryComplianceAssessmentsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-01-01-preview”.
-
get
(regulatory_compliance_standard_name, regulatory_compliance_control_name, regulatory_compliance_assessment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Supported regulatory compliance details and state for selected assessment.
- Parameters
regulatory_compliance_standard_name (str) – Name of the regulatory compliance standard object
regulatory_compliance_control_name (str) – Name of the regulatory compliance control object
regulatory_compliance_assessment_name (str) – Name of the regulatory compliance assessment object
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
RegulatoryComplianceAssessment or ClientRawResponse if raw=true
- Return type
RegulatoryComplianceAssessment or ClientRawResponse
- Raises
CloudError
-
list
(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Details and state of assessments mapped to selected regulatory compliance control.
- Parameters
regulatory_compliance_standard_name (str) – Name of the regulatory compliance standard object
regulatory_compliance_control_name (str) – Name of the regulatory compliance control object
filter (str) – OData filter. Optional.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of RegulatoryComplianceAssessment
- Return type
RegulatoryComplianceAssessmentPaged[RegulatoryComplianceAssessment]
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
RegulatoryComplianceControlsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
RegulatoryComplianceControlsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-01-01-preview”.
-
get
(regulatory_compliance_standard_name, regulatory_compliance_control_name, custom_headers=None, raw=False, **operation_config)[source]¶ Selected regulatory compliance control details and state.
- Parameters
regulatory_compliance_standard_name (str) – Name of the regulatory compliance standard object
regulatory_compliance_control_name (str) – Name of the regulatory compliance control object
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
RegulatoryComplianceControl or ClientRawResponse if raw=true
- Return type
RegulatoryComplianceControl or ClientRawResponse
- Raises
CloudError
-
list
(regulatory_compliance_standard_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ All supported regulatory compliance controls details and state for selected standard.
- Parameters
regulatory_compliance_standard_name (str) – Name of the regulatory compliance standard object
filter (str) – OData filter. Optional.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of RegulatoryComplianceControl
- Return type
RegulatoryComplianceControlPaged[RegulatoryComplianceControl]
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
RegulatoryComplianceStandardsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
RegulatoryComplianceStandardsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-01-01-preview”.
-
get
(regulatory_compliance_standard_name, custom_headers=None, raw=False, **operation_config)[source]¶ Supported regulatory compliance details state for selected standard.
- Parameters
- Returns
RegulatoryComplianceStandard or ClientRawResponse if raw=true
- Return type
RegulatoryComplianceStandard or ClientRawResponse
- Raises
CloudError
-
list
(filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Supported regulatory compliance standards details and state.
- Parameters
- Returns
An iterator like instance of RegulatoryComplianceStandard
- Return type
RegulatoryComplianceStandardPaged[RegulatoryComplianceStandard]
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
SecureScoreControlDefinitionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SecureScoreControlDefinitionsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01-preview”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ List the available security controls, their assessments, and the max score.
- Parameters
- Returns
An iterator like instance of SecureScoreControlDefinitionItem
- Return type
SecureScoreControlDefinitionItemPaged[SecureScoreControlDefinitionItem]
- Raises
CloudError
-
list_by_subscription
(custom_headers=None, raw=False, **operation_config)[source]¶ For a specified subscription, list the available security controls, their assessments, and the max score.
- Parameters
- Returns
An iterator like instance of SecureScoreControlDefinitionItem
- Return type
SecureScoreControlDefinitionItemPaged[SecureScoreControlDefinitionItem]
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
SecureScoreControlsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SecureScoreControlsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01-preview”.
-
list
(expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get all security controls within a scope.
- Parameters
expand (str or ExpandControlsEnum) – OData expand. Optional. Possible values include: ‘definition’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SecureScoreControlDetails
- Return type
- Raises
CloudError
-
list_by_secure_score
(secure_score_name, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get all security controls for a specific initiative within a scope.
- Parameters
secure_score_name (str) – The initiative name. For the ASC Default initiative, use ‘ascScore’ as in the sample request below.
expand (str or ExpandControlsEnum) – OData expand. Optional. Possible values include: ‘definition’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SecureScoreControlDetails
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
SecureScoresOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SecureScoresOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01-preview”.
-
get
(secure_score_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get secure score for a specific Security Center initiative within your current scope. For the ASC Default initiative, use ‘ascScore’.
- Parameters
secure_score_name (str) – The initiative name. For the ASC Default initiative, use ‘ascScore’ as in the sample request below.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SecureScoreItem or ClientRawResponse if raw=true
- Return type
SecureScoreItem or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ List secure scores for all your Security Center initiatives within your current scope.
- Parameters
- Returns
An iterator like instance of SecureScoreItem
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
SecurityContactsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SecurityContactsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2017-08-01-preview”.
-
create
(security_contact_name, security_contact, custom_headers=None, raw=False, **operation_config)[source]¶ Security contact configurations for the subscription.
- Parameters
security_contact_name (str) – Name of the security contact object
security_contact (SecurityContact) – Security contact object
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SecurityContact or ClientRawResponse if raw=true
- Return type
SecurityContact or ClientRawResponse
- Raises
CloudError
-
delete
(security_contact_name, custom_headers=None, raw=False, **operation_config)[source]¶ Security contact configurations for the subscription.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(security_contact_name, custom_headers=None, raw=False, **operation_config)[source]¶ Security contact configurations for the subscription.
- Parameters
- Returns
SecurityContact or ClientRawResponse if raw=true
- Return type
SecurityContact or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Security contact configurations for the subscription.
- Parameters
- Returns
An iterator like instance of SecurityContact
- Return type
- Raises
CloudError
-
update
(security_contact_name, security_contact, custom_headers=None, raw=False, **operation_config)[source]¶ Security contact configurations for the subscription.
- Parameters
security_contact_name (str) – Name of the security contact object
security_contact (SecurityContact) – Security contact object
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SecurityContact or ClientRawResponse if raw=true
- Return type
SecurityContact or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
ServerVulnerabilityAssessmentOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServerVulnerabilityAssessmentOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01”.
server_vulnerability_assessment – ServerVulnerabilityAssessment status. only a ‘default’ value is supported. Constant value: “default”.
-
create_or_update
(resource_group_name, resource_namespace, resource_type, resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Creating a server vulnerability assessment on a resource, which will onboard a resource for having a vulnerability assessment on it.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
resource_namespace (str) – The Namespace of the resource.
resource_type (str) – The type of the resource.
resource_name (str) – Name of the resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerVulnerabilityAssessment or ClientRawResponse if raw=true
- Return type
ServerVulnerabilityAssessment or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, resource_namespace, resource_type, resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Removing server vulnerability assessment from a resource.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
resource_namespace (str) – The Namespace of the resource.
resource_type (str) – The type of the resource.
resource_name (str) – Name of the resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, resource_namespace, resource_type, resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a server vulnerability assessment onboarding statuses on a given resource.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
resource_namespace (str) – The Namespace of the resource.
resource_type (str) – The type of the resource.
resource_name (str) – Name of the resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerVulnerabilityAssessment or ClientRawResponse if raw=true
- Return type
ServerVulnerabilityAssessment or ClientRawResponse
- Raises
CloudError
-
list_by_extended_resource
(resource_group_name, resource_namespace, resource_type, resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of server vulnerability assessment onboarding statuses on a given resource.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
resource_namespace (str) – The Namespace of the resource.
resource_type (str) – The type of the resource.
resource_name (str) – Name of the resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerVulnerabilityAssessmentsList or ClientRawResponse if raw=true
- Return type
ServerVulnerabilityAssessmentsList or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
SettingsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SettingsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-01-01”.
-
get
(setting_name, custom_headers=None, raw=False, **operation_config)[source]¶ Settings of different configurations in security center.
- Parameters
- Returns
Setting or ClientRawResponse if raw=true
- Return type
Setting or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Settings about different configurations in security center.
- Parameters
- Returns
An iterator like instance of Setting
- Return type
- Raises
CloudError
-
update
(setting_name, setting, custom_headers=None, raw=False, **operation_config)[source]¶ updating settings about different configurations in security center.
- Parameters
setting_name (str) – Name of setting: (MCAS/WDATP). Possible values include: ‘MCAS’, ‘WDATP’
setting (Setting) – Setting object
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Setting or ClientRawResponse if raw=true
- Return type
Setting or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
SubAssessmentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SubAssessmentsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2019-01-01-preview”.
-
get
(scope, assessment_name, sub_assessment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get a security sub-assessment on your scanned resource.
- Parameters
scope (str) – Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
assessment_name (str) – The Assessment Key - Unique key for the assessment type
sub_assessment_name (str) – The Sub-Assessment Key - Unique key for the sub-assessment type
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SecuritySubAssessment or ClientRawResponse if raw=true
- Return type
SecuritySubAssessment or ClientRawResponse
- Raises
CloudError
-
list
(scope, assessment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get security sub-assessments on all your scanned resources inside a scope.
- Parameters
scope (str) – Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
assessment_name (str) – The Assessment Key - Unique key for the assessment type
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SecuritySubAssessment
- Return type
- Raises
CloudError
-
list_all
(scope, custom_headers=None, raw=False, **operation_config)[source]¶ Get security sub-assessments on all your scanned resources inside a subscription scope.
- Parameters
scope (str) – Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SecuritySubAssessment
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
TasksOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
TasksOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2015-06-01-preview”.
-
get_resource_group_level_task
(resource_group_name, task_name, custom_headers=None, raw=False, **operation_config)[source]¶ Recommended tasks that will help improve the security of the subscription proactively.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
task_name (str) – Name of the task object, will be a GUID
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SecurityTask or ClientRawResponse if raw=true
- Return type
SecurityTask or ClientRawResponse
- Raises
CloudError
-
get_subscription_level_task
(task_name, custom_headers=None, raw=False, **operation_config)[source]¶ Recommended tasks that will help improve the security of the subscription proactively.
- Parameters
- Returns
SecurityTask or ClientRawResponse if raw=true
- Return type
SecurityTask or ClientRawResponse
- Raises
CloudError
-
list
(filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Recommended tasks that will help improve the security of the subscription proactively.
- Parameters
- Returns
An iterator like instance of SecurityTask
- Return type
- Raises
CloudError
-
list_by_home_region
(filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Recommended tasks that will help improve the security of the subscription proactively.
- Parameters
- Returns
An iterator like instance of SecurityTask
- Return type
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Recommended tasks that will help improve the security of the subscription proactively.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
filter (str) – OData filter. Optional.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SecurityTask
- Return type
- Raises
CloudError
-
update_resource_group_level_task_state
(resource_group_name, task_name, task_update_action_type, custom_headers=None, raw=False, **operation_config)[source]¶ Recommended tasks that will help improve the security of the subscription proactively.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
task_name (str) – Name of the task object, will be a GUID
task_update_action_type (str) – Type of the action to do on the task. Possible values include: ‘Activate’, ‘Dismiss’, ‘Start’, ‘Resolve’, ‘Close’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
update_subscription_level_task_state
(task_name, task_update_action_type, custom_headers=None, raw=False, **operation_config)[source]¶ Recommended tasks that will help improve the security of the subscription proactively.
- Parameters
task_name (str) – Name of the task object, will be a GUID
task_update_action_type (str) – Type of the action to do on the task. Possible values include: ‘Activate’, ‘Dismiss’, ‘Start’, ‘Resolve’, ‘Close’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
TopologyOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
TopologyOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2020-01-01”.
-
get
(resource_group_name, topology_resource_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a specific topology component.
- Parameters
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
topology_resource_name (str) – Name of a topology resources collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TopologyResource or ClientRawResponse if raw=true
- Return type
TopologyResource or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list that allows to build a topology view of a subscription.
- Parameters
- Returns
An iterator like instance of TopologyResource
- Return type
- Raises
CloudError
-
list_by_home_region
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list that allows to build a topology view of a subscription and location.
- Parameters
- Returns
An iterator like instance of TopologyResource
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶
-
class
azure.mgmt.security.operations.
WorkspaceSettingsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
WorkspaceSettingsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – API version for the operation. Constant value: “2017-08-01-preview”.
-
create
(workspace_setting_name, workspace_id, scope, custom_headers=None, raw=False, **operation_config)[source]¶ creating settings about where we should store your security data and logs.
- Parameters
workspace_setting_name (str) – Name of the security setting
workspace_id (str) – The full Azure ID of the workspace to save the data in
scope (str) – All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
WorkspaceSetting or ClientRawResponse if raw=true
- Return type
WorkspaceSetting or ClientRawResponse
- Raises
CloudError
-
delete
(workspace_setting_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes the custom workspace settings for this subscription. new VMs will report to the default workspace.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(workspace_setting_name, custom_headers=None, raw=False, **operation_config)[source]¶ Settings about where we should store your security data and logs. If the result is empty, it means that no custom-workspace configuration was set.
- Parameters
- Returns
WorkspaceSetting or ClientRawResponse if raw=true
- Return type
WorkspaceSetting or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Settings about where we should store your security data and logs. If the result is empty, it means that no custom-workspace configuration was set.
- Parameters
- Returns
An iterator like instance of WorkspaceSetting
- Return type
- Raises
CloudError
-
update
(workspace_setting_name, workspace_id, scope, custom_headers=None, raw=False, **operation_config)[source]¶ Settings about where we should store your security data and logs.
- Parameters
workspace_setting_name (str) – Name of the security setting
workspace_id (str) – The full Azure ID of the workspace to save the data in
scope (str) – All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
WorkspaceSetting or ClientRawResponse if raw=true
- Return type
WorkspaceSetting or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.security.models' from '/home/vsts/work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶