azure.mgmt.security.operations module¶

class azure.mgmt.security.operations.AdaptiveApplicationControlsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AdaptiveApplicationControlsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

delete(group_name: str, **kwargs: Any) → None [source]¶

Delete an application control machine group.

Parameters: group_name (str) – Name of an application control machine group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

get(group_name: str, **kwargs: Any) → _models.AdaptiveApplicationControlGroup[source]¶

Gets an application control VM/server group.

Parameters: group_name (str) – Name of an application control machine group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: AdaptiveApplicationControlGroup, or the result of cls(response)
Return type: AdaptiveApplicationControlGroup
Raises: ~azure.core.exceptions.HttpResponseError

list(include_path_recommendations: Optional[bool] = None, summary: Optional[bool] = None, **kwargs: Any) → _models.AdaptiveApplicationControlGroups[source]¶

Gets a list of application control machine groups for the subscription.

Parameters

include_path_recommendations (bool) – Include the policy rules.
summary (bool) – Return output in a summarized form.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AdaptiveApplicationControlGroups, or the result of cls(response)

Return type

AdaptiveApplicationControlGroups

Raises

~azure.core.exceptions.HttpResponseError

put(group_name: str, body: ‘_models.AdaptiveApplicationControlGroup’, **kwargs: Any) → _models.AdaptiveApplicationControlGroup[source]¶

Update an application control machine group.

Parameters

group_name (str) – Name of an application control machine group.
body (AdaptiveApplicationControlGroup) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AdaptiveApplicationControlGroup, or the result of cls(response)

Return type

AdaptiveApplicationControlGroup

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_enforce(resource_group_name: str, resource_namespace: str, resource_type: str, resource_name: str, adaptive_network_hardening_resource_name: str, body: ‘_models.AdaptiveNetworkHardeningEnforceRequest’, **kwargs: Any) → LROPoller[None][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.
body (AdaptiveNetworkHardeningEnforceRequest) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, resource_namespace: str, resource_type: str, resource_name: str, adaptive_network_hardening_resource_name: str, **kwargs: Any) → _models.AdaptiveNetworkHardening[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AdaptiveNetworkHardening, or the result of cls(response)

Return type

AdaptiveNetworkHardening

Raises

~azure.core.exceptions.HttpResponseError

list_by_extended_resource(resource_group_name: str, resource_namespace: str, resource_type: str, resource_name: str, **kwargs: Any) → Iterable[‘_models.AdaptiveNetworkHardeningsList’][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AdaptiveNetworkHardeningsList or the result of cls(response)

Return type

ItemPaged[AdaptiveNetworkHardeningsList]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create(resource_id: str, advanced_threat_protection_setting: ‘_models.AdvancedThreatProtectionSetting’, **kwargs: Any) → _models.AdvancedThreatProtectionSetting[source]¶

Creates or updates the Advanced Threat Protection settings on a specified resource.

Parameters

resource_id (str) – The identifier of the resource.
advanced_threat_protection_setting (AdvancedThreatProtectionSetting) – Advanced Threat Protection Settings.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AdvancedThreatProtectionSetting, or the result of cls(response)

Return type

AdvancedThreatProtectionSetting

Raises

~azure.core.exceptions.HttpResponseError

get(resource_id: str, **kwargs: Any) → _models.AdvancedThreatProtectionSetting[source]¶

Gets the Advanced Threat Protection settings for the specified resource.

Parameters: resource_id (str) – The identifier of the resource.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: AdvancedThreatProtectionSetting, or the result of cls(response)
Return type: AdvancedThreatProtectionSetting
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_simulate(alert_simulator_request_body: ‘_models.AlertSimulatorRequestBody’, **kwargs: Any) → LROPoller[None][source]¶

Simulate security alerts.

Parameters

alert_simulator_request_body (AlertSimulatorRequestBody) – Alert Simulator Request Properties.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get_resource_group_level(alert_name: str, resource_group_name: str, **kwargs: Any) → _models.Alert[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Alert, or the result of cls(response)

Return type

Alert

Raises

~azure.core.exceptions.HttpResponseError

get_subscription_level(alert_name: str, **kwargs: Any) → _models.Alert[source]¶

Get an alert that is associated with a subscription.

Parameters: alert_name (str) – Name of the alert object.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Alert, or the result of cls(response)
Return type: Alert
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.AlertList’][source]¶

List all the alerts that are associated with the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AlertList or the result of cls(response)
Return type: ItemPaged[AlertList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘_models.AlertList’][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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AlertList or the result of cls(response)
Return type: ItemPaged[AlertList]
Raises: ~azure.core.exceptions.HttpResponseError

list_resource_group_level_by_region(resource_group_name: str, **kwargs: Any) → Iterable[‘_models.AlertList’][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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AlertList or the result of cls(response)
Return type: ItemPaged[AlertList]
Raises: ~azure.core.exceptions.HttpResponseError

list_subscription_level_by_region(**kwargs: Any) → Iterable[‘_models.AlertList’][source]¶

List all the alerts that are associated with the subscription that are stored in a specific location.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AlertList or the result of cls(response)
Return type: ItemPaged[AlertList]
Raises: ~azure.core.exceptions.HttpResponseError

update_resource_group_level_state_to_activate(alert_name: str, resource_group_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

update_resource_group_level_state_to_dismiss(alert_name: str, resource_group_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

update_resource_group_level_state_to_resolve(alert_name: str, resource_group_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

update_subscription_level_state_to_activate(alert_name: str, **kwargs: Any) → None [source]¶

Update the alert’s state.

Parameters: alert_name (str) – Name of the alert object.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

update_subscription_level_state_to_dismiss(alert_name: str, **kwargs: Any) → None [source]¶

Update the alert’s state.

Parameters: alert_name (str) – Name of the alert object.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

update_subscription_level_state_to_resolve(alert_name: str, **kwargs: Any) → None [source]¶

Update the alert’s state.

Parameters: alert_name (str) – Name of the alert object.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

delete(alerts_suppression_rule_name: str, **kwargs: Any) → None [source]¶

Delete dismiss alert rule for this subscription.

Parameters: alerts_suppression_rule_name (str) – The unique name of the suppression alert rule.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

get(alerts_suppression_rule_name: str, **kwargs: Any) → _models.AlertsSuppressionRule[source]¶

Get dismiss rule, with name: {alertsSuppressionRuleName}, for the given subscription.

Parameters: alerts_suppression_rule_name (str) – The unique name of the suppression alert rule.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: AlertsSuppressionRule, or the result of cls(response)
Return type: AlertsSuppressionRule
Raises: ~azure.core.exceptions.HttpResponseError

list(alert_type: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.AlertsSuppressionRulesList’][source]¶

List of all the dismiss rules for the given subscription.

Parameters: alert_type (str) – Type of the alert to get rules for.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AlertsSuppressionRulesList or the result of cls(response)
Return type: ItemPaged[AlertsSuppressionRulesList]
Raises: ~azure.core.exceptions.HttpResponseError

update(alerts_suppression_rule_name: str, alerts_suppression_rule: ‘_models.AlertsSuppressionRule’, **kwargs: Any) → _models.AlertsSuppressionRule[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AlertsSuppressionRule, or the result of cls(response)

Return type

AlertsSuppressionRule

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, connection_type: Union[str, ‘_models.ConnectionType’], **kwargs: Any) → _models.AllowedConnectionsResource[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).

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AllowedConnectionsResource, or the result of cls(response)

Return type

AllowedConnectionsResource

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.AllowedConnectionsList’][source]¶

Gets the list of all possible traffic between resources for the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AllowedConnectionsList or the result of cls(response)
Return type: ItemPaged[AllowedConnectionsList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_home_region(**kwargs: Any) → Iterable[‘_models.AllowedConnectionsList’][source]¶

Gets the list of all possible traffic between resources for the subscription and location.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AllowedConnectionsList or the result of cls(response)
Return type: ItemPaged[AllowedConnectionsList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_in_subscription(assessment_metadata_name: str, assessment_metadata: ‘_models.SecurityAssessmentMetadata’, **kwargs: Any) → _models.SecurityAssessmentMetadata[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecurityAssessmentMetadata, or the result of cls(response)

Return type

SecurityAssessmentMetadata

Raises

~azure.core.exceptions.HttpResponseError

delete_in_subscription(assessment_metadata_name: str, **kwargs: Any) → None [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: assessment_metadata_name (str) – The Assessment Key - Unique key for the assessment type.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

get(assessment_metadata_name: str, **kwargs: Any) → _models.SecurityAssessmentMetadata[source]¶

Get metadata information on an assessment type.

Parameters: assessment_metadata_name (str) – The Assessment Key - Unique key for the assessment type.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: SecurityAssessmentMetadata, or the result of cls(response)
Return type: SecurityAssessmentMetadata
Raises: ~azure.core.exceptions.HttpResponseError

get_in_subscription(assessment_metadata_name: str, **kwargs: Any) → _models.SecurityAssessmentMetadata[source]¶

Get metadata information on an assessment type in a specific subscription.

Parameters: assessment_metadata_name (str) – The Assessment Key - Unique key for the assessment type.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: SecurityAssessmentMetadata, or the result of cls(response)
Return type: SecurityAssessmentMetadata
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.SecurityAssessmentMetadataList’][source]¶

Get metadata information on all assessment types.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecurityAssessmentMetadataList or the result of cls(response)
Return type: ItemPaged[SecurityAssessmentMetadataList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_subscription(**kwargs: Any) → Iterable[‘_models.SecurityAssessmentMetadataList’][source]¶

Get metadata information on all assessment types in a specific subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecurityAssessmentMetadataList or the result of cls(response)
Return type: ItemPaged[SecurityAssessmentMetadataList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_id: str, assessment_name: str, assessment: ‘_models.SecurityAssessment’, **kwargs: Any) → _models.SecurityAssessment[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecurityAssessment, or the result of cls(response)

Return type

SecurityAssessment

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_id: str, assessment_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_id: str, assessment_name: str, expand: Optional[Union[str, ‘_models.ExpandEnum’]] = None, **kwargs: Any) → _models.SecurityAssessment[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecurityAssessment, or the result of cls(response)

Return type

SecurityAssessment

Raises

~azure.core.exceptions.HttpResponseError

list(scope: str, **kwargs: Any) → Iterable[‘_models.SecurityAssessmentList’][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).
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecurityAssessmentList or the result of cls(response)
Return type: ItemPaged[SecurityAssessmentList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create(setting_name: str, setting: ‘_models.AutoProvisioningSetting’, **kwargs: Any) → _models.AutoProvisioningSetting[source]¶

Details of a specific setting.

Parameters

setting_name (str) – Auto provisioning setting key.
setting (AutoProvisioningSetting) – Auto provisioning setting key.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AutoProvisioningSetting, or the result of cls(response)

Return type

AutoProvisioningSetting

Raises

~azure.core.exceptions.HttpResponseError

get(setting_name: str, **kwargs: Any) → _models.AutoProvisioningSetting[source]¶

Details of a specific setting.

Parameters: setting_name (str) – Auto provisioning setting key.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: AutoProvisioningSetting, or the result of cls(response)
Return type: AutoProvisioningSetting
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.AutoProvisioningSettingList’][source]¶

Exposes the auto provisioning settings of the subscriptions.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AutoProvisioningSettingList or the result of cls(response)
Return type: ItemPaged[AutoProvisioningSettingList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_name: str, automation: ‘_models.Automation’, **kwargs: Any) → _models.Automation[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Automation, or the result of cls(response)

Return type

Automation

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_name: str, **kwargs: Any) → _models.Automation[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Automation, or the result of cls(response)

Return type

Automation

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.AutomationList’][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.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AutomationList or the result of cls(response)
Return type: ItemPaged[AutomationList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘_models.AutomationList’][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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AutomationList or the result of cls(response)
Return type: ItemPaged[AutomationList]
Raises: ~azure.core.exceptions.HttpResponseError

validate(resource_group_name: str, automation_name: str, automation: ‘_models.Automation’, **kwargs: Any) → _models.AutomationValidationStatus[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AutomationValidationStatus, or the result of cls(response)

Return type

AutomationValidationStatus

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_id: str, compliance_result_name: str, **kwargs: Any) → _models.ComplianceResult[source]¶

Security Compliance Result.

Parameters

resource_id (str) – The identifier of the resource.
compliance_result_name (str) – name of the desired assessment compliance result.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ComplianceResult, or the result of cls(response)

Return type

ComplianceResult

Raises

~azure.core.exceptions.HttpResponseError

list(scope: str, **kwargs: Any) → Iterable[‘_models.ComplianceResultList’][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).
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ComplianceResultList or the result of cls(response)
Return type: ItemPaged[ComplianceResultList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(scope: str, compliance_name: str, **kwargs: Any) → _models.Compliance[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Compliance, or the result of cls(response)

Return type

Compliance

Raises

~azure.core.exceptions.HttpResponseError

list(scope: str, **kwargs: Any) → Iterable[‘_models.ComplianceList’][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).
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ComplianceList or the result of cls(response)
Return type: ItemPaged[ComplianceList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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.ConnectorsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ConnectorsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(connector_name: str, connector_setting: ‘_models.ConnectorSetting’, **kwargs: Any) → _models.ConnectorSetting[source]¶

Create a cloud account connector or update an existing one. Connect to your cloud account. For AWS, use either account credentials or role-based authentication. For GCP, use account organization credentials.

Parameters

connector_name (str) – Name of the cloud account connector.
connector_setting (ConnectorSetting) – Settings for the cloud account connector.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ConnectorSetting, or the result of cls(response)

Return type

ConnectorSetting

Raises

~azure.core.exceptions.HttpResponseError

delete(connector_name: str, **kwargs: Any) → None [source]¶

Delete a cloud account connector from a subscription.

Parameters: connector_name (str) – Name of the cloud account connector.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

get(connector_name: str, **kwargs: Any) → _models.ConnectorSetting[source]¶

Details of a specific cloud account connector.

Parameters: connector_name (str) – Name of the cloud account connector.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: ConnectorSetting, or the result of cls(response)
Return type: ConnectorSetting
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.ConnectorSettingList’][source]¶

Cloud accounts connectors of a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ConnectorSettingList or the result of cls(response)
Return type: ItemPaged[ConnectorSettingList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_id: str, device_security_group_name: str, device_security_group: ‘_models.DeviceSecurityGroup’, **kwargs: Any) → _models.DeviceSecurityGroup[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeviceSecurityGroup, or the result of cls(response)

Return type

DeviceSecurityGroup

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_id: str, device_security_group_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_id: str, device_security_group_name: str, **kwargs: Any) → _models.DeviceSecurityGroup[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeviceSecurityGroup, or the result of cls(response)

Return type

DeviceSecurityGroup

Raises

~azure.core.exceptions.HttpResponseError

list(resource_id: str, **kwargs: Any) → Iterable[‘_models.DeviceSecurityGroupList’][source]¶

Use this method get the list of device security groups for the specified IoT Hub resource.

Parameters: resource_id (str) – The identifier of the resource.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DeviceSecurityGroupList or the result of cls(response)
Return type: ItemPaged[DeviceSecurityGroupList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, discovered_security_solution_name: str, **kwargs: Any) → _models.DiscoveredSecuritySolution[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DiscoveredSecuritySolution, or the result of cls(response)

Return type

DiscoveredSecuritySolution

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.DiscoveredSecuritySolutionList’][source]¶

Gets a list of discovered Security Solutions for the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DiscoveredSecuritySolutionList or the result of cls(response)
Return type: ItemPaged[DiscoveredSecuritySolutionList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_home_region(**kwargs: Any) → Iterable[‘_models.DiscoveredSecuritySolutionList’][source]¶

Gets a list of discovered Security Solutions for the subscription and location.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DiscoveredSecuritySolutionList or the result of cls(response)
Return type: ItemPaged[DiscoveredSecuritySolutionList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, external_security_solutions_name: str, **kwargs: Any) → _models.ExternalSecuritySolution[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExternalSecuritySolution, or the result of cls(response)

Return type

ExternalSecuritySolution

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.ExternalSecuritySolutionList’][source]¶

Gets a list of external security solutions for the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ExternalSecuritySolutionList or the result of cls(response)
Return type: ItemPaged[ExternalSecuritySolutionList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_home_region(**kwargs: Any) → Iterable[‘_models.ExternalSecuritySolutionList’][source]¶

Gets a list of external Security Solutions for the subscription and location.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ExternalSecuritySolutionList or the result of cls(response)
Return type: ItemPaged[ExternalSecuritySolutionList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(scope: str, information_protection_policy_name: Union[str, ‘_models.Enum15’], information_protection_policy: ‘_models.InformationProtectionPolicy’, **kwargs: Any) → _models.InformationProtectionPolicy[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 or Enum15) – Name of the information protection policy.
information_protection_policy (InformationProtectionPolicy) – Information protection policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

InformationProtectionPolicy, or the result of cls(response)

Return type

InformationProtectionPolicy

Raises

~azure.core.exceptions.HttpResponseError

get(scope: str, information_protection_policy_name: Union[str, ‘_models.Enum15’], **kwargs: Any) → _models.InformationProtectionPolicy[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 or Enum15) – Name of the information protection policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

InformationProtectionPolicy, or the result of cls(response)

Return type

InformationProtectionPolicy

Raises

~azure.core.exceptions.HttpResponseError

list(scope: str, **kwargs: Any) → Iterable[‘_models.InformationProtectionPolicyList’][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).
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either InformationProtectionPolicyList or the result of cls(response)
Return type: ItemPaged[InformationProtectionPolicyList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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.IngestionSettingsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

IngestionSettingsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create(ingestion_setting_name: str, ingestion_setting: ‘_models.IngestionSetting’, **kwargs: Any) → _models.IngestionSetting[source]¶

Create setting for ingesting security data and logs to correlate with resources associated with the subscription.

Parameters

ingestion_setting_name (str) – Name of the ingestion setting.
ingestion_setting (IngestionSetting) – Ingestion setting object.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IngestionSetting, or the result of cls(response)

Return type

IngestionSetting

Raises

~azure.core.exceptions.HttpResponseError

delete(ingestion_setting_name: str, **kwargs: Any) → None [source]¶

Deletes the ingestion settings for this subscription.

Parameters: ingestion_setting_name (str) – Name of the ingestion setting.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

get(ingestion_setting_name: str, **kwargs: Any) → _models.IngestionSetting[source]¶

Settings for ingesting security data and logs to correlate with resources associated with the subscription.

Parameters: ingestion_setting_name (str) – Name of the ingestion setting.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: IngestionSetting, or the result of cls(response)
Return type: IngestionSetting
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.IngestionSettingList’][source]¶

Settings for ingesting security data and logs to correlate with resources associated with the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either IngestionSettingList or the result of cls(response)
Return type: ItemPaged[IngestionSettingList]
Raises: ~azure.core.exceptions.HttpResponseError

list_connection_strings(ingestion_setting_name: str, **kwargs: Any) → _models.ConnectionStrings[source]¶

Connection strings for ingesting security scan logs and data.

Parameters: ingestion_setting_name (str) – Name of the ingestion setting.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: ConnectionStrings, or the result of cls(response)
Return type: ConnectionStrings
Raises: ~azure.core.exceptions.HttpResponseError

list_tokens(ingestion_setting_name: str, **kwargs: Any) → _models.IngestionSettingToken[source]¶

Returns the token that is used for correlating ingested telemetry with the resources in the subscription.

Parameters: ingestion_setting_name (str) – Name of the ingestion setting.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: IngestionSettingToken, or the result of cls(response)
Return type: IngestionSettingToken
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, solution_name: str, **kwargs: Any) → _models.IoTSecuritySolutionAnalyticsModel[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IoTSecuritySolutionAnalyticsModel, or the result of cls(response)

Return type

IoTSecuritySolutionAnalyticsModel

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, solution_name: str, **kwargs: Any) → _models.IoTSecuritySolutionAnalyticsModelList[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IoTSecuritySolutionAnalyticsModelList, or the result of cls(response)

Return type

IoTSecuritySolutionAnalyticsModelList

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, solution_name: str, iot_security_solution_data: ‘_models.IoTSecuritySolutionModel’, **kwargs: Any) → _models.IoTSecuritySolutionModel[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IoTSecuritySolutionModel, or the result of cls(response)

Return type

IoTSecuritySolutionModel

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, solution_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, solution_name: str, **kwargs: Any) → _models.IoTSecuritySolutionModel[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IoTSecuritySolutionModel, or the result of cls(response)

Return type

IoTSecuritySolutionModel

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.IoTSecuritySolutionsList’][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IoTSecuritySolutionsList or the result of cls(response)

Return type

ItemPaged[IoTSecuritySolutionsList]

Raises

~azure.core.exceptions.HttpResponseError

list_by_subscription(filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.IoTSecuritySolutionsList’][source]¶

Use this method to get the list of IoT Security solutions by subscription.

Parameters: filter (str) – Filter the IoT Security solution with OData syntax. Supports filtering by iotHubs.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either IoTSecuritySolutionsList or the result of cls(response)
Return type: ItemPaged[IoTSecuritySolutionsList]
Raises: ~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, solution_name: str, update_iot_security_solution_data: ‘_models.UpdateIotSecuritySolutionData’, **kwargs: Any) → _models.IoTSecuritySolutionModel[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IoTSecuritySolutionModel, or the result of cls(response)

Return type

IoTSecuritySolutionModel

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

dismiss(resource_group_name: str, solution_name: str, aggregated_alert_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, solution_name: str, aggregated_alert_name: str, **kwargs: Any) → _models.IoTSecurityAggregatedAlert[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IoTSecurityAggregatedAlert, or the result of cls(response)

Return type

IoTSecurityAggregatedAlert

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, solution_name: str, top: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.IoTSecurityAggregatedAlertList’][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IoTSecurityAggregatedAlertList or the result of cls(response)

Return type

ItemPaged[IoTSecurityAggregatedAlertList]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, solution_name: str, aggregated_recommendation_name: str, **kwargs: Any) → _models.IoTSecurityAggregatedRecommendation[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IoTSecurityAggregatedRecommendation, or the result of cls(response)

Return type

IoTSecurityAggregatedRecommendation

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, solution_name: str, top: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.IoTSecurityAggregatedRecommendationList’][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IoTSecurityAggregatedRecommendationList or the result of cls(response)

Return type

ItemPaged[IoTSecurityAggregatedRecommendationList]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, jit_network_access_policy_name: str, body: ‘_models.JitNetworkAccessPolicy’, **kwargs: Any) → _models.JitNetworkAccessPolicy[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) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JitNetworkAccessPolicy, or the result of cls(response)

Return type

JitNetworkAccessPolicy

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, jit_network_access_policy_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, jit_network_access_policy_name: str, **kwargs: Any) → _models.JitNetworkAccessPolicy[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JitNetworkAccessPolicy, or the result of cls(response)

Return type

JitNetworkAccessPolicy

Raises

~azure.core.exceptions.HttpResponseError

initiate(resource_group_name: str, jit_network_access_policy_name: str, body: ‘_models.JitNetworkAccessPolicyInitiateRequest’, **kwargs: Any) → _models.JitNetworkAccessRequest[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.
body (JitNetworkAccessPolicyInitiateRequest) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JitNetworkAccessRequest, or the result of cls(response)

Return type

JitNetworkAccessRequest

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.JitNetworkAccessPoliciesList’][source]¶

Policies for protecting resources using Just-in-Time access control.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either JitNetworkAccessPoliciesList or the result of cls(response)
Return type: ItemPaged[JitNetworkAccessPoliciesList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_region(**kwargs: Any) → Iterable[‘_models.JitNetworkAccessPoliciesList’][source]¶

Policies for protecting resources using Just-in-Time access control for the subscription, location.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either JitNetworkAccessPoliciesList or the result of cls(response)
Return type: ItemPaged[JitNetworkAccessPoliciesList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘_models.JitNetworkAccessPoliciesList’][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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either JitNetworkAccessPoliciesList or the result of cls(response)
Return type: ItemPaged[JitNetworkAccessPoliciesList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group_and_region(resource_group_name: str, **kwargs: Any) → Iterable[‘_models.JitNetworkAccessPoliciesList’][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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either JitNetworkAccessPoliciesList or the result of cls(response)
Return type: ItemPaged[JitNetworkAccessPoliciesList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(**kwargs: Any) → _models.AscLocation[source]¶

Details of a specific location.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: AscLocation, or the result of cls(response)
Return type: AscLocation
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.AscLocationList’][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.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AscLocationList or the result of cls(response)
Return type: ItemPaged[AscLocationList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(**kwargs: Any) → Iterable[‘_models.OperationList’][source]¶

Exposes all available operations for discovery purposes.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either OperationList or the result of cls(response)
Return type: ItemPaged[OperationList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(pricing_name: str, **kwargs: Any) → _models.Pricing[source]¶

Gets a provided Security Center pricing configuration in the subscription.

Parameters: pricing_name (str) – name of the pricing configuration.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Pricing, or the result of cls(response)
Return type: Pricing
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → _models.PricingList[source]¶

Lists Security Center pricing configurations in the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: PricingList, or the result of cls(response)
Return type: PricingList
Raises: ~azure.core.exceptions.HttpResponseError

update(pricing_name: str, pricing: ‘_models.Pricing’, **kwargs: Any) → _models.Pricing[source]¶

Updates a provided Security Center pricing configuration in the subscription.

Parameters

pricing_name (str) – name of the pricing configuration.
pricing (Pricing) – Pricing object.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Pricing, or the result of cls(response)

Return type

Pricing

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(regulatory_compliance_standard_name: str, regulatory_compliance_control_name: str, regulatory_compliance_assessment_name: str, **kwargs: Any) → _models.RegulatoryComplianceAssessment[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RegulatoryComplianceAssessment, or the result of cls(response)

Return type

RegulatoryComplianceAssessment

Raises

~azure.core.exceptions.HttpResponseError

list(regulatory_compliance_standard_name: str, regulatory_compliance_control_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.RegulatoryComplianceAssessmentList’][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RegulatoryComplianceAssessmentList or the result of cls(response)

Return type

ItemPaged[RegulatoryComplianceAssessmentList]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(regulatory_compliance_standard_name: str, regulatory_compliance_control_name: str, **kwargs: Any) → _models.RegulatoryComplianceControl[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RegulatoryComplianceControl, or the result of cls(response)

Return type

RegulatoryComplianceControl

Raises

~azure.core.exceptions.HttpResponseError

list(regulatory_compliance_standard_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.RegulatoryComplianceControlList’][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RegulatoryComplianceControlList or the result of cls(response)

Return type

ItemPaged[RegulatoryComplianceControlList]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(regulatory_compliance_standard_name: str, **kwargs: Any) → _models.RegulatoryComplianceStandard[source]¶

Supported regulatory compliance details state for selected standard.

Parameters: regulatory_compliance_standard_name (str) – Name of the regulatory compliance standard object.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: RegulatoryComplianceStandard, or the result of cls(response)
Return type: RegulatoryComplianceStandard
Raises: ~azure.core.exceptions.HttpResponseError

list(filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.RegulatoryComplianceStandardList’][source]¶

Supported regulatory compliance standards details and state.

Parameters: filter (str) – OData filter. Optional.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either RegulatoryComplianceStandardList or the result of cls(response)
Return type: ItemPaged[RegulatoryComplianceStandardList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(**kwargs: Any) → Iterable[‘_models.SecureScoreControlDefinitionList’][source]¶

List the available security controls, their assessments, and the max score.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecureScoreControlDefinitionList or the result of cls(response)
Return type: ItemPaged[SecureScoreControlDefinitionList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_subscription(**kwargs: Any) → Iterable[‘_models.SecureScoreControlDefinitionList’][source]¶

For a specified subscription, list the available security controls, their assessments, and the max score.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecureScoreControlDefinitionList or the result of cls(response)
Return type: ItemPaged[SecureScoreControlDefinitionList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(expand: Optional[Union[str, ‘_models.ExpandControlsEnum’]] = None, **kwargs: Any) → Iterable[‘_models.SecureScoreControlList’][source]¶

Get all security controls within a scope.

Parameters: expand (str or ExpandControlsEnum) – OData expand. Optional.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecureScoreControlList or the result of cls(response)
Return type: ItemPaged[SecureScoreControlList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_secure_score(secure_score_name: str, expand: Optional[Union[str, ‘_models.ExpandControlsEnum’]] = None, **kwargs: Any) → Iterable[‘_models.SecureScoreControlList’][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SecureScoreControlList or the result of cls(response)

Return type

ItemPaged[SecureScoreControlList]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(secure_score_name: str, **kwargs: Any) → _models.SecureScoreItem[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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: SecureScoreItem, or the result of cls(response)
Return type: SecureScoreItem
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.SecureScoresList’][source]¶

List secure scores for all your Security Center initiatives within your current scope.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecureScoresList or the result of cls(response)
Return type: ItemPaged[SecureScoresList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create(security_contact_name: str, security_contact: ‘_models.SecurityContact’, **kwargs: Any) → _models.SecurityContact[source]¶

Security contact configurations for the subscription.

Parameters

security_contact_name (str) – Name of the security contact object.
security_contact (SecurityContact) – Security contact object.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecurityContact, or the result of cls(response)

Return type

SecurityContact

Raises

~azure.core.exceptions.HttpResponseError

delete(security_contact_name: str, **kwargs: Any) → None [source]¶

Security contact configurations for the subscription.

Parameters: security_contact_name (str) – Name of the security contact object.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

get(security_contact_name: str, **kwargs: Any) → _models.SecurityContact[source]¶

Security contact configurations for the subscription.

Parameters: security_contact_name (str) – Name of the security contact object.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: SecurityContact, or the result of cls(response)
Return type: SecurityContact
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.SecurityContactList’][source]¶

Security contact configurations for the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecurityContactList or the result of cls(response)
Return type: ItemPaged[SecurityContactList]
Raises: ~azure.core.exceptions.HttpResponseError

update(security_contact_name: str, security_contact: ‘_models.SecurityContact’, **kwargs: Any) → _models.SecurityContact[source]¶

Security contact configurations for the subscription.

Parameters

security_contact_name (str) – Name of the security contact object.
security_contact (SecurityContact) – Security contact object.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecurityContact, or the result of cls(response)

Return type

SecurityContact

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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.SecuritySolutionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SecuritySolutionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, security_solution_name: str, **kwargs: Any) → _models.SecuritySolution[source]¶

Gets a specific Security Solution.

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
security_solution_name (str) – Name of security solution.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecuritySolution, or the result of cls(response)

Return type

SecuritySolution

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.SecuritySolutionList’][source]¶

Gets a list of Security Solutions for the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecuritySolutionList or the result of cls(response)
Return type: ItemPaged[SecuritySolutionList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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.SecuritySolutionsReferenceDataOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SecuritySolutionsReferenceDataOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(**kwargs: Any) → _models.SecuritySolutionsReferenceDataList[source]¶

Gets a list of all supported Security Solutions for the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: SecuritySolutionsReferenceDataList, or the result of cls(response)
Return type: SecuritySolutionsReferenceDataList
Raises: ~azure.core.exceptions.HttpResponseError

list_by_home_region(**kwargs: Any) → _models.SecuritySolutionsReferenceDataList[source]¶

Gets list of all supported Security Solutions for subscription and location.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: SecuritySolutionsReferenceDataList, or the result of cls(response)
Return type: SecuritySolutionsReferenceDataList
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_delete(resource_group_name: str, resource_namespace: str, resource_type: str, resource_name: str, **kwargs: Any) → LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

create_or_update(resource_group_name: str, resource_namespace: str, resource_type: str, resource_name: str, **kwargs: Any) → _models.ServerVulnerabilityAssessment[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerVulnerabilityAssessment, or the result of cls(response)

Return type

ServerVulnerabilityAssessment

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, resource_namespace: str, resource_type: str, resource_name: str, **kwargs: Any) → _models.ServerVulnerabilityAssessment[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerVulnerabilityAssessment, or the result of cls(response)

Return type

ServerVulnerabilityAssessment

Raises

~azure.core.exceptions.HttpResponseError

list_by_extended_resource(resource_group_name: str, resource_namespace: str, resource_type: str, resource_name: str, **kwargs: Any) → _models.ServerVulnerabilityAssessmentsList[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerVulnerabilityAssessmentsList, or the result of cls(response)

Return type

ServerVulnerabilityAssessmentsList

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(setting_name: Union[str, ‘_models.Enum69’], **kwargs: Any) → _models.Setting[source]¶

Settings of different configurations in security center.

Parameters: setting_name (str or Enum69) – The name of the setting.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Setting, or the result of cls(response)
Return type: Setting
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.SettingsList’][source]¶

Settings about different configurations in security center.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SettingsList or the result of cls(response)
Return type: ItemPaged[SettingsList]
Raises: ~azure.core.exceptions.HttpResponseError

update(setting_name: Union[str, ‘_models.Enum69’], setting: ‘_models.Setting’, **kwargs: Any) → _models.Setting[source]¶

updating settings about different configurations in security center.

Parameters

setting_name (str or Enum69) – The name of the setting.
setting (Setting) – Setting object.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Setting, or the result of cls(response)

Return type

Setting

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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.SoftwareInventoriesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SoftwareInventoriesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, resource_namespace: str, resource_type: str, resource_name: str, software_name: str, **kwargs: Any) → _models.Software[source]¶

Gets a single software data of the virtual machine.

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.
software_name (str) – Name of the installed software.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Software, or the result of cls(response)

Return type

Software

Raises

~azure.core.exceptions.HttpResponseError

list_by_extended_resource(resource_group_name: str, resource_namespace: str, resource_type: str, resource_name: str, **kwargs: Any) → Iterable[‘_models.SoftwaresList’][source]¶

Gets the software inventory of the virtual machine.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SoftwaresList or the result of cls(response)

Return type

ItemPaged[SoftwaresList]

Raises

~azure.core.exceptions.HttpResponseError

list_by_subscription(**kwargs: Any) → Iterable[‘_models.SoftwaresList’][source]¶

Gets the software inventory of all virtual machines in the subscriptions.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SoftwaresList or the result of cls(response)
Return type: ItemPaged[SoftwaresList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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.SqlVulnerabilityAssessmentBaselineRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SqlVulnerabilityAssessmentBaselineRulesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

add(workspace_id: str, resource_id: str, body: Optional[‘_models.RulesResultsInput’] = None, **kwargs: Any) → _models.RulesResults[source]¶

Add a list of baseline rules. Will overwrite any previously existing results (for all rules).

Parameters

workspace_id (str) – The workspace Id.
resource_id (str) – The identifier of the resource.
body (RulesResultsInput) – The baseline rules.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RulesResults, or the result of cls(response)

Return type

RulesResults

Raises

~azure.core.exceptions.HttpResponseError

create_or_update(rule_id: str, workspace_id: str, resource_id: str, body: Optional[‘_models.RuleResultsInput’] = None, **kwargs: Any) → _models.RuleResults[source]¶

Creates a Baseline for a rule in a database. Will overwrite any previously existing results.

Parameters

rule_id (str) – The rule Id.
workspace_id (str) – The workspace Id.
resource_id (str) – The identifier of the resource.
body (RuleResultsInput) – The baseline results for this rule.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RuleResults, or the result of cls(response)

Return type

RuleResults

Raises

~azure.core.exceptions.HttpResponseError

delete(rule_id: str, workspace_id: str, resource_id: str, **kwargs: Any) → None [source]¶

Deletes a rule from the Baseline of a given database.

Parameters

rule_id (str) – The rule Id.
workspace_id (str) – The workspace Id.
resource_id (str) – The identifier of the resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(rule_id: str, workspace_id: str, resource_id: str, **kwargs: Any) → _models.RuleResults[source]¶

Gets the results for a given rule in the Baseline.

Parameters

rule_id (str) – The rule Id.
workspace_id (str) – The workspace Id.
resource_id (str) – The identifier of the resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RuleResults, or the result of cls(response)

Return type

RuleResults

Raises

~azure.core.exceptions.HttpResponseError

list(workspace_id: str, resource_id: str, **kwargs: Any) → _models.RulesResults[source]¶

Gets the results for all rules in the Baseline.

Parameters

workspace_id (str) – The workspace Id.
resource_id (str) – The identifier of the resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RulesResults, or the result of cls(response)

Return type

RulesResults

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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.SqlVulnerabilityAssessmentScanResultsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SqlVulnerabilityAssessmentScanResultsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(scan_id: str, scan_result_id: str, workspace_id: str, resource_id: str, **kwargs: Any) → _models.ScanResult[source]¶

Gets the scan results of a single rule in a scan record.

Parameters

scan_id (str) – The scan Id. Type ‘latest’ to get the scan results for the latest scan.
scan_result_id (str) – The rule Id of the results.
workspace_id (str) – The workspace Id.
resource_id (str) – The identifier of the resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ScanResult, or the result of cls(response)

Return type

ScanResult

Raises

~azure.core.exceptions.HttpResponseError

list(scan_id: str, workspace_id: str, resource_id: str, **kwargs: Any) → _models.ScanResults[source]¶

Gets a list of scan results for a single scan record.

Parameters

scan_id (str) – The scan Id. Type ‘latest’ to get the scan results for the latest scan.
workspace_id (str) – The workspace Id.
resource_id (str) – The identifier of the resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ScanResults, or the result of cls(response)

Return type

ScanResults

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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.SqlVulnerabilityAssessmentScansOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SqlVulnerabilityAssessmentScansOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(scan_id: str, workspace_id: str, resource_id: str, **kwargs: Any) → _models.Scan[source]¶

Gets the scan details of a single scan record.

Parameters

scan_id (str) – The scan Id. Type ‘latest’ to get the scan record for the latest scan.
workspace_id (str) – The workspace Id.
resource_id (str) – The identifier of the resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Scan, or the result of cls(response)

Return type

Scan

Raises

~azure.core.exceptions.HttpResponseError

list(workspace_id: str, resource_id: str, **kwargs: Any) → _models.Scans[source]¶

Gets a list of scan records.

Parameters

workspace_id (str) – The workspace Id.
resource_id (str) – The identifier of the resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Scans, or the result of cls(response)

Return type

Scans

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(scope: str, assessment_name: str, sub_assessment_name: str, **kwargs: Any) → _models.SecuritySubAssessment[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecuritySubAssessment, or the result of cls(response)

Return type

SecuritySubAssessment

Raises

~azure.core.exceptions.HttpResponseError

list(scope: str, assessment_name: str, **kwargs: Any) → Iterable[‘_models.SecuritySubAssessmentList’][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SecuritySubAssessmentList or the result of cls(response)

Return type

ItemPaged[SecuritySubAssessmentList]

Raises

~azure.core.exceptions.HttpResponseError

list_all(scope: str, **kwargs: Any) → Iterable[‘_models.SecuritySubAssessmentList’][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).
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecuritySubAssessmentList or the result of cls(response)
Return type: ItemPaged[SecuritySubAssessmentList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get_resource_group_level_task(resource_group_name: str, task_name: str, **kwargs: Any) → _models.SecurityTask[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecurityTask, or the result of cls(response)

Return type

SecurityTask

Raises

~azure.core.exceptions.HttpResponseError

get_subscription_level_task(task_name: str, **kwargs: Any) → _models.SecurityTask[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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: SecurityTask, or the result of cls(response)
Return type: SecurityTask
Raises: ~azure.core.exceptions.HttpResponseError

list(filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.SecurityTaskList’][source]¶

Recommended tasks that will help improve the security of the subscription proactively.

Parameters: filter (str) – OData filter. Optional.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecurityTaskList or the result of cls(response)
Return type: ItemPaged[SecurityTaskList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_home_region(filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.SecurityTaskList’][source]¶

Recommended tasks that will help improve the security of the subscription proactively.

Parameters: filter (str) – OData filter. Optional.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SecurityTaskList or the result of cls(response)
Return type: ItemPaged[SecurityTaskList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.SecurityTaskList’][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SecurityTaskList or the result of cls(response)

Return type

ItemPaged[SecurityTaskList]

Raises

~azure.core.exceptions.HttpResponseError

update_resource_group_level_task_state(resource_group_name: str, task_name: str, task_update_action_type: Union[str, ‘_models.Enum13’], **kwargs: Any) → None [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 or Enum13) – Type of the action to do on the task.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

update_subscription_level_task_state(task_name: str, task_update_action_type: Union[str, ‘_models.Enum13’], **kwargs: Any) → None [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 or Enum13) – Type of the action to do on the task.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, topology_resource_name: str, **kwargs: Any) → _models.TopologyResource[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TopologyResource, or the result of cls(response)

Return type

TopologyResource

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.TopologyList’][source]¶

Gets a list that allows to build a topology view of a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either TopologyList or the result of cls(response)
Return type: ItemPaged[TopologyList]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_home_region(**kwargs: Any) → Iterable[‘_models.TopologyList’][source]¶

Gets a list that allows to build a topology view of a subscription and location.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either TopologyList or the result of cls(response)
Return type: ItemPaged[TopologyList]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create(workspace_setting_name: str, workspace_setting: ‘_models.WorkspaceSetting’, **kwargs: Any) → _models.WorkspaceSetting[source]¶

creating settings about where we should store your security data and logs.

Parameters

workspace_setting_name (str) – Name of the security setting.
workspace_setting (WorkspaceSetting) – Security data setting object.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

WorkspaceSetting, or the result of cls(response)

Return type

WorkspaceSetting

Raises

~azure.core.exceptions.HttpResponseError

delete(workspace_setting_name: str, **kwargs: Any) → None [source]¶

Deletes the custom workspace settings for this subscription. new VMs will report to the default workspace.

Parameters: workspace_setting_name (str) – Name of the security setting.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: None, or the result of cls(response)
Return type: None
Raises: ~azure.core.exceptions.HttpResponseError

get(workspace_setting_name: str, **kwargs: Any) → _models.WorkspaceSetting[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: workspace_setting_name (str) – Name of the security setting.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: WorkspaceSetting, or the result of cls(response)
Return type: WorkspaceSetting
Raises: ~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.WorkspaceSettingList’][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.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either WorkspaceSettingList or the result of cls(response)
Return type: ItemPaged[WorkspaceSettingList]
Raises: ~azure.core.exceptions.HttpResponseError

update(workspace_setting_name: str, workspace_setting: ‘_models.WorkspaceSetting’, **kwargs: Any) → _models.WorkspaceSetting[source]¶

Settings about where we should store your security data and logs.

Parameters

workspace_setting_name (str) – Name of the security setting.
workspace_setting (WorkspaceSetting) – Security data setting object.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

WorkspaceSetting, or the result of cls(response)

Return type

WorkspaceSetting

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.security.models' from '/mnt/vss/_work/1/s/sdk/security/azure-mgmt-security/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/security/models/__init__.py'>¶